lib/libc/time/tzfile.5

   1 .\"     $NetBSD: tzfile.5,v 1.13 2009/03/09 19:24:27 joerg Exp $
   2 .\"
   3 .\" @(#)tzfile.5        7.11
   4 .\" This file is in the public domain, so clarified as of
   5 .\" 1996-06-05 by Arthur David Olson (arthur_david_olson@nih.gov).
   6 .Dd September 16, 2001
   7 .Dt TZFILE 5
   8 .Os
   9 .Sh NAME
  10 .Nm tzfile
  11 .Nd time zone information
  12 .Sh SYNOPSIS
  13 .In tzfile.h
  14 .Sh DESCRIPTION
  15 The time zone information files used by
  16 .Xr tzset 3
  17 begin with the magic characters
  18 .Dq TZif
  19 to identify them as time zone information files,
  20 followed by a character identifying the version of the file's format
  21 (as of 2005, either an ASCII NUL or a '2')
  22 followed by fifteen bytes containing zeroes reserved for future use,
  23 followed by six four-byte values of type
  24 .Fa long ,
  25 written in a
  26 .Dq standard
  27 byte order (the high-order byte of the value is written first).
  28 These values are, in order:
  29 .Bl -tag -width XXXXXX -compact
  30 .It Va tzh_ttisgmtcnt
  31 The number of UTC/local indicators stored in the file.
  32 .It Va tzh_ttisstdcnt
  33 The number of standard/wall indicators stored in the file.
  34 .It Va tzh_leapcnt
  35 The number of leap seconds for which data is stored in the file.
  36 .It Va tzh_timecnt
  37 The number of
  38 .Dq transition times
  39 for which data is stored in the file.
  40 .It Va tzh_typecnt
  41 The number of
  42 .Dq local time types
  43 for which data is stored in the file (must not be zero).
  44 .It Va tzh_charcnt
  45 The number of characters of "time zone abbreviation strings"
  46 stored in the file.
  47 .El
  48 .Pp
  49 The above header is followed by
  50 .Va tzh_timecnt
  51 four-byte values of type
  52 .Fa long ,
  53 sorted in ascending order.
  54 These values are written in
  55 .Dq standard
  56 byte order.
  57 Each is used as a transition time (as returned by
  58 .Xr time 3 )
  59 at which the rules for computing local time change.
  60 Next come
  61 .Va tzh_timecnt
  62 one-byte values of type
  63 .Fa unsigned char ;
  64 each one tells which of the different types of
  65 .Dq local time
  66 types described in the file is associated with the same-indexed
  67 transition time.
  68 These values serve as indices into an array of
  69 .Fa ttinfo
  70 .I ttinfo
  71 structures (with
  72 .I tzh_typecnt
  73 entries) that appears next in the file;
  74 these structures are defined as follows:
  75 .Bd -literal
  76 struct ttinfo {
  77         long    tt_gmtoff;
  78         int     tt_isdst;
  79         unsigned int    tt_abbrind;
  80 };
  81 .Ed
  82 Each structure is written as a four-byte value for
  83 .Va tt_gmtoff
  84 of type
  85 .Fa long ,
  86 in a standard byte order, followed by a one-byte value for
  87 .Va tt_isdst
  88 and a one-byte value for
  89 .Va tt_abbrind .
  90 In each structure,
  91 .Va tt_gmtoff
  92 gives the number of seconds to be added to UTC,
  93 .Va tt_isdst
  94 tells whether
  95 .Va tm_isdst
  96 should be set by
  97 .Xr localtime 3
  98 and
  99 .Va tt_abbrind
 100 serves as an index into the array of time zone abbreviation characters
 101 that follow the
 102 .Va ttinfo
 103 structure(s) in the file.
 104 .Pp
 105 Then there are
 106 .Va tzh_leapcnt
 107 pairs of four-byte values, written in standard byte order;
 108 the first value of each pair gives the time
 109 (as returned by
 110 .Xr time 3 )
 111 at which a leap second occurs;
 112 the second gives the
 113 .Em total
 114 number of leap seconds to be applied after the given time.
 115 The pairs of values are sorted in ascending order by time.
 116 .Pp
 117 Then there are
 118 .Va tzh_ttisstdcnt
 119 standard/wall indicators, each stored as a one-byte value;
 120 they tell whether the transition times associated with local time types
 121 were specified as standard time or wall clock time,
 122 and are used when a time zone file is used in handling POSIX-style
 123 time zone environment variables.
 124 .Pp
 125 Finally there are
 126 .Va tzh_ttisgmtcnt
 127 UTC/local indicators, each stored as a one-byte value;
 128 they tell whether the transition times associated with local time types
 129 were specified as UTC or local time,
 130 and are used when a time zone file is used in handling POSIX-style
 131 time zone environment variables.
 132 .Pp
 133 .Xr localtime 3
 134 uses the first standard-time
 135 .Fa ttinfo
 136 structure in the file
 137 (or simply the first
 138 .Fa ttinfo
 139 structure in the absence of a standard-time structure)
 140 if either
 141 .Va tzh_timecnt
 142 is zero or the time argument is less than the first transition time recorded
 143 in the file.
 144 .PP
 145 For version-2-format time zone files,
 146 the above header and data is followed by a second header and data,
 147 identical in format except that
 148 eight bytes are used for each transition time or leap second time.
 149 After the second header and data comes a newline-enclosed,
 150 POSIX-TZ-environment-variable-style string for use in handling instants
 151 after the last transition time stored in the file
 152 (with nothing between the newlines if there is no POSIX representation for
 153 such instants).
 154 .Sh SEE ALSO
 155 .Xr ctime 3 ,
 156 .Xr localtime 3 ,
 157 .Xr time 3
 158 .\" @(#)tzfile.5        8.2
 159 .\" This file is in the public domain, so clarified as of
 160 .\" 1996-06-05 by Arthur David Olson.