local-lib5/man/man3/DateTime::TimeZone::Local::Win32.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::Win32 3"
 127 .TH DateTime::TimeZone::Local::Win32 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::Win32 \- Determine the local system's time zone on Windows
 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 methods for determining the local time zone on a
 144 Windows platform.
 145 .SH "HOW THE TIME ZONE IS DETERMINED"
 146 .IX Header "HOW THE TIME ZONE IS DETERMINED"
 147 This class tries the following methods of determining the local time
 148 zone:
 149 .IP "\(bu" 4
 150 \&\f(CW$ENV\fR{\s-1TZ\s0}
 151 .Sp
 152 It checks \f(CW$ENV{TZ}\fR for a valid time zone name.
 153 .IP "\(bu" 4
 154 Windows Registry
 155 .Sp
 156 When using the registry, we look for the Windows time zone and use a
 157 mapping to translate this to an Olson time zone name.
 158 .RS 4
 159 .IP "\(bu" 8
 160 Windows Vista and 2008
 161 .Sp
 162 We look in \*(L"SYSTEM/CurrentControlSet/Control/TimeZoneInformation/\*(R" for
 163 a node named \*(L"/TimeZoneKeyName\*(R". If this exists, we use this key to
 164 look up the Olson time zone name in our mapping.
 165 .IP "\(bu" 8
 166 Windows \s-1NT\s0, Windows 2000, Windows \s-1XP\s0, Windows 2003 Server
 167 .Sp
 168 We look in \*(L"SOFTWARE/Microsoft/Windows NT/CurrentVersion/Time Zones/\*(R"
 169 and loop through all of its sub keys.
 170 .Sp
 171 For each sub key, we compare the value of the key with \*(L"/Std\*(R" appended
 172 to the end to the value of
 173 \&\*(L"SYSTEM/CurrentControlSet/Control/TimeZoneInformation/StandardName\*(R". This
 174 gives us the \fIEnglish\fR name of the Windows time zone, which we use to
 175 look up the Olson time zone name.
 176 .IP "\(bu" 8
 177 Windows 95, Windows 98, Windows Millenium Edition
 178 .Sp
 179 The algorithm is the same as for \s-1NT\s0, but we loop through the sub keys
 180 of \*(L"SOFTWARE/Microsoft/Windows/CurrentVersion/Time Zones/\*(R"
 181 .RE
 182 .RS 4
 183 .RE
 184 .SH "AUTHOR"
 185 .IX Header "AUTHOR"
 186 Dave Rolsky, <autarch@urth.org>
 187 .SH "COPYRIGHT & LICENSE"
 188 .IX Header "COPYRIGHT & LICENSE"
 189 Copyright (c) 2003\-2008 David Rolsky.  All rights reserved.  This
 190 program is free software; you can redistribute it and/or modify it
 191 under the same terms as Perl itself.
 192 .PP
 193 The full text of the license can be found in the \s-1LICENSE\s0 file included
 194 with this module.