AnonymousFox

//usr/local/share/man/man3/Date::Parse.3pm

.\" 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 "Date::Parse 3"
.TH Date::Parse 3 "2026-03-21" "perl v5.32.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"
Date::Parse \- Parse date strings into time values
.SH "VERSION"
.IX Header "VERSION"
version 2.35
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Date::Parse;
\&
\&    my $date = "Wed, 16 Jun 94 07:29:35 CST";
\&    my $time = str2time($date);
\&
\&    my ($ss,$mm,$hh,$day,$month,$year,$zone) = strptime($date);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Date::Parse\*(C'\fR provides two routines for parsing date strings into time values.
.IP "str2time(\s-1DATE\s0 [, \s-1ZONE\s0 [, \s-1EPOCH\s0]])" 4
.IX Item "str2time(DATE [, ZONE [, EPOCH]])"
\&\f(CW\*(C`str2time\*(C'\fR parses \f(CW\*(C`DATE\*(C'\fR and returns a unix time value, or undef upon failure.
\&\f(CW\*(C`ZONE\*(C'\fR, if given, specifies the timezone to assume when parsing if the
date string does not specify a timezone.
\&\f(CW\*(C`EPOCH\*(C'\fR, if given, is a unix epoch value used as the reference time when
filling in missing date components (month, day, or year).  Defaults to
\&\f(CW\*(C`time()\*(C'\fR.  Useful when the current system clock cannot be trusted or when
parsing dates relative to a known reference point.
.IP "strptime(\s-1DATE\s0 [, \s-1ZONE\s0])" 4
.IX Item "strptime(DATE [, ZONE])"
\&\f(CW\*(C`strptime\*(C'\fR takes the same arguments as str2time but returns an array of
values \f(CW\*(C`($ss,$mm,$hh,$day,$month,$year,$zone,$century)\*(C'\fR. Elements are only
defined if they could be extracted from the date string. An empty array is
returned upon failure.
.Sp
The return values follow the same conventions as Perl's built-in \f(CW\*(C`localtime\*(C'\fR
and \f(CW\*(C`gmtime\*(C'\fR functions:
.RS 4
.ie n .IP "$month" 4
.el .IP "\f(CW$month\fR" 4
.IX Item "$month"
0\-indexed: 0 = January, 1 = February, ..., 11 = December.
.ie n .IP "$year" 4
.el .IP "\f(CW$year\fR" 4
.IX Item "$year"
Years since 1900. For example, the year 2015 is returned as \f(CW115\fR, and 1995
is returned as \f(CW95\fR. To recover the full 4\-digit year: \f(CW\*(C`$year + 1900\*(C'\fR.
.ie n .IP "$zone" 4
.el .IP "\f(CW$zone\fR" 4
.IX Item "$zone"
Timezone offset in seconds from \s-1UTC,\s0 or \f(CW\*(C`undef\*(C'\fR if no timezone was specified
in the input string.
.ie n .IP "$century" 4
.el .IP "\f(CW$century\fR" 4
.IX Item "$century"
Defined only when a 4\-digit year was present in the input. Its value is
\&\f(CW\*(C`int($full_year / 100)\*(C'\fR (e.g. \f(CW20\fR for the year 2015). When \f(CW$century\fR is
defined, \f(CW\*(C`$year + 1900\*(C'\fR gives the original 4\-digit year.
.RE
.RS 4
.Sp
For example, \f(CW\*(C`strptime("2015\-01\-24T09:08:17")\*(C'\fR returns:
.Sp
.Vb 6
\&    ($ss, $mm, $hh, $day, $month, $year, $zone, $century)
\&    ( 17,   8,   9,   24,      0,   115,  undef,     20 )
\&    #                          ^\-\-\- January (0\-indexed)
\&    #                               ^\-\-\- 2015 \- 1900
\&    #                                          ^\-\-\- not in input
\&    #                                                 ^\-\-\- int(2015/100)
.Ve
.RE
.SH "NAME"
Date::Parse \- Parse date strings into time values
.SH "MULTI-LANGUAGE SUPPORT"
.IX Header "MULTI-LANGUAGE SUPPORT"
Date::Parse is capable of parsing dates in several languages, these include
English, French, German and Italian.
.PP
.Vb 2
\&    $lang = Date::Language\->new(\*(AqGerman\*(Aq);
\&    $lang\->str2time("25 Jun 1996 21:09:55 +0100");
.Ve
.SH "EXAMPLE DATES"
.IX Header "EXAMPLE DATES"
Below is a sample list of dates that are known to be parsable with Date::Parse
.PP
.Vb 10
\& 1995\-01\-24T09:08:17.1823213           ISO\-8601
\& Wed, 16 Jun 94 07:29:35 CST           Comma and day name are optional
\& Thu, 13 Oct 94 10:13:13 \-0700
\& Wed, 9 Nov 1994 09:50:32 \-0500 (EST)  Text in ()\*(Aqs will be ignored.
\& 21 dec 17:05                          Will be parsed in the current time zone
\& 21\-dec 17:05
\& 21/dec 17:05
\& 21/dec/93 17:05
\& 1999 10:02:18 "GMT"
\& 16 Nov 94 22:28:20 PST
.Ve
.SH "BUGS"
.IX Header "BUGS"
When both the month and the date are specified in the date as numbers
they are always parsed assuming that the month number comes before the
date. This is the usual format used in American dates.
.PP
The reason why it is like this and not dynamic is that it must be
deterministic. Several people have suggested using the current locale,
but this will not work as the date being parsed may not be in the format
of the current locale.
.PP
My plans to address this, which will be in a future release, is to allow
the programmer to state what order they want these values parsed in.
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1995\-2009 Graham Barr. This program is free
software; you can redistribute it and/or modify it under the same terms
as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham <gbarr@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020 by Graham Barr.
.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.