Devil Killer Is Here MiNi Shell
MiNi SheLL

Current Path : /proc/thread-self/root/usr/local/man/man3/
Linux boscustweb5004.eigbox.net 5.4.91 #1 SMP Wed Jan 20 18:10:28 EST 2021 x86_64
Current File : //proc/thread-self/root/usr/local/man/man3/DateTime::TimeZone.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 "DateTime::TimeZone 3"
.TH DateTime::TimeZone 3 "2006-12-27" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
DateTime::TimeZone \- Time zone object base class and factory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use DateTime;
\&  use DateTime::TimeZone;
.Ve
.PP
.Vb 1
\&  my $tz = DateTime::TimeZone->new( name => 'America/Chicago' );
.Ve
.PP
.Vb 2
\&  my $dt = DateTime->now();
\&  my $offset = $tz->offset_for_datetime($dt);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is the base class for all time zone objects.  A time zone
is represented internally as a set of observances, each of which
describes the offset from \s-1GMT\s0 for a given time period.
.PP
Note that without the \f(CW\*(C`DateTime.pm\*(C'\fR module, this module does not do
much.  It's primary interface is through a \f(CW\*(C`DateTime\*(C'\fR object, and
most users will not need to directly use \f(CW\*(C`DateTime::TimeZone\*(C'\fR
methods.
.SH "USAGE"
.IX Header "USAGE"
This class has the following methods:
.ie n .IP "* new( name => $tz_name )" 4
.el .IP "* new( name => \f(CW$tz_name\fR )" 4
.IX Item "new( name => $tz_name )"
Given a valid time zone name, this method returns a new time zone
blessed into the appropriate subclass.  Subclasses are named for the
given time zone, so that the time zone \*(L"America/Chicago\*(R" is the
DateTime::TimeZone::America::Chicago class.
.Sp
If the name given is a \*(L"link\*(R" name in the Olson database, the object
created may have a different name.  For example, there is a link from
the old \*(L"\s-1EST5EDT\s0\*(R" name to \*(L"America/New_York\*(R".
.Sp
There are also several special values that can be given as names.
.Sp
If the \*(L"name\*(R" parameter is \*(L"floating\*(R", then a
\&\f(CW\*(C`DateTime::TimeZone::Floating\*(C'\fR object is returned.  A floating time
zone does have \fIany\fR offset, and is always the same time.  This is
useful for calendaring applications, which may need to specify that a
given event happens at the same \fIlocal\fR time, regardless of where it
occurs.  See \s-1RFC\s0 2445 for more details.
.Sp
If the \*(L"name\*(R" parameter is \*(L"\s-1UTC\s0\*(R", then a \f(CW\*(C`DateTime::TimeZone::UTC\*(C'\fR
object is returned.
.Sp
If the \*(L"name\*(R" is an offset string, it is converted to a number, and a
\&\f(CW\*(C`DateTime::TimeZone::OffsetOnly\*(C'\fR object is returned.
.PP
\fIThe \*(L"local\*(R" time zone\fR
.IX Subsection "The local time zone"
.PP
If the \*(L"name\*(R" parameter is \*(L"local\*(R", then the module attempts to
determine the local time zone for the system.
.PP
First it checks \f(CW$ENV\fR for keys named \*(L"\s-1TZ\s0\*(R", \*(L"\s-1SYS$TIMEZONE_RULE\s0\*(R",
\&\*(L"\s-1SYS$TIMEZONE_NAME\s0\*(R", \*(L"\s-1UCX$TZ\s0\*(R", or \*(L"\s-1TCPIP$TZC\s0\*(R" (the last 4 are for
\&\s-1VMS\s0).  If this is defined, and it is not the string \*(L"local\*(R", then it
is treated as any other valid name (including \*(L"floating\*(R"), and the
constructor tries to create a time zone based on that name.
.PP
Next, it checks for the existence of a symlink at \fI/etc/localtime\fR.
It follows this link to the real file and figures out what the file's
name is.  It then tries to turn this name into a valid time zone.  For
example, if this file is linked to \fI/usr/share/zoneinfo/US/Central\fR,
it will end up trying \*(L"US/Central\*(R", which will then be converted to
\&\*(L"America/Chicago\*(R" internally.
.PP
Some systems just copy the relevant file to \fI/etc/localtime\fR instead
of making a symlink.  In this case, we look in \fI/usr/share/zoneinfo\fR
for a file that has the same size and content as \fI/etc/localtime\fR to
determine the local time zone.
.PP
Then it checks for a file called \fI/etc/timezone\fR or \fI/etc/TIMEZONE\fR.
If one of these exists, it is read and it tries to create a time zone
with the name contained in the file.
.PP
Finally, it checks for a file called \fI/etc/sysconfig/clock\fR.  If this
file exists, it looks for a line inside the file matching
\&\f(CW\*(C`/^(?:TIME)?ZONE="([^"]+)"/\*(C'\fR.  If this line exists, it tries the
value as a time zone name.
.PP
If none of these methods work, it gives up and dies.
.Sh "Object Methods"
.IX Subsection "Object Methods"
\&\f(CW\*(C`DateTime::TimeZone\*(C'\fR objects provide the following methods:
.ie n .IP "* offset_for_datetime( $dt )" 4
.el .IP "* offset_for_datetime( \f(CW$dt\fR )" 4
.IX Item "offset_for_datetime( $dt )"
Given a \f(CW\*(C`DateTime\*(C'\fR object, this method returns the offset in seconds
for the given datetime.  This takes into account historical time zone
information, as well as Daylight Saving Time.  The offset is
determined by looking at the object's \s-1UTC\s0 Rata Die days and seconds.
.ie n .IP "* offset_for_local_datetime( $dt )" 4
.el .IP "* offset_for_local_datetime( \f(CW$dt\fR )" 4
.IX Item "offset_for_local_datetime( $dt )"
Given a \f(CW\*(C`DateTime\*(C'\fR object, this method returns the offset in seconds
for the given datetime.  Unlike the previous method, this method uses
the local time's Rata Die days and seconds.  This should only be done
when the corresponding \s-1UTC\s0 time is not yet known, because local times
can be ambiguous due to Daylight Saving Time rules.
.IP "* name" 4
.IX Item "name"
Returns the name of the time zone.  If this value is passed to the
\&\f(CW\*(C`new()\*(C'\fR method, it is guaranteed to create the same object.
.ie n .IP "* short_name_for_datetime( $dt )" 4
.el .IP "* short_name_for_datetime( \f(CW$dt\fR )" 4
.IX Item "short_name_for_datetime( $dt )"
Given a \f(CW\*(C`DateTime\*(C'\fR object, this method returns the \*(L"short name\*(R" for
the current observance and rule this datetime is in.  These are names
like \*(L"\s-1EST\s0\*(R", \*(L"\s-1GMT\s0\*(R", etc.
.Sp
It is \fBstrongly\fR recommended that you do not rely on these names for
anything other than display.  These names are not official, and many
of them are simply the invention of the Olson database maintainers.
Moreover, these names are not unique.  For example, there is an \*(L"\s-1EST\s0\*(R"
at both \-0500 and +1000/+1100.
.IP "* is_floating" 4
.IX Item "is_floating"
Returns a boolean indicating whether or not this object represents a
floating time zone, as defined by \s-1RFC\s0 2445.
.IP "* is_utc" 4
.IX Item "is_utc"
Indicates whether or not this object represents the \s-1UTC\s0 (\s-1GMT\s0) time
zone.
.IP "* has_dst_changes" 4
.IX Item "has_dst_changes"
Indicates whether or not this zone has \fIever\fR had a change to and
from \s-1DST\s0, either in the past or future.
.IP "* is_olson" 4
.IX Item "is_olson"
Returns true if the time zone is a named time zone from the Olson
database.
.IP "* category" 4
.IX Item "category"
Returns the part of the time zone name before the first slash.  For
example, the \*(L"America/Chicago\*(R" time zone would return \*(L"America\*(R".
.Sh "Class Methods"
.IX Subsection "Class Methods"
This class provides one class method:
.IP "* is_valid_name ($name)" 4
.IX Item "is_valid_name ($name)"
Given a string, this method returns a boolean value indicating whether
or not the string is a valid time zone name.  If you are using
\&\f(CW\*(C`DateTime::TimeZone::Alias\*(C'\fR, any aliases you've created will be valid.
.Sh "Storable Hooks"
.IX Subsection "Storable Hooks"
This module provides freeze and thaw hooks for \f(CW\*(C`Storable\*(C'\fR so that the
huge data structures for Olson time zones are not actually stored in
the serialized structure.
.PP
If you subclass \f(CW\*(C`DateTime::TimeZone\*(C'\fR, you will inherit its hooks,
which may not work for your module, so please test the interaction of
your module with Storable.
.Sh "Catalog Functions"
.IX Subsection "Catalog Functions"
This class provides several functions for examining the catalog of
time zones. Calling these as class methods will also work.
.IP "* all_names" 4
.IX Item "all_names"
This returns a pre-sorted list of all the time zone names.  This list
does not include link names.  In scalar context, it returns an array
reference, while in list context it returns an array.
.IP "* categories" 4
.IX Item "categories"
This returns a list of all time zone categories.  In scalar context,
it returns an array reference, while in list context it returns an
array.
.IP "* links" 4
.IX Item "links"
This returns a hash of all time zone links, where the keys are the
old, deprecated names, and the values are the new names.  In scalar
context, it returns a hash reference, while in list context it returns
a hash.
.ie n .IP "* names_in_category( $category )" 4
.el .IP "* names_in_category( \f(CW$category\fR )" 4
.IX Item "names_in_category( $category )"
Given a valid category, this method returns a list of the names in
that category, without the category portion.  So the list for the
\&\*(L"America\*(R" category would include the strings \*(L"Chicago\*(R",
\&\*(L"Kentucky/Monticello\*(R", and \*(L"New_York\*(R". In scalar context, it returns
an array reference, while in list context it returns an array.
.Sp
The list is returned in order of population by zone, which should mean
that this order will be the best to use for most UIs.
.IP "* \fIcountries()\fR" 4
.IX Item "countries()"
Returns a sorted list of all the valid country codes (in lower\-case)
which can be passed to \f(CW\*(C`names_in_country()\*(C'\fR. In scalar context, it
returns an array reference, while in list context it returns an array.
.Sp
If you need to convert country codes to names or vice versa you can
use \f(CW\*(C`Locale::Country\*(C'\fR to do so.
.ie n .IP "* names_in_country( $country_code )" 4
.el .IP "* names_in_country( \f(CW$country_code\fR )" 4
.IX Item "names_in_country( $country_code )"
Given a two-letter \s-1ISO3066\s0 country code, this method returns a list of
time zones used in that country. The country code may be of any
case. In scalar context, it returns an array reference, while in list
context it returns an array.
.Sh "Other Functions"
.IX Subsection "Other Functions"
This class also contains several functions, none of which are
exported.  Calling these as class methods will also work.
.ie n .IP "* offset_as_seconds( $offset )" 4
.el .IP "* offset_as_seconds( \f(CW$offset\fR )" 4
.IX Item "offset_as_seconds( $offset )"
Given an offset as a string, this returns the number of seconds
represented by the offset as a positive or negative number.  Returns
\&\f(CW\*(C`undef\*(C'\fR if \f(CW$offset\fR is not in the range \f(CW\*(C`\-99:59:59\*(C'\fR to \f(CW\*(C`+99:59:59\*(C'\fR.
.Sp
The offset is expected to match either
\&\f(CW\*(C`/^([\e+\e\-])?(\ed\ed?):(\ed\ed)(?::(\ed\ed))?$/\*(C'\fR or
\&\f(CW\*(C`/^([\e+\e\-])?(\ed\ed)(\ed\ed)(\ed\ed)?$/\*(C'\fR.  If it doesn't match either of
these, \f(CW\*(C`undef\*(C'\fR will be returned.
.Sp
This means that if you want to specify hours as a single digit, then
each element of the offset must be separated by a colon (:).
.ie n .IP "* offset_as_string( $offset )" 4
.el .IP "* offset_as_string( \f(CW$offset\fR )" 4
.IX Item "offset_as_string( $offset )"
Given an offset as a number, this returns the offset as a string.
Returns \f(CW\*(C`undef\*(C'\fR if \f(CW$offset\fR is not in the range \f(CW\*(C`\-359999\*(C'\fR to \f(CW359999\fR.
.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 to the \s-1CPAN\s0 \s-1RT\s0 system at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=datetime%3A%3Atimezone
or via email at bug\-datetime\-timezone@rt.cpan.org.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "CREDITS"
.IX Header "CREDITS"
This module was inspired by Jesse Vincent's work on
Date::ICal::Timezone, and written with much help from the
datetime@perl.org list.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 David Rolsky.  All rights reserved.  This program
is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.
.PP
The full text of the license can be found in the \s-1LICENSE\s0 file included
with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
datetime@perl.org mailing list
.PP
http://datetime.perl.org/
.PP
The tools directory of the DateTime::TimeZone distribution includes
two scripts that may be of interest to some people.  They are
parse_olson and tests_from_zdump.  Please run them with the \-\-help
flag to see what they can be used for.
Creat By MiNi SheLL
Email: devilkiller@gmail.com