.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Web::Detect 3"
.TH Web::Detect 3 "2015-01-03" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Web::Detect \- Detect if program is running under some web environment
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.05 of Web::Detect (from Perl distribution Web-Detect), released on 2015\-01\-03.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Web::Detect qw(detect_web detect_web_fast);
\&    use IO::Interactive::Tiny ();
\&
\&    if (Web::Detect::detect_web_fast()) {
\&        # do HTML
\&    }
\&    else {
\&        # do CLI
\&        if (IO::Interactive::Tiny::is_interactive()) {
\&            # prompt/ANSI/etc
\&        }
\&        else {
\&            # do not prompt/plain text/etc
\&        }
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Knowing if you are under a web environment or not is very handy.
.PP
For example, often you need to decide whether to output \s-1HTML\s0 or plaintext.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
Functions are exportable but are not exported by default.
.SS "\fIdetect_web()\fP => \s-1HASHREF\s0"
.IX Subsection "detect_web() => HASHREF"
Return false if not detected running under any web environment.
.PP
Return a hash otherwise.
.PP
These keys exists if it is detected that we are running under the given
environment and the value is suitable as a boolean (always true).
.ie n .IP """mod_perl""" 4
.el .IP "\f(CWmod_perl\fR" 4
.IX Item "mod_perl"
.PD 0
.ie n .IP """plack""" 4
.el .IP "\f(CWplack\fR" 4
.IX Item "plack"
.ie n .IP """pangea""" 4
.el .IP "\f(CWpangea\fR" 4
.IX Item "pangea"
.ie n .IP """cpanel""" 4
.el .IP "\f(CWcpanel\fR" 4
.IX Item "cpanel"
.PD
<http://cpanel.net>
.ie n .IP """catalyst""" 4
.el .IP "\f(CWcatalyst\fR" 4
.IX Item "catalyst"
.PD 0
.ie n .IP """dancer""" 4
.el .IP "\f(CWdancer\fR" 4
.IX Item "dancer"
.ie n .IP """mojo""" 4
.el .IP "\f(CWmojo\fR" 4
.IX Item "mojo"
.ie n .IP """FCGI.pm""" 4
.el .IP "\f(CWFCGI.pm\fR" 4
.IX Item "FCGI.pm"
.ie n .IP """IIS""" 4
.el .IP "\f(CWIIS\fR" 4
.IX Item "IIS"
.ie n .IP """cgi""" 4
.el .IP "\f(CWcgi\fR" 4
.IX Item "cgi"
.PD
General \s-1CGI\s0
.ie n .IP """general""" 4
.el .IP "\f(CWgeneral\fR" 4
.IX Item "general"
Value can be 1 if it was detected during the first general check, 2 if it was
detected during the second general check, and 3 if it was detected under both.
.PP
Additionally, \f(CW\*(C`psgi\*(C'\fR is also true if we know its a \s-1PSGI\s0 environment.
.SS "\fIdetect_web_fast()\fP"
.IX Subsection "detect_web_fast()"
Same as \fIdetect_web()\fR but return \s-1HASHREF\s0 upon first successful check instead of
trying all heuristics.
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Web\-Detect>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/sharyanto/perl\-Web\-Detect>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Web\-Detect>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.