.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HTTP::Request::AsCGI 3pm"
.TH HTTP::Request::AsCGI 3pm "2010-01-12" "perl v5.10.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"
HTTP::Request::AsCGI \- Set up a CGI environment from an HTTP::Request
.SH "VERSION"
.IX Header "VERSION"
version 1.2
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use CGI;
\&    use HTTP::Request;
\&    use HTTP::Request::AsCGI;
\&
\&    my $request = HTTP::Request\->new( GET => \*(Aqhttp://www.host.com/\*(Aq );
\&    my $stdout;
\&
\&    {
\&        my $c = HTTP::Request::AsCGI\->new($request)\->setup;
\&        my $q = CGI\->new;
\&
\&        print $q\->header,
\&              $q\->start_html(\*(AqHello World\*(Aq),
\&              $q\->h1(\*(AqHello World\*(Aq),
\&              $q\->end_html;
\&
\&        $stdout = $c\->stdout;
\&
\&        # environment and descriptors will automatically be restored
\&        # when $c is destructed.
\&    }
\&
\&    while ( my $line = $stdout\->getline ) {
\&        print $line;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides a convenient way of setting up an \s-1CGI\s0 environment from an HTTP::Request.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "new ( $request [, key => value ] )" 4
.el .IP "new ( \f(CW$request\fR [, key => value ] )" 4
.IX Item "new ( $request [, key => value ] )"
Constructor.  The first argument must be a instance of HTTP::Request, followed
by optional pairs of environment key and value.
.IP "environment" 4
.IX Item "environment"
Returns a hashref containing the environment that will be used in setup.
Changing the hashref after setup has been called will have no effect.
.IP "setup" 4
.IX Item "setup"
Sets up the environment and descriptors.
.IP "restore" 4
.IX Item "restore"
Restores the environment and descriptors. Can only be called after setup.
.IP "request" 4
.IX Item "request"
Returns the request given to constructor.
.IP "response" 4
.IX Item "response"
Returns a HTTP::Response. Can only be called after restore.
.IP "stdin" 4
.IX Item "stdin"
Accessor for handle that will be used for \s-1STDIN\s0, must be a real seekable
handle with an file descriptor. Defaults to a tempoary IO::File instance.
.IP "stdout" 4
.IX Item "stdout"
Accessor for handle that will be used for \s-1STDOUT\s0, must be a real seekable
handle with an file descriptor. Defaults to a tempoary IO::File instance.
.IP "stderr" 4
.IX Item "stderr"
Accessor for handle that will be used for \s-1STDERR\s0, must be a real seekable
handle with an file descriptor.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "examples directory in this distribution." 4
.IX Item "examples directory in this distribution."
.PD 0
.IP "WWW::Mechanize::CGI" 4
.IX Item "WWW::Mechanize::CGI"
.IP "Test::WWW::Mechanize::CGI" 4
.IX Item "Test::WWW::Mechanize::CGI"
.PD
.SH "THANKS TO"
.IX Header "THANKS TO"
Thomas L. Shinnick for his valuable win32 testing.
.SH "AUTHORS"
.IX Header "AUTHORS"
Christian Hansen <ch@ngmedia.com>
Hans Dieter Pearcey <hdp@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by Christian Hansen <ch@ngmedia.com>.
.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.