lib/libc/stdtime/tzfile.5

   1 .\" $FreeBSD: src/lib/libc/stdtime/tzfile.5,v 1.8.2.2 2001/08/17 15:42:43 ru Exp $
   2 .\" $DragonFly: src/lib/libc/stdtime/tzfile.5,v 1.2 2003/06/17 04:26:46 dillon Exp $
   3 .Dd September 13, 1994
   4 .Dt TZFILE 5
   5 .Os
   6 .Sh NAME
   7 .Nm tzfile
   8 .Nd timezone information
   9 .Sh SYNOPSIS
  10 .Fd #include \&"/usr/src/lib/libc/stdtime/tzfile.h\&"
  11 .Sh DESCRIPTION
  12 The time zone information files used by
  13 .Xr tzset 3
  14 begin with the magic characters
  15 .Dq Li TZif
  16 to identify them as
  17 time zone information files,
  18 followed by sixteen bytes reserved for future use,
  19 followed by four four-byte values
  20 written in a ``standard'' byte order
  21 (the high-order byte of the value is written first).
  22 These values are,
  23 in order:
  24 .Pp
  25 .Bl -tag -compact -width tzh_ttisstdcnt
  26 .It Va tzh_ttisgmtcnt
  27 The number of UTC/local indicators stored in the file.
  28 .It Va tzh_ttisstdcnt
  29 The number of standard/wall indicators stored in the file.
  30 .It Va tzh_leapcnt
  31 The number of leap seconds for which data is stored in the file.
  32 .It Va tzh_timecnt
  33 The number of ``transition times'' for which data is stored
  34 in the file.
  35 .It Va tzh_typecnt
  36 The number of ``local time types'' for which data is stored
  37 in the file (must not be zero).
  38 .It Va tzh_charcnt
  39 The number of characters of ``time zone abbreviation strings''
  40 stored in the file.
  41 .El
  42 .Pp
  43 The above header is followed by
  44 .Va tzh_timecnt
  45 four-byte values of type
  46 .Fa long ,
  47 sorted in ascending order.
  48 These values are written in ``standard'' byte order.
  49 Each is used as a transition time (as returned by
  50 .Xr time 3 )
  51 at which the rules for computing local time change.
  52 Next come
  53 .Va tzh_timecnt
  54 one-byte values of type
  55 .Fa "unsigned char" ;
  56 each one tells which of the different types of ``local time'' types
  57 described in the file is associated with the same-indexed transition time.
  58 These values serve as indices into an array of
  59 .Fa ttinfo
  60 structures that appears next in the file;
  61 these structures are defined as follows:
  62 .Pp
  63 .Bd -literal -offset indent
  64 struct ttinfo {
  65         long    tt_gmtoff;
  66         int     tt_isdst;
  67         unsigned int    tt_abbrind;
  68 };
  69 .Ed
  70 .Pp
  71 Each structure is written as a four-byte value for
  72 .Va tt_gmtoff
  73 of type
  74 .Fa long ,
  75 in a standard byte order, followed by a one-byte value for
  76 .Va tt_isdst
  77 and a one-byte value for
  78 .Va tt_abbrind .
  79 In each structure,
  80 .Va tt_gmtoff
  81 gives the number of seconds to be added to UTC,
  82 .Li tt_isdst
  83 tells whether
  84 .Li tm_isdst
  85 should be set by
  86 .Xr localtime 3
  87 and
  88 .Va tt_abbrind
  89 serves as an index into the array of time zone abbreviation characters
  90 that follow the
  91 .Li ttinfo
  92 structure(s) in the file.
  93 .Pp
  94 Then there are
  95 .Va tzh_leapcnt
  96 pairs of four-byte values, written in standard byte order;
  97 the first value of each pair gives the time
  98 (as returned by
  99 .Xr time 3 )
 100 at which a leap second occurs;
 101 the second gives the
 102 .Em total
 103 number of leap seconds to be applied after the given time.
 104 The pairs of values are sorted in ascending order by time.
 105 .Pp
 106 Then there are
 107 .Va tzh_ttisstdcnt
 108 standard/wall indicators, each stored as a one-byte value;
 109 they tell whether the transition times associated with local time types
 110 were specified as standard time or wall clock time,
 111 and are used when a time zone file is used in handling POSIX-style
 112 time zone environment variables.
 113 .Pp
 114 Finally there are
 115 .Va tzh_ttisgmtcnt
 116 UTC/local indicators, each stored as a one-byte value;
 117 they tell whether the transition times associated with local time types
 118 were specified as UTC or local time,
 119 and are used when a time zone file is used in handling POSIX-style
 120 time zone environment variables.
 121 .Pp
 122 .Nm localtime
 123 uses the first standard-time
 124 .Li ttinfo
 125 structure in the file
 126 (or simply the first
 127 .Li ttinfo
 128 structure in the absence of a standard-time structure)
 129 if either
 130 .Li tzh_timecnt
 131 is zero or the time argument is less than the first transition time recorded
 132 in the file.
 133 .Sh SEE ALSO
 134 .Xr ctime 3 ,
 135 .Xr time2posix 3 ,
 136 .Xr zic 8
 137 .\" @(#)tzfile.5        7.2
 138 .\" This file is in the public domain, so clarified as of
 139 .\" 1996-06-05 by Arthur David Olson (arthur_david_olson@nih.gov).