2004-11-03 13:51:07 +00:00
|
|
|
.\" @(#)tzfile.5 7.11
|
|
|
|
.\" This file is in the public domain, so clarified as of
|
|
|
|
.\" 1996-06-05 by Arthur David Olson <arthur_david_olson@nih.gov>.
|
2010-08-31 05:49:34 +00:00
|
|
|
.TH TZFILE 5 2010-08-31 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2008-09-07 04:17:25 +00:00
|
|
|
tzfile \- timezone information
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
2008-06-18 08:57:49 +00:00
|
|
|
.B #include <tzfile.h>
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2008-09-07 04:17:25 +00:00
|
|
|
The timezone information files used by
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR tzset (3)
|
|
|
|
begin with the magic characters "TZif" to identify then as
|
2008-09-07 04:17:25 +00:00
|
|
|
timezone information files,
|
2010-08-31 05:49:34 +00:00
|
|
|
followed by a character identifying the version of the file's format
|
|
|
|
(as of 2005, either an ASCII NUL ('\\0') or a '2')
|
|
|
|
followed by fifteen bytes containing zeroes reserved for future use,
|
2004-11-03 13:51:07 +00:00
|
|
|
followed by six four-byte values of type
|
2005-11-02 13:55:25 +00:00
|
|
|
.IR long ,
|
2007-12-16 14:08:46 +00:00
|
|
|
written in a "standard" byte order
|
2004-11-03 13:51:07 +00:00
|
|
|
(the high-order byte of the value is written first).
|
|
|
|
These values are,
|
|
|
|
in order:
|
|
|
|
.TP
|
|
|
|
.I tzh_ttisgmtcnt
|
|
|
|
The number of UTC/local indicators stored in the file.
|
|
|
|
.TP
|
|
|
|
.I tzh_ttisstdcnt
|
|
|
|
The number of standard/wall indicators stored in the file.
|
|
|
|
.TP
|
|
|
|
.I tzh_leapcnt
|
|
|
|
The number of leap seconds for which data is stored in the file.
|
|
|
|
.TP
|
|
|
|
.I tzh_timecnt
|
|
|
|
The number of "transition times" for which data is stored
|
|
|
|
in the file.
|
|
|
|
.TP
|
|
|
|
.I tzh_typecnt
|
|
|
|
The number of "local time types" for which data is stored
|
|
|
|
in the file (must not be zero).
|
|
|
|
.TP
|
|
|
|
.I tzh_charcnt
|
2008-09-07 04:17:25 +00:00
|
|
|
The number of characters of "timezone abbreviation strings"
|
2004-11-03 13:51:07 +00:00
|
|
|
stored in the file.
|
|
|
|
.PP
|
|
|
|
The above header is followed by
|
|
|
|
.I tzh_timecnt
|
|
|
|
four-byte values of type
|
2006-02-09 20:24:53 +00:00
|
|
|
.IR long ,
|
2004-11-03 13:51:07 +00:00
|
|
|
sorted in ascending order.
|
2007-12-16 14:08:46 +00:00
|
|
|
These values are written in "standard" byte order.
|
2004-11-03 13:51:07 +00:00
|
|
|
Each is used as a transition time (as returned by
|
|
|
|
.BR time (2))
|
|
|
|
at which the rules for computing local time change.
|
|
|
|
Next come
|
|
|
|
.I tzh_timecnt
|
|
|
|
one-byte values of type
|
2006-02-09 20:24:53 +00:00
|
|
|
.IR "unsigned char" ;
|
2007-12-16 14:08:46 +00:00
|
|
|
each one tells which of the different types of "local time" types
|
2004-11-03 13:51:07 +00:00
|
|
|
described in the file is associated with the same-indexed transition time.
|
|
|
|
These values serve as indices into an array of
|
|
|
|
.I ttinfo
|
2010-08-31 05:49:34 +00:00
|
|
|
structures (with
|
|
|
|
.I tzh_typecnt
|
|
|
|
entries) that appear next in the file;
|
2004-11-03 13:51:07 +00:00
|
|
|
these structures are defined as follows:
|
2007-12-19 05:53:30 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
.nf
|
|
|
|
struct ttinfo {
|
2007-04-05 13:29:41 +00:00
|
|
|
long tt_gmtoff;
|
|
|
|
int tt_isdst;
|
|
|
|
unsigned int tt_abbrind;
|
2004-11-03 13:51:07 +00:00
|
|
|
};
|
2007-12-19 05:53:30 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.sp
|
|
|
|
Each structure is written as a four-byte value for
|
|
|
|
.I tt_gmtoff
|
|
|
|
of type
|
2006-02-09 20:24:53 +00:00
|
|
|
.IR long ,
|
2004-11-03 13:51:07 +00:00
|
|
|
in a standard byte order, followed by a one-byte value for
|
|
|
|
.I tt_isdst
|
|
|
|
and a one-byte value for
|
|
|
|
.IR tt_abbrind .
|
|
|
|
In each structure,
|
|
|
|
.I tt_gmtoff
|
|
|
|
gives the number of seconds to be added to UTC,
|
|
|
|
.I tt_isdst
|
|
|
|
tells whether
|
|
|
|
.I tm_isdst
|
|
|
|
should be set by
|
|
|
|
.BR localtime (3),
|
|
|
|
and
|
|
|
|
.I tt_abbrind
|
2008-09-07 04:17:25 +00:00
|
|
|
serves as an index into the array of timezone abbreviation characters
|
2004-11-03 13:51:07 +00:00
|
|
|
that follow the
|
|
|
|
.I ttinfo
|
|
|
|
structure(s) in the file.
|
|
|
|
.PP
|
|
|
|
Then there are
|
|
|
|
.I tzh_leapcnt
|
|
|
|
pairs of four-byte values, written in standard byte order;
|
|
|
|
the first value of each pair gives the time
|
|
|
|
(as returned by
|
|
|
|
.BR time (2))
|
|
|
|
at which a leap second occurs;
|
|
|
|
the second gives the
|
|
|
|
.I total
|
|
|
|
number of leap seconds to be applied after the given time.
|
|
|
|
The pairs of values are sorted in ascending order by time.
|
|
|
|
.PP
|
|
|
|
Then there are
|
|
|
|
.I tzh_ttisstdcnt
|
|
|
|
standard/wall indicators, each stored as a one-byte value;
|
|
|
|
they tell whether the transition times associated with local time types
|
|
|
|
were specified as standard time or wall clock time,
|
2008-09-07 04:17:25 +00:00
|
|
|
and are used when a timezone file is used in handling POSIX-style
|
|
|
|
timezone environment variables.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
Finally, there are
|
|
|
|
.I tzh_ttisgmtcnt
|
|
|
|
UTC/local indicators, each stored as a one-byte value;
|
|
|
|
they tell whether the transition times associated with local time types
|
|
|
|
were specified as UTC or local time,
|
2008-09-07 04:17:25 +00:00
|
|
|
and are used when a timezone file is used in handling POSIX-style
|
|
|
|
timezone environment variables.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2010-08-31 05:49:34 +00:00
|
|
|
.BR localtime (3)
|
2004-11-03 13:51:07 +00:00
|
|
|
uses the first standard-time
|
|
|
|
.I ttinfo
|
|
|
|
structure in the file
|
|
|
|
(or simply the first
|
|
|
|
.I ttinfo
|
|
|
|
structure in the absence of a standard-time structure)
|
|
|
|
if either
|
|
|
|
.I tzh_timecnt
|
|
|
|
is zero or the time argument is less than the first transition time recorded
|
|
|
|
in the file.
|
2010-08-31 05:49:34 +00:00
|
|
|
.PP
|
|
|
|
For version-2-format timezone files,
|
|
|
|
the above header and data is followed by a second header and data,
|
|
|
|
identical in format except that
|
|
|
|
eight bytes are used for each transition time or leap-second time.
|
|
|
|
After the second header and data comes a newline-enclosed,
|
|
|
|
POSIX-TZ-environment-variable-style string for use in handling instants
|
|
|
|
after the last transition time stored in the file
|
|
|
|
(with nothing between the newlines if there is no POSIX representation for
|
|
|
|
such instants).
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR ctime (3)
|