1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "AppConfig::CGI 3"
132 .TH AppConfig::CGI 3 "2007-05-30" "perl v5.8.7" "User Contributed Perl Documentation"
134 AppConfig::CGI \- Perl5 module for processing CGI script parameters.
136 .IX Header "SYNOPSIS"
138 \& use AppConfig::CGI;
142 \& my $state = AppConfig::State\->new(\e%cfg);
143 \& my $cgi = AppConfig::CGI\->new($state);
147 \& $cgi\->parse($cgi_query);
148 \& $cgi\->parse(); # looks for CGI query in environment
151 .IX Header "OVERVIEW"
152 AppConfig::CGI is a Perl5 module which implements a \s-1CGI\s0 interface to
153 AppConfig. It examines the \s-1QUERY_STRING\s0 environment variable, or a string
154 passed explicitly by parameter, which represents the additional parameters
155 passed to a \s-1CGI\s0 query. This is then used to update variable values in an
156 AppConfig::State object accordingly.
158 AppConfig::CGI is distributed as part of the AppConfig bundle.
160 .IX Header "DESCRIPTION"
161 .Sh "\s-1USING\s0 \s-1THE\s0 AppConfig::CGI \s-1MODULE\s0"
162 .IX Subsection "USING THE AppConfig::CGI MODULE"
163 To import and use the AppConfig::CGI module the following line should appear
167 \& use AppConfig::CGI;
170 AppConfig::CGI is used automatically if you use the AppConfig module
171 and create an AppConfig::CGI object through the \fIcgi()\fR method.
172 AppConfig::CGI is implemented using object-oriented methods. A new
173 AppConfig::CGI object is created and initialised using the \fInew()\fR
174 method. This returns a reference to a new AppConfig::CGI object. A
175 reference to an AppConfig::State object should be passed in as the
179 \& my $state = AppConfig::State\->new();
180 \& my $cgi = AppConfig::CGI\->new($state);
183 This will create and return a reference to a new AppConfig::CGI object.
184 .Sh "\s-1PARSING\s0 \s-1CGI\s0 \s-1QUERIES\s0"
185 .IX Subsection "PARSING CGI QUERIES"
186 The \f(CW\*(C`parse()\*(C'\fR method is used to parse a \s-1CGI\s0 query which can be specified
187 explicitly, or is automatically extracted from the \*(L"\s-1QUERY_STRING\s0\*(R" \s-1CGI\s0
188 environment variable. This currently limits the module to only supporting
189 the \s-1GET\s0 method.
191 See AppConfig for information about using the AppConfig::CGI
192 module via the \fIcgi()\fR method.
195 Andy Wardley, \f(CW\*(C`<abw@wardley.org<gt\*(C'\fR>
197 .IX Header "COPYRIGHT"
198 Copyright (C) 1997\-2007 Andy Wardley. All Rights Reserved.
200 Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.
202 This module is free software; you can redistribute it and/or modify it
203 under the same terms as Perl itself.
205 .IX Header "SEE ALSO"
206 AppConfig, AppConfig::State