--- /dev/null
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
+.\"
+.\" 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" ''
+'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 turned on, 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.
+.ie \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.el \{\
+. de IX
+..
+.\}
+.\"
+.\" 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::Local 3"
+.TH DateTime::TimeZone::Local 3 "2009-11-16" "perl v5.8.7" "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"
+DateTime::TimeZone::Local \- Determine the local system's time zone
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& my $tz = DateTime::TimeZone\->new( name => \*(Aqlocal\*(Aq );
+\&
+\& my $tz = DateTime::TimeZone::Local\->TimeZone();
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module provides an interface for determining the local system's
+time zone. Most of the functionality for doing this is in OS-specific
+subclasses.
+.SH "USAGE"
+.IX Header "USAGE"
+This class provides the following methods:
+.SS "DateTime::TimeZone::Local\->\fITimeZone()\fP"
+.IX Subsection "DateTime::TimeZone::Local->TimeZone()"
+This attempts to load an appropriate subclass and asks it to find the
+local time zone. This method is called by when you pass \*(L"local\*(R" as the
+time zone name to \f(CW\*(C`DateTime:TimeZone\->new()\*(C'\fR.
+.PP
+If your \s-1OS\s0 is not explicitly handled, you can create a module with a
+name of the form \f(CW\*(C`DateTime::TimeZone::Local::$^O\*(C'\fR. If it exists, it
+will be used instead of falling back to the Unix subclass.
+.PP
+If no OS-specific module exists, we fall back to using the Unix
+subclass.
+.PP
+See DateTime::TimeZone::Local::Unix,
+DateTime::TimeZone::Local::Win32, and
+DateTime::TimeZone::Local::VMS for OS-specific details.
+.SH "SUBCLASSING"
+.IX Header "SUBCLASSING"
+If you want to make a new OS-specific subclass, there are several
+methods provided by this module you should know about.
+.ie n .SS "$class\->\fIMethods()\fP"
+.el .SS "\f(CW$class\fP\->\fIMethods()\fP"
+.IX Subsection "$class->Methods()"
+This method should be provided by your class. It should provide a list
+of methods that will be called to try to determine the local time
+zone.
+.PP
+Each of these methods is expected to return a new
+\&\f(CW\*(C`DateTime::TimeZone\*(C'\fR object if it determines the time zone.
+.ie n .SS "$class\->\fIFromEnv()\fP"
+.el .SS "\f(CW$class\fP\->\fIFromEnv()\fP"
+.IX Subsection "$class->FromEnv()"
+This method tries to find a valid time zone in an \f(CW%ENV\fR value. It
+calls \f(CW\*(C`$class\->EnvVars()\*(C'\fR to determine which keys to look at.
+.PP
+To use this from a subclass, simply return \*(L"FromEnv\*(R" as one of the
+items from \f(CW\*(C`$class\->Methods()\*(C'\fR.
+.ie n .SS "$class\->\fIEnvVars()\fP"
+.el .SS "\f(CW$class\fP\->\fIEnvVars()\fP"
+.IX Subsection "$class->EnvVars()"
+This method should be provided by your subclass. It should return a
+list of env vars to be checked by \f(CW\*(C`$class\->FromEnv()\*(C'\fR.
+.ie n .SS "$class\->_IsValidName($name)"
+.el .SS "\f(CW$class\fP\->_IsValidName($name)"
+.IX Subsection "$class->_IsValidName($name)"
+Given a possible time zone name, this returns a boolean indicating
+whether or not the the name looks valid. It always return false for
+\&\*(L"local\*(R" in order to avoid infinite loops.
+.SH "EXAMPLE SUBCLASS"
+.IX Header "EXAMPLE SUBCLASS"
+Here is a simple example subclass:
+.PP
+.Vb 1
+\& package DateTime::TimeZone::SomeOS;
+\&
+\& use strict;
+\& use warnings;
+\&
+\& use base \*(AqDateTime::TimeZone::Local\*(Aq;
+\&
+\&
+\& sub Methods { qw( FromEnv FromEther ) }
+\&
+\& sub EnvVars { qw( TZ ZONE ) }
+\&
+\& sub FromEther
+\& {
+\& my $class = shift;
+\&
+\& ...
+\& }
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Dave Rolsky, <autarch@urth.org>
+.SH "COPYRIGHT & LICENSE"
+.IX Header "COPYRIGHT & LICENSE"
+Copyright (c) 2003\-2008 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.
projects / catagits/Gitalist.git / blobdiff