Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / HTTP::Date.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" 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 "HTTP::Date 3"
.TH HTTP::Date 3 "2009-10-03" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
HTTP::Date \- date conversion routines
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use HTTP::Date;
.Ve
.PP
.Vb 2
\& $string = time2str($time);    # Format as GMT ASCII time
\& $time = str2time($string);    # convert ASCII date to machine time
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides functions that deal the date formats used by the
\&\s-1HTTP\s0 protocol (and then some more).  Only the first two functions,
\&\fItime2str()\fR and \fIstr2time()\fR, are exported by default.
.IP "time2str( [$time] )" 4
.IX Item "time2str( [$time] )"
The \fItime2str()\fR function converts a machine time (seconds since epoch)
to a string.  If the function is called without an argument or with an
undefined argument, it will use the current time.
.Sp
The string returned is in the format preferred for the \s-1HTTP\s0 protocol.
This is a fixed length subset of the format defined by \s-1RFC\s0 1123,
represented in Universal Time (\s-1GMT\s0).  An example of a time stamp
in this format is:
.Sp
.Vb 1
\&   Sun, 06 Nov 1994 08:49:37 GMT
.Ve
.ie n .IP "str2time( $str\fR [, \f(CW$zone] )" 4
.el .IP "str2time( \f(CW$str\fR [, \f(CW$zone\fR] )" 4
.IX Item "str2time( $str [, $zone] )"
The \fIstr2time()\fR function converts a string to machine time.  It returns
\&\f(CW\*(C`undef\*(C'\fR if the format of \f(CW$str\fR is unrecognized, otherwise whatever the
\&\f(CW\*(C`Time::Local\*(C'\fR functions can make out of the parsed time.  Dates
before the system's epoch may not work on all operating systems.  The
time formats recognized are the same as for \fIparse_date()\fR.
.Sp
The function also takes an optional second argument that specifies the
default time zone to use when converting the date.  This parameter is
ignored if the zone is found in the date string itself.  If this
parameter is missing, and the date string format does not contain any
zone specification, then the local time zone is assumed.
.Sp
If the zone is not "\f(CW\*(C`GMT\*(C'\fR\*(L" or numerical (like \*(R"\f(CW\*(C`\-0800\*(C'\fR\*(L" or
\&\*(R"\f(CW+0100\fR"), then the \f(CW\*(C`Time::Zone\*(C'\fR module must be installed in order
to get the date recognized.
.ie n .IP "parse_date( $str )" 4
.el .IP "parse_date( \f(CW$str\fR )" 4
.IX Item "parse_date( $str )"
This function will try to parse a date string, and then return it as a
list of numerical values followed by a (possible undefined) time zone
specifier; ($year, \f(CW$month\fR, \f(CW$day\fR, \f(CW$hour\fR, \f(CW$min\fR, \f(CW$sec\fR, \f(CW$tz\fR).  The \f(CW$year\fR
returned will \fBnot\fR have the number 1900 subtracted from it and the
\&\f(CW$month\fR numbers start with 1.
.Sp
In scalar context the numbers are interpolated in a string of the
\&\*(L"\s-1YYYY\-MM\-DD\s0 hh:mm:ss \s-1TZ\s0\*(R"\-format and returned.
.Sp
If the date is unrecognized, then the empty list is returned.
.Sp
The function is able to parse the following formats:
.Sp
.Vb 5
\& "Wed, 09 Feb 1994 22:23:32 GMT"       \-\- HTTP format
\& "Thu Feb  3 17:03:55 GMT 1994"        \-\- ctime(3) format
\& "Thu Feb  3 00:00:00 1994",           \-\- ANSI C asctime() format
\& "Tuesday, 08\-Feb\-94 14:15:29 GMT"     \-\- old rfc850 HTTP format
\& "Tuesday, 08\-Feb\-1994 14:15:29 GMT"   \-\- broken rfc850 HTTP format
.Ve
.Sp
.Vb 4
\& "03/Feb/1994:17:03:55 \-0700"   \-\- common logfile format
\& "09 Feb 1994 22:23:32 GMT"     \-\- HTTP format (no weekday)
\& "08\-Feb\-94 14:15:29 GMT"       \-\- rfc850 format (no weekday)
\& "08\-Feb\-1994 14:15:29 GMT"     \-\- broken rfc850 format (no weekday)
.Ve
.Sp
.Vb 6
\& "1994\-02\-03 14:15:29 \-0100"    \-\- ISO 8601 format
\& "1994\-02\-03 14:15:29"          \-\- zone is optional
\& "1994\-02\-03"                   \-\- only date
\& "1994\-02\-03T14:15:29"          \-\- Use T as separator
\& "19940203T141529Z"             \-\- ISO 8601 compact format
\& "19940203"                     \-\- only date
.Ve
.Sp
.Vb 4
\& "08\-Feb\-94"         \-\- old rfc850 HTTP format    (no weekday, no time)
\& "08\-Feb\-1994"       \-\- broken rfc850 HTTP format (no weekday, no time)
\& "09 Feb 1994"       \-\- proposed new HTTP format  (no weekday, no time)
\& "03/Feb/1994"       \-\- common logfile format     (no time, no offset)
.Ve
.Sp
.Vb 2
\& "Feb  3  1994"      \-\- Unix 'ls \-l' format
\& "Feb  3 17:03"      \-\- Unix 'ls \-l' format
.Ve
.Sp
.Vb 1
\& "11\-15\-96  03:52PM" \-\- Windows 'dir' format
.Ve
.Sp
The parser ignores leading and trailing whitespace.  It also allow the
seconds to be missing and the month to be numerical in most formats.
.Sp
If the year is missing, then we assume that the date is the first
matching date \fIbefore\fR current month.  If the year is given with only
2 digits, then \fIparse_date()\fR will select the century that makes the
year closest to the current date.
.IP "time2iso( [$time] )" 4
.IX Item "time2iso( [$time] )"
Same as \fItime2str()\fR, but returns a \*(L"\s-1YYYY\-MM\-DD\s0 hh:mm:ss\*(R"\-formatted
string representing time in the local time zone.
.IP "time2isoz( [$time] )" 4
.IX Item "time2isoz( [$time] )"
Same as \fItime2str()\fR, but returns a \*(L"\s-1YYYY\-MM\-DD\s0 hh:mm:ssZ\*(R"\-formatted
string representing Universal Time.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\*(L"time\*(R" in perlfunc, Time::Zone
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 1995\-1999, Gisle Aas
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.