Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man3 / Time::Local.3

.\" 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 "Time::Local 3"
.TH Time::Local 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
Time::Local \- efficiently compute time from local and GMT time
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    $time = timelocal($sec,$min,$hour,$mday,$mon,$year);
\&    $time = timegm($sec,$min,$hour,$mday,$mon,$year);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These routines are the inverse of built-in perl functions \fIlocaltime()\fR
and \fIgmtime()\fR.  They accept a date as a six-element array, and return
the corresponding \fItime\fR\|(2) value in seconds since the system epoch
(Midnight, January 1, 1970 \s-1GMT\s0 on Unix, for example).  This value can
be positive or negative, though \s-1POSIX\s0 only requires support for
positive values, so dates before the system's epoch may not work on
all operating systems.
.PP
It is worth drawing particular attention to the expected ranges for
the values provided.  The value for the day of the month is the actual day
(ie 1..31), while the month is the number of months since January (0..11).
This is consistent with the values returned from \fIlocaltime()\fR and \fIgmtime()\fR.
.PP
The \fItimelocal()\fR and \fItimegm()\fR functions perform range checking on the
input \f(CW$sec\fR, \f(CW$min\fR, \f(CW$hour\fR, \f(CW$mday\fR, and \f(CW$mon\fR values by default.  If you'd
rather they didn't, you can explicitly import the \fItimelocal_nocheck()\fR
and \fItimegm_nocheck()\fR functions.
.PP
.Vb 1
\&        use Time::Local 'timelocal_nocheck';
.Ve
.PP
.Vb 3
\&        {
\&            # The 365th day of 1999
\&            print scalar localtime timelocal_nocheck 0,0,0,365,0,99;
.Ve
.PP
.Vb 2
\&            # The twenty thousandth day since 1970
\&            print scalar localtime timelocal_nocheck 0,0,0,20000,0,70;
.Ve
.PP
.Vb 3
\&            # And even the 10,000,000th second since 1999!
\&            print scalar localtime timelocal_nocheck 10000000,0,0,1,0,99;
\&        }
.Ve
.PP
Your mileage may vary when trying these with minutes and hours,
and it doesn't work at all for months.
.PP
Strictly speaking, the year should also be specified in a form consistent
with \fIlocaltime()\fR, i.e. the offset from 1900.
In order to make the interpretation of the year easier for humans,
however, who are more accustomed to seeing years as two-digit or four-digit
values, the following conventions are followed:
.IP "\(bu" 4
Years greater than 999 are interpreted as being the actual year,
rather than the offset from 1900.  Thus, 1964 would indicate the year
Martin Luther King won the Nobel prize, not the year 3864.
.IP "\(bu" 4
Years in the range 100..999 are interpreted as offset from 1900, 
so that 112 indicates 2012.  This rule also applies to years less than zero
(but see note below regarding date range).
.IP "\(bu" 4
Years in the range 0..99 are interpreted as shorthand for years in the
rolling \*(L"current century,\*(R" defined as 50 years on either side of the current
year.  Thus, today, in 1999, 0 would refer to 2000, and 45 to 2045,
but 55 would refer to 1955.  Twenty years from now, 55 would instead refer
to 2055.  This is messy, but matches the way people currently think about
two digit dates.  Whenever possible, use an absolute four digit year instead.
.PP
The scheme above allows interpretation of a wide range of dates, particularly
if 4\-digit years are used.  
.PP
Please note, however, that the range of dates that can be actually be handled
depends on the size of an integer (time_t) on a given platform.  
Currently, this is 32 bits for most systems, yielding an approximate range 
from Dec 1901 to Jan 2038.
.PP
Both \fItimelocal()\fR and \fItimegm()\fR croak if given dates outside the supported
range.
.Sh "Ambiguous Local Times (\s-1DST\s0)"
.IX Subsection "Ambiguous Local Times (DST)"
Because of \s-1DST\s0 changes, there are many time zones where the same local
time occurs for two different \s-1GMT\s0 times on the same day.  For example,
in the \*(L"Europe/Paris\*(R" time zone, the local time of 2001\-10\-28 02:30:00
can represent either 2001\-10\-28 00:30:00 \s-1GMT\s0, \fBor\fR 2001\-10\-28
01:30:00 \s-1GMT\s0.
.PP
When given an ambiguous local time, the \fItimelocal()\fR function should
always return the epoch for the \fIearlier\fR of the two possible \s-1GMT\s0
times.
.Sh "Non-Existent Local Times (\s-1DST\s0)"
.IX Subsection "Non-Existent Local Times (DST)"
When a \s-1DST\s0 change causes a locale clock to skip one hour forward,
there will be an hour's worth of local times that don't exist.  Again,
for the \*(L"Europe/Paris\*(R" time zone, the local clock jumped from
2001\-03\-25 01:59:59 to 2001\-03\-25 03:00:00.
.PP
If the \fItimelocal()\fR function is given a non-existent local time, it
will simply return an epoch value for the time one hour later.
.Sh "Negative Epoch Values"
.IX Subsection "Negative Epoch Values"
Negative epoch (time_t) values are not officially supported by the
\&\s-1POSIX\s0 standards, so this module's tests do not test them.  On some
systems, they are known not to work.  These include MacOS (pre\-OSX)
and Win32.
.PP
On systems which do support negative epoch values, this module should
be able to cope with dates before the start of the epoch, down the
minimum value of time_t for the system.
.SH "IMPLEMENTATION"
.IX Header "IMPLEMENTATION"
These routines are quite efficient and yet are always guaranteed to agree
with \fIlocaltime()\fR and \fIgmtime()\fR.  We manage this by caching the start times
of any months we've seen before.  If we know the start time of the month,
we can always calculate any time within the month.  The start times
are calculated using a mathematical formula. Unlike other algorithms
that do multiple calls to \fIgmtime()\fR.
.PP
\&\fItimelocal()\fR is implemented using the same cache.  We just assume that we're
translating a \s-1GMT\s0 time, and then fudge it when we're done for the timezone
and daylight savings arguments.  Note that the timezone is evaluated for
each date because countries occasionally change their official timezones.
Assuming that \fIlocaltime()\fR corrects for these changes, this routine will
also be correct.
.SH "BUGS"
.IX Header "BUGS"
The whole scheme for interpreting two-digit years can be considered a bug.
.SH "SUPPORT"
.IX Header "SUPPORT"
Support for this module is provided via the datetime@perl.org
email list.  See http://lists.perl.org/ for more details.
.PP
Please submit bugs using the \s-1RT\s0 system at rt.cpan.org, or as a last
resort, to the datetime@perl.org list.
.SH "AUTHOR"
.IX Header "AUTHOR"
This module is based on a Perl 4 library, timelocal.pl, that was
included with Perl 4.036, and was most likely written by Tom
Christiansen.
.PP
The current version was written by Graham Barr.
.PP
It is now being maintained separately from the Perl core by Dave
Rolsky, <autarch@urth.org>.