local-lib5/man/man3/DateTime::TimeZone::Local.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "DateTime::TimeZone::Local 3"
 127 .TH DateTime::TimeZone::Local 3 "2009-11-16" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 DateTime::TimeZone::Local \- Determine the local system's time zone
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \&  my $tz = DateTime::TimeZone\->new( name => \*(Aqlocal\*(Aq );
 138 \&
 139 \&  my $tz = DateTime::TimeZone::Local\->TimeZone();
 140 .Ve
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 This module provides an interface for determining the local system's
 144 time zone. Most of the functionality for doing this is in OS-specific
 145 subclasses.
 146 .SH "USAGE"
 147 .IX Header "USAGE"
 148 This class provides the following methods:
 149 .SS "DateTime::TimeZone::Local\->\fITimeZone()\fP"
 150 .IX Subsection "DateTime::TimeZone::Local->TimeZone()"
 151 This attempts to load an appropriate subclass and asks it to find the
 152 local time zone. This method is called by when you pass \*(L"local\*(R" as the
 153 time zone name to \f(CW\*(C`DateTime:TimeZone\->new()\*(C'\fR.
 154 .PP
 155 If your \s-1OS\s0 is not explicitly handled, you can create a module with a
 156 name of the form \f(CW\*(C`DateTime::TimeZone::Local::$^O\*(C'\fR. If it exists, it
 157 will be used instead of falling back to the Unix subclass.
 158 .PP
 159 If no OS-specific module exists, we fall back to using the Unix
 160 subclass.
 161 .PP
 162 See DateTime::TimeZone::Local::Unix,
 163 DateTime::TimeZone::Local::Win32, and
 164 DateTime::TimeZone::Local::VMS for OS-specific details.
 165 .SH "SUBCLASSING"
 166 .IX Header "SUBCLASSING"
 167 If you want to make a new OS-specific subclass, there are several
 168 methods provided by this module you should know about.
 169 .ie n .SS "$class\->\fIMethods()\fP"
 170 .el .SS "\f(CW$class\fP\->\fIMethods()\fP"
 171 .IX Subsection "$class->Methods()"
 172 This method should be provided by your class. It should provide a list
 173 of methods that will be called to try to determine the local time
 174 zone.
 175 .PP
 176 Each of these methods is expected to return a new
 177 \&\f(CW\*(C`DateTime::TimeZone\*(C'\fR object if it determines the time zone.
 178 .ie n .SS "$class\->\fIFromEnv()\fP"
 179 .el .SS "\f(CW$class\fP\->\fIFromEnv()\fP"
 180 .IX Subsection "$class->FromEnv()"
 181 This method tries to find a valid time zone in an \f(CW%ENV\fR value. It
 182 calls \f(CW\*(C`$class\->EnvVars()\*(C'\fR to determine which keys to look at.
 183 .PP
 184 To use this from a subclass, simply return \*(L"FromEnv\*(R" as one of the
 185 items from \f(CW\*(C`$class\->Methods()\*(C'\fR.
 186 .ie n .SS "$class\->\fIEnvVars()\fP"
 187 .el .SS "\f(CW$class\fP\->\fIEnvVars()\fP"
 188 .IX Subsection "$class->EnvVars()"
 189 This method should be provided by your subclass. It should return a
 190 list of env vars to be checked by \f(CW\*(C`$class\->FromEnv()\*(C'\fR.
 191 .ie n .SS "$class\->_IsValidName($name)"
 192 .el .SS "\f(CW$class\fP\->_IsValidName($name)"
 193 .IX Subsection "$class->_IsValidName($name)"
 194 Given a possible time zone name, this returns a boolean indicating
 195 whether or not the the name looks valid. It always return false for
 196 \&\*(L"local\*(R" in order to avoid infinite loops.
 197 .SH "EXAMPLE SUBCLASS"
 198 .IX Header "EXAMPLE SUBCLASS"
 199 Here is a simple example subclass:
 200 .PP
 201 .Vb 1
 202 \&  package DateTime::TimeZone::SomeOS;
 203 \&
 204 \&  use strict;
 205 \&  use warnings;
 206 \&
 207 \&  use base \*(AqDateTime::TimeZone::Local\*(Aq;
 208 \&
 209 \&
 210 \&  sub Methods { qw( FromEnv FromEther ) }
 211 \&
 212 \&  sub EnvVars { qw( TZ ZONE ) }
 213 \&
 214 \&  sub FromEther
 215 \&  {
 216 \&      my $class = shift;
 217 \&
 218 \&      ...
 219 \&  }
 220 .Ve
 221 .SH "AUTHOR"
 222 .IX Header "AUTHOR"
 223 Dave Rolsky, <autarch@urth.org>
 224 .SH "COPYRIGHT & LICENSE"
 225 .IX Header "COPYRIGHT & LICENSE"
 226 Copyright (c) 2003\-2008 David Rolsky.  All rights reserved.  This
 227 program is free software; you can redistribute it and/or modify it
 228 under the same terms as Perl itself.
 229 .PP
 230 The full text of the license can be found in the \s-1LICENSE\s0 file included
 231 with this module.