.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.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 "XML 3pm"
.TH XML 3pm "2022-06-10" "perl v5.34.0" "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::XML \- Perl extension for converting CGI.pm variables to/from XML
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use CGI::XML;
\&  $q = new CGI::XML;
\&
\&  # convert CGI.pm variables to XML
\&  $xml = $q\->toXML;
\&  $xml = $q\->toXML($root);
\&  
\&  # convert XML to CGI.pm variables
\&  $q\->toCGI($xml);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \s-1CGI::XML\s0 module converts \s-1CGI\s0.pm variables
to \s-1XML\s0 and vice versa.
.PP
\&\fB\s-1CGI::XML\s0\fR is a subclass of \fB\s-1CGI\s0.pm\fR, so it reads the \s-1CGI\s0
variables just as \s-1CGI\s0.pm would.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$q = new \s-1CGI::XML\s0" 4
.el .IP "\f(CW$q\fR = new \s-1CGI::XML\s0" 4
.IX Item "$q = new CGI::XML"
creates a new instance of \s-1CGI::XML.\s0 You also have access
to all of the methods in \s-1CGI\s0.pm.
.ie n .IP "$q\->toXML([$root])" 4
.el .IP "\f(CW$q\fR\->toXML([$root])" 4
.IX Item "$q->toXML([$root])"
where \fB\f(CB$root\fB\fR is an optional parameter that specifies
the root element. By default, \fBtoXML\fR will not return a root
element.
.ie n .IP "$q\->toCGI($xml)" 4
.el .IP "\f(CW$q\fR\->toCGI($xml)" 4
.IX Item "$q->toCGI($xml)"
where \fB\f(CB$xml\fB\fR is the \s-1XML\s0 you would like to convert
to \s-1CGI\s0.pm parameters. Values in the \s-1XML\s0 will overwrite any
existing values if they exist.
.SH "NOTE"
.IX Header "NOTE"
\&\fB\s-1CGI::XML\s0\fR does not currently handle multiple selections
passed from \s-1HTML\s0 forms. This will be added in a future release.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Eisenzopf <eisen@pobox.com>
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
David Black <dblack@candle.superlink.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), \fBXML::Parser\fR\|(3).