.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Cookie 3"
.TH Cookie 3 "2001-11-30" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
AxKit::XSP::Cookie \- An XSP library for setting and getting HTTP cookies.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Add the taglib to AxKit (via httpd.conf or .htaccess):
.PP
.Vb 1
\&    AxAddXSPTaglib AxKit::XSP::Cookie
.Ve
.PP
Add the cookie: namespace to your \s-1XSP\s0 \f(CW\*(C`<xsp:page\*(C'\fR> tag:
.PP
.Vb 5
\&    <xsp:page
\&         language="Perl"
\&         xmlns:xsp="http://apache.org/xsp/core/v1"
\&         xmlns:cookie="http://axkit.org/NS/xsp/cookie/v1"
\&    >
.Ve
.PP
Then, put the taglib to work:
.PP
Set a cookie:
.PP
.Vb 1
\&    <cookie:create name="newCookie" value="somevalue" />
.Ve
.PP
Get the value for a previous cookie:
.PP
.Vb 1
\&    <cookie:fetch name="oldCookie" />
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \s-1XSP\s0 cookie: tag library implements a simple way to set/get \s-1HTTP\s0 cookies.
.SH "TAG REFERENCE"
.IX Header "TAG REFERENCE"
In order to provide maximum flexibility for \s-1XSP\s0 developers, the cookie: taglib allows all of its arguments to be passed either
as attributes of the two 'wrapper' elements (\f(CW\*(C`<cookie:create\*(C'\fR> and \f(CW\*(C`<cookie:fetch\*(C'\fR>), or as child elements of the same.
.PP
In practice, the choice between passing arguments as attributes vs. passing them as child elements boils down to whether or
not the value being passed is being set dynamically or not. If the arguments are hard\-coded, you can safely pass the values 
as either an attribute or a child element. If, however, you need to pass a value that is not defined until run\-time, you
\&\fBmust\fR use a child element since \s-1XSP\s0 does not allow the value of taglib attributes to be set dynamically. See the \s-1EXAMPLES\s0
below for clarification.
.ie n .Sh """<cookie:create"">"
.el .Sh "\f(CW<cookie:create\fP>"
.IX Subsection "<cookie:create>"
This tag is used to create a new \s-1HTTP\s0 cookie, or to update an existing one. As one of the cookie: lib's 'wrapper' elements
this tag allows the following attributes or child elements:
.IP "* name" 4
.IX Item "name"
.PD 0
.IP "* value" 4
.IX Item "value"
.IP "* expires" 4
.IX Item "expires"
.IP "* path" 4
.IX Item "path"
.IP "* domain" 4
.IX Item "domain"
.IP "* secure" 4
.IX Item "secure"
.PD
.PP
Please see the descriptions below for the allowed values for each of these arguments.
.ie n .Sh """<cookie:fetch"">"
.el .Sh "\f(CW<cookie:fetch\fP>"
.IX Subsection "<cookie:fetch>"
The other, simpler of the two 'wrapper' elements this tag allows \fBonly\fR the \fBname\fR attribute/child. The tag is used to
retrieve the value of a prevously set cookie whose name matches the \fBname\fR argument.
.ie n .Sh """<cookie:name"">"
.el .Sh "\f(CW<cookie:name\fP>"
.IX Subsection "<cookie:name>"
When used as the child of a \f(CW\*(C`<cookie:create\*(C'\fR> element this tag \fBsets\fR the cookie's name. When it used as the child of a
\&\f(CW\*(C`<cookie:fetch\*(C'\fR> element it is used to define the name of the cookie to retrieve.
.ie n .Sh """<cookie:value"">"
.el .Sh "\f(CW<cookie:value\fP>"
.IX Subsection "<cookie:value>"
Allowed only as the child of a \f(CW\*(C`<cookie:create\*(C'\fR> element, this tag defines the value for the cookie.
.ie n .Sh """<cookie:path"">"
.el .Sh "\f(CW<cookie:path\fP>"
.IX Subsection "<cookie:path>"
Allowed only as the child of a \f(CW\*(C`<cookie:create\*(C'\fR> element, this tag defines the 'path' field for the cookie.
.ie n .Sh """<cookie:expires"">"
.el .Sh "\f(CW<cookie:expires\fP>"
.IX Subsection "<cookie:expires>"
Allowed only as the child of a \f(CW\*(C`<cookie:create\*(C'\fR> element, this tag sets the cookie's expiry date. It accepts the same types
values that Apache::Cookie does.
.ie n .Sh """<cookie:domain"">"
.el .Sh "\f(CW<cookie:domain\fP>"
.IX Subsection "<cookie:domain>"
Allowed only as the child of a \f(CW\*(C`<cookie:create\*(C'\fR> element, this tag defines the 'domain' field for the cookie.
.ie n .Sh """<cookie:secure"">"
.el .Sh "\f(CW<cookie:secure\fP>"
.IX Subsection "<cookie:secure>"
Accepting only the values of O or 1, this tag sets or unsets the cookie's 'secure' flag. It is allowed only as the child 
of a \f(CW\*(C`<cookie:create\*(C'\fR> element.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Fetch the value for a previous cookie whose \fBname\fR argument is hard-coded into the script:
.PP
.Vb 1
\&    <cookie:fetch name="chocolateChip"/>
.Ve
.PP
Fetch the value for a previous cookie whose \fBname\fR is determined at run\-time:
.PP
.Vb 3
\&    <cookie:fetch>
\&      <cookie:name><xsp:expr>$perl_var_containing_cookiename</xsp:expr></cookie:name>
\&    </cookie:fetch>
.Ve
.PP
Set a cookie using only hard-coded arguments:
.PP
.Vb 5
\&    <cookie:create
\&            name="oatmealRaisin"
\&            value="tasty"
\&            expires="+3M"
\&    >
.Ve
.PP
Set a cookie using a mix of dynamic child elements and static attributes:
.PP
.Vb 9
\&    <cookie:create
\&            name="peanutButter"
\&            domain=".mydomain.tld"
\&            secure="1"
\&    >
\&      <cookie:value><xsp:expr>$cookie_value</xsp:expr></cookie:value>
\&      <cookie:expires><xsp:expr>$cookie_expiry</xsp:expr></cookie:expires>
\&      <cookie:path><xsp:expr>$cookie_path</xsp:expr></cookie:path>
\&    </cookie:create>
.Ve
.PP
As stated above, you can pass static arguments either as attributes or child elements of the enclosing tag. Thus:
.PP
.Vb 2
\&    <cookie:create name="pistachioChocolateChunk"/>
\&      ...
.Ve
.PP
and
.PP
.Vb 3
\&    <cookie:create>
\&      <cookie:name>pistachioChocolateChunk</cookie:name>
\&      ...
.Ve
.PP
are functionally equivalent.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kip Hampton, khampton@totalcinema.com
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001 Kip Hampton. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
AxKit, Apache::Cookie, CGI::Cookie