rename svn revision variable to one with underscore, to not pollute
[minix3.git] / commands / zoneinfo / zic.8.txt
blob45c4d304f4761dfaf6660cc729187f381a57b43a
1 NAME
3      zic - time zone compiler
5 SYNOPSIS
6      zic [ --version ] [ -v ] [ -d directory ] [ -l localtime ] [
7      -p posixrules ] [ -L leapsecondfilename ] [ -s ] [ -y
8      command ] [ filename ... ]
10 DESCRIPTION
11      Zic reads text from the file(s) named on the command line
12      and creates the time conversion information files specified
13      in this input.  If a filename is -, the standard input is
14      read.
16      These options are available:
18      --version
19           Output version information and exit.
21      -d directory
22           Create time conversion information files in the named
23           directory rather than in the standard directory named
24           below.
26      -l timezone
27           Use the given time zone as local time.  Zic will act as
28           if the input contained a link line of the form
30                Link timezone       localtime
32      -p timezone
33           Use the given time zone's rules when handling POSIX-
34           format time zone environment variables.  Zic will act
35           as if the input contained a link line of the form
37                Link timezone       posixrules
39      -L leapsecondfilename
40           Read leap second information from the file with the
41           given name.  If this option is not used, no leap second
42           information appears in output files.
44      -v   Complain if a year that appears in a data file is
45           outside the range of years representable by time(2)
46           values.  Also complain if a time of 24:00 (which cannot
47           be handled by pre-1998 versions of zic) appears in the
48           input.
50      -s   Limit time values stored in output files to values that
51           are the same whether they're taken to be signed or
52           unsigned.  You can use this option to generate SVVS-
53           compatible files.
55      -y command
56           Use the given command rather than yearistype when
57           checking year types (see below).
59      Input lines are made up of fields.  Fields are separated
60      from one another by any number of white space characters.
61      Leading and trailing white space on input lines is ignored.
62      An unquoted sharp character (#) in the input introduces a
63      comment which extends to the end of the line the sharp
64      character appears on.  White space characters and sharp
65      characters may be enclosed in double quotes (") if they're
66      to be used as part of a field.  Any line that is blank
67      (after comment stripping) is ignored.  Non-blank lines are
68      expected to be of one of three types:  rule lines, zone
69      lines, and link lines.
71      A rule line has the form
73           Rule  NAME  FROM  TO    TYPE  IN   ON       AT    SAVE  LETTER/S
75      For example:
77           Rule  US    1967  1973  -     Apr  lastSun  2:00  1:00  D
79      The fields that make up a rule line are:
81      NAME    Gives the (arbitrary) name of the set of rules this
82              rule is part of.
84      FROM    Gives the first year in which the rule applies.  Any
85              integer year can be supplied; the Gregorian calendar
86              is assumed.  The word minimum (or an abbreviation)
87              means the minimum year representable as an integer.
88              The word maximum (or an abbreviation) means the
89              maximum year representable as an integer.  Rules can
90              describe times that are not representable as time
91              values, with the unrepresentable times ignored; this
92              allows rules to be portable among hosts with
93              differing time value types.
95      TO      Gives the final year in which the rule applies.  In
96              addition to minimum and maximum (as above), the word
97              only (or an abbreviation) may be used to repeat the
98              value of the FROM field.
100      TYPE    Gives the type of year in which the rule applies.
101              If TYPE is - then the rule applies in all years
102              between FROM and TO inclusive.  If TYPE is something
103              else, then zic executes the command
104                   yearistype year type
105              to check the type of a year:  an exit status of zero
106              is taken to mean that the year is of the given type;
107              an exit status of one is taken to mean that the year
108              is not of the given type.
110      IN      Names the month in which the rule takes effect.
111              Month names may be abbreviated.
113      ON      Gives the day on which the rule takes effect.
114              Recognized forms include:
116                   5        the fifth of the month
117                   lastSun  the last Sunday in the month
118                   lastMon  the last Monday in the month
119                   Sun>=8   first Sunday on or after the eighth
120                   Sun<=25  last Sunday on or before the 25th
122              Names of days of the week may be abbreviated or
123              spelled out in full.  Note that there must be no
124              spaces within the ON field.
126      AT      Gives the time of day at which the rule takes
127              effect.  Recognized forms include:
129                   2        time in hours
130                   2:00     time in hours and minutes
131                   15:00    24-hour format time (for times after noon)
132                   1:28:14  time in hours, minutes, and seconds
133                   -        equivalent to 0
135              where hour 0 is midnight at the start of the day,
136              and hour 24 is midnight at the end of the day.  Any
137              of these forms may be followed by the letter w if
138              the given time is local "wall clock" time, s if the
139              given time is local "standard" time, or u (or g or
140              z) if the given time is universal time; in the
141              absence of an indicator, wall clock time is assumed.
143      SAVE    Gives the amount of time to be added to local
144              standard time when the rule is in effect.  This
145              field has the same format as the AT field (although,
146              of course, the w and s suffixes are not used).
148      LETTER/S
149              Gives the "variable part" (for example, the "S" or
150              "D" in "EST" or "EDT") of time zone abbreviations to
151              be used when this rule is in effect.  If this field
152              is -, the variable part is null.
154      A zone line has the form
156           Zone  NAME                GMTOFF  RULES/SAVE  FORMAT  [UNTIL]
158      For example:
160           Zone  Australia/Adelaide  9:30    Aus         CST     1971 Oct 31 2:00
162      The fields that make up a zone line are:
164      NAME  The name of the time zone.  This is the name used in
165            creating the time conversion information file for the
166            zone.
168      GMTOFF
169            The amount of time to add to UTC to get standard time
170            in this zone.  This field has the same format as the
171            AT and SAVE fields of rule lines; begin the field with
172            a minus sign if time must be subtracted from UTC.
174      RULES/SAVE
175            The name of the rule(s) that apply in the time zone
176            or, alternately, an amount of time to add to local
177            standard time.  If this field is - then standard time
178            always applies in the time zone.
180      FORMAT
181            The format for time zone abbreviations in this time
182            zone.  The pair of characters %s is used to show where
183            the "variable part" of the time zone abbreviation
184            goes.  Alternately, a slash (/) separates standard and
185            daylight abbreviations.
187      UNTIL The time at which the UTC offset or the rule(s) change
188            for a location.  It is specified as a year, a month, a
189            day, and a time of day.  If this is specified, the
190            time zone information is generated from the given UTC
191            offset and rule change until the time specified.  The
192            month, day, and time of day have the same format as
193            the IN, ON, and AT columns of a rule; trailing columns
194            can be omitted, and default to the earliest possible
195            value for the missing columns.
197            The next line must be a "continuation" line; this has
198            the same form as a zone line except that the string
199            "Zone" and the name are omitted, as the continuation
200            line will place information starting at the time
201            specified as the UNTIL field in the previous line in
202            the file used by the previous line.  Continuation
203            lines may contain an UNTIL field, just as zone lines
204            do, indicating that the next line is a further
205            continuation.
207      A link line has the form
209           Link  LINK-FROM        LINK-TO
211      For example:
213           Link  Europe/Istanbul  Asia/Istanbul
215      The LINK-FROM field should appear as the NAME field in some
216      zone line; the LINK-TO field is used as an alternate name
217      for that zone.
219      Except for continuation lines, lines may appear in any order
220      in the input.
222      Lines in the file that describes leap seconds have the
223      following form:
225           Leap  YEAR  MONTH  DAY  HH:MM:SS  CORR  R/S
227      For example:
229           Leap  1974  Dec    31   23:59:60  +     S
231      The YEAR, MONTH, DAY, and HH:MM:SS fields tell when the leap
232      second happened.  The CORR field should be "+" if a second
233      was added or "-" if a second was skipped.  The R/S field
234      should be (an abbreviation of) "Stationary" if the leap
235      second time given by the other fields should be interpreted
236      as UTC or (an abbreviation of) "Rolling" if the leap second
237      time given by the other fields should be interpreted as
238      local wall clock time.
240 NOTES
241      For areas with more than two types of local time, you may
242      need to use local standard time in the AT field of the
243      earliest transition time's rule to ensure that the earliest
244      transition time recorded in the compiled file is correct.
246      If, for a particular zone, a clock advance caused by the
247      start of daylight saving coincides with and is equal to a
248      clock retreat caused by a change in UTC offset, zic produces
249      a single transition to daylight saving at the new UTC offset
250      (without any change in wall clock time).  To get separate
251      transitions use multiple zone continuation lines specifying
252      transition instants using universal time.
254 FILE
255      /usr/local/etc/zoneinfo standard directory used for created
256      files
258 SEE ALSO
259      newctime(3), tzfile(5), zdump(8)