.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "CGI::Parse::PSGI 3pm"
.TH CGI::Parse::PSGI 3pm "2017-11-04" "perl v5.26.1" "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"
CGI::Parse::PSGI \- Parses CGI output and creates PSGI response out of it
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 1
\&  use CGI::Parse::PSGI qw(parse_cgi_output);
\&
\&  my $output = YourApp\->run;
\&  my $psgi_res = parse_cgi_output(\e$output);
.Ve
.PP
An option hash can also be passed:
.PP
.Vb 1
\&  my $psgi_res = parse_cgi_output(\e$output, \e%options);
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
CGI::Parse::PSGI exports one function \f(CW\*(C`parse_cgi_output\*(C'\fR that takes a
filehandle or a reference to a string to read a \s-1CGI\s0 script output, and
creates a \s-1PSGI\s0 response (an array reference containing status code,
headers and a body) by reading the output.
.PP
Use CGI::Emulate::PSGI if you have a \s-1CGI\s0 \fIcode\fR not the \fIoutput\fR,
which takes care of automatically parsing the output, using this
module, from your callback code.
.SH "OPTIONS"
.IX Header "OPTIONS"
As mentioned above, \f(CW\*(C`parse_cgi_output\*(C'\fR can accept an options hash as
the second argument.
.PP
Currently the options available are:
.ie n .IP """ignore_status_line""" 4
.el .IP "\f(CWignore_status_line\fR" 4
.IX Item "ignore_status_line"
A boolean value, defaulting to 0 (false). If true, the status in the
\&\s-1HTTP\s0 protocol line is not used to set the default status in absence of
a status header.
.PP
The options can be supplied to earlier versions, and will be ignored
without error.  Hence you can preserve legacy behaviour like this:
.PP
.Vb 1
\&    parse_cgi_output(\e$output, {ignore_status_line => 1});
.Ve
.PP
This will ensure that if the script output includes an edge case
like this:
.PP
.Vb 2
\&    HTTP/1.1 666 SNAFU
\&    Content\-Type: text/plain
\&
\&    This should be OK!
.Ve
.PP
then the old behaviour of ignoring the status line and returning 200
is preserved.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tatsuhiko Miyagawa
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CGI::Emulate::PSGI