usr.sbin/zic/zic.8

   1 .\" $FreeBSD: src/usr.sbin/zic/zic.8,v 1.11.2.4 2003/03/11 22:31:35 trhodes Exp $
   2 .\" $DragonFly: src/usr.sbin/zic/zic.8,v 1.5 2008/10/19 20:15:58 swildner Exp $
   3 .Dd March 22, 2010
   4 .Dt ZIC 8
   5 .Os
   6 .Sh NAME
   7 .Nm zic
   8 .Nd timezone compiler
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl Dsv
  12 .Op Fl d Ar directory
  13 .Op Fl g Ar group
  14 .Op Fl L Ar leapsecondfilename
  15 .Op Fl l Ar localtime
  16 .Op Fl m Ar mode
  17 .Op Fl p Ar posixrules
  18 .Op Fl u Ar user
  19 .Op Fl y Ar command
  20 .Op Ar filename ...
  21 .Sh DESCRIPTION
  22 The
  23 .Nm
  24 utility reads text from the file(s) named on the command line
  25 and creates the time conversion information files specified in this input.
  26 If a
  27 .Ar filename
  28 is
  29 .Em - ,
  30 the standard input is read.
  31 .Pp
  32 The following options are available:
  33 .Bl -tag -width indent
  34 .It Fl D
  35 Do not automatically create directories.  If the input file(s) specify
  36 an output file in a directory which does not already exist, the
  37 default behavior is to attempt to create the directory.  If
  38 .Fl D
  39 is specified,
  40 .Nm
  41 will instead error out immediately.
  42 .It Fl d Ar directory
  43 Create time conversion information files in the named directory rather than
  44 in the standard directory named below.
  45 .It Fl g Ar group
  46 After creating each output file, change its group ownership to the
  47 specified
  48 .Ar group
  49 (which can be either a name or a numeric group ID).
  50 .It Fl L Ar leapsecondfilename
  51 Read leap second information from the file with the given name.
  52 If this option is not used,
  53 no leap second information appears in output files.
  54 .It Fl l Ar timezone
  55 Use the given
  56 .Ar time zone
  57 as local time.
  58 The
  59 .Nm
  60 utility will act as if the input contained a link line of the form
  61 .Bd -literal -offset indent
  62 .No "Link       timezone                localtime"
  63 .Ed
  64 (Note that this action has no effect on
  65 .Dx ,
  66 since the local time zone is specified in
  67 .Pa /etc/localtime
  68 and not
  69 .Pa /usr/share/zoneinfo/localtime . )
  70 .It Fl m Ar mode
  71 After creating each output file, change its access mode to
  72 .Ar mode .
  73 Both numeric and alphabetic modes are accepted
  74 (see
  75 .Xr chmod 1 ) .
  76 .It Fl p Ar timezone
  77 Use the given
  78 .Ar "time zone" Ns 's
  79 rules when handling POSIX-format
  80 time zone environment variables.
  81 The
  82 .Nm
  83 utility will act as if the input contained a link line of the form
  84 .Bd -literal -offset indent
  85 .No "Link       timezone                posixrules"
  86 .Ed
  87 .It Fl u Ar user
  88 After creating each output file, change its owner to
  89 .Ar user
  90 (which can be either a name or a numeric user ID).
  91 .It Fl v
  92 Complain if a year that appears in a data file is outside the range
  93 of years representable by
  94 .Xr time 3
  95 values.
  96 Also complain if a time of 24:00
  97 (which cannot be handled by pre-1998 versions of
  98 .Nm )
  99 appears in the input.
 100 .It Fl s
 101 Limit time values stored in output files to values that are the same
 102 whether they're taken to be signed or unsigned.
 103 You can use this option to generate SVVS-compatible files.
 104 .It Fl y Ar command
 105 Use the given
 106 .Ar command
 107 rather than
 108 .Em yearistype
 109 when checking year types (see below).
 110 .El
 111 .Pp
 112 Input lines are made up of fields.
 113 Fields are separated from one another by any number of white space characters.
 114 Leading and trailing white space on input lines is ignored.
 115 An unquoted sharp character (#) in the input introduces a comment which extends
 116 to the end of the line the sharp character appears on.
 117 White space characters and sharp characters may be enclosed in double quotes
 118 (") if they're to be used as part of a field.
 119 Any line that is blank (after comment stripping) is ignored.
 120 Non-blank lines are expected to be of one of three types:
 121 rule lines, zone lines, and link lines.
 122 .Pp
 123 Names (such as month names) must be in English and are case insensitive.
 124 Abbreviations, if used, must be unambiguous in context.
 125 .Pp
 126 A rule line has the form:
 127 .Dl "Rule       NAME    FROM    TO      TYPE    IN      ON              AT      SAVE    LETTER/S"
 128 For example:
 129 .Dl "Rule       US      1967    1973    \-      Apr     lastSun 2:00    1:00    D"
 130 .Pp
 131 The fields that make up a rule line are:
 132 .Bl -tag -width "LETTER/S" -offset indent
 133 .It NAME
 134 Give the (arbitrary) name of the set of rules this rule is part of.
 135 .It FROM
 136 Give the first year in which the rule applies.
 137 Any integer year can be supplied; the Gregorian calendar is assumed.
 138 The word
 139 .Em minimum
 140 (or an abbreviation) means the minimum year representable as an integer.
 141 The word
 142 .Em maximum
 143 (or an abbreviation) means the maximum year representable as an integer.
 144 Rules can describe times that are not representable as time values,
 145 with the unrepresentable times ignored; this allows rules to be portable
 146 among hosts with differing time value types.
 147 .It TO
 148 Give the final year in which the rule applies.
 149 In addition to
 150 .Em minimum
 151 and
 152 .Em maximum
 153 (as above),
 154 the word
 155 .Em only
 156 (or an abbreviation)
 157 may be used to repeat the value of the
 158 .Em FROM
 159 field.
 160 .It TYPE
 161 Give the type of year in which the rule applies.
 162 If
 163 .Em TYPE
 164 is
 165 .Em \-
 166 then the rule applies in all years between
 167 .Em FROM
 168 and
 169 .Em TO
 170 inclusive.
 171 If
 172 .Em TYPE
 173 is something else, then
 174 .Nm
 175 executes the command
 176 .Li yearistype Ar year Ar type
 177 to check the type of a year:
 178 an exit status of zero is taken to mean that the year is of the given type;
 179 an exit status of one is taken to mean that the year is not of the given type.
 180 .It IN
 181 Name the month in which the rule takes effect.
 182 Month names may be abbreviated.
 183 .It ON
 184 Give the day on which the rule takes effect.
 185 Recognized forms include:
 186 .Pp
 187 .Bl -tag -width lastSun -compact -offset indent
 188 .It \&5
 189 the fifth of the month
 190 .It lastSun
 191 the last Sunday in the month
 192 .It lastMon
 193 the last Monday in the month
 194 .It Sun>=8
 195 first Sunday on or after the eighth
 196 .It Sun<=25
 197 last Sunday on or before the 25th
 198 .El
 199 .Pp
 200 Names of days of the week may be abbreviated or spelled out in full.
 201 Note that there must be no spaces within the
 202 .Em ON
 203 field.
 204 .It AT
 205 Give the time of day at which the rule takes effect.
 206 Recognized forms include:
 207 .Pp
 208 .Bl -tag -width "\&1:28:14" -offset indent -compact
 209 .It 2
 210 time in hours
 211 .It 2:00
 212 time in hours and minutes
 213 .It 15:00
 214 24-hour format time (for times after noon)
 215 .It 1:28:14
 216 time in hours, minutes, and seconds
 217 .It -
 218 equivalent to 0
 219 .El
 220 .Pp
 221 where hour 0 is midnight at the start of the day,
 222 and hour 24 is midnight at the end of the day.
 223 Any of these forms may be followed by the letter
 224 .Sq Li w
 225 if the given time is local
 226 .Dq "wall clock"
 227 time,
 228 .Sq Li s
 229 if the given time is local
 230 .Dq standard
 231 time, or
 232 .Sq Li u
 233 (or
 234 .Sq Li g
 235 or
 236 .Sq Li z )
 237 if the given time is universal time;
 238 in the absence of an indicator,
 239 wall clock time is assumed.
 240 .It SAVE
 241 Give the amount of time to be added to local standard time when the rule is in
 242 effect.
 243 This field has the same format as the
 244 .Em AT
 245 field
 246 (although, of course, the
 247 .Sq Li w
 248 and
 249 .Sq Li s
 250 suffixes are not used).
 251 .It LETTER/S
 252 Give the
 253 .Dq "variable part"
 254 (for example, the
 255 .Dq S
 256 or
 257 .Dq D
 258 in
 259 .Dq EST
 260 or
 261 .Dq EDT )
 262 of time zone abbreviations to be used when this rule is in effect.
 263 If this field is
 264 .Em \- ,
 265 the variable part is null.
 266 .El
 267 .Pp
 268 A zone line has the form:
 269 .Dl "Zone       NAME    GMTOFF  RULES/SAVE      FORMAT  [UNTILYEAR [MONTH [DAY [TIME]]]]"
 270 For example:
 271 .Dl "Zone       Australia/Adelaide      9:30    Aus     CST     1971 Oct 31 2:00"
 272 The fields that make up a zone line are:
 273 .Bl -tag -width indent
 274 .It NAME
 275 The name of the time zone.
 276 This is the name used in creating the time conversion information file for the
 277 zone.
 278 .It GMTOFF
 279 The amount of time to add to UTC to get standard time in this zone.
 280 This field has the same format as the
 281 .Em AT
 282 and
 283 .Em SAVE
 284 fields of rule lines;
 285 begin the field with a minus sign if time must be subtracted from UTC.
 286 .It RULES/SAVE
 287 The name of the rule(s) that apply in the time zone or,
 288 alternately, an amount of time to add to local standard time.
 289 If this field is
 290 .Em \-
 291 then standard time always applies in the time zone.
 292 .It FORMAT
 293 The format for time zone abbreviations in this time zone.
 294 The pair of characters
 295 .Em %s
 296 is used to show where the
 297 .Dq "variable part"
 298 of the time zone abbreviation goes.
 299 Alternately,
 300 a slash (/)
 301 separates standard and daylight abbreviations.
 302 .It UNTILYEAR [MONTH [DAY [TIME]]]
 303 The time at which the UTC offset or the rule(s) change for a location.
 304 It is specified as a year, a month, a day, and a time of day.
 305 If this is specified,
 306 the time zone information is generated from the given UTC offset
 307 and rule change until the time specified.
 308 The month, day, and time of day have the same format as the IN, ON, and AT
 309 fields of a rule; trailing fields can be omitted, and default to the
 310 earliest possible value for the missing fields.
 311 .Pp
 312 The next line must be a
 313 .Dq continuation
 314 line; this has the same form as a zone line except that the
 315 string
 316 .Dq Zone
 317 and the name are omitted, as the continuation line will
 318 place information starting at the time specified as the
 319 .Dq until
 320 information in the previous line in the file used by the previous line.
 321 Continuation lines may contain
 322 .Dq until
 323 information, just as zone lines do, indicating that the next line is a further
 324 continuation.
 325 .El
 326 .Pp
 327 A link line has the form
 328 .Dl "Link       LINK-FROM       LINK-TO"
 329 For example:
 330 .Dl "Link       Europe/Istanbul Asia/Istanbul"
 331 The
 332 .Em LINK-FROM
 333 field should appear as the
 334 .Em NAME
 335 field in some zone line;
 336 the
 337 .Em LINK-TO
 338 field is used as an alternate name for that zone.
 339 .Pp
 340 Except for continuation lines,
 341 lines may appear in any order in the input.
 342 .Pp
 343 Lines in the file that describes leap seconds have the following form:
 344 .Dl "Leap       YEAR    MONTH   DAY     HH:MM:SS        CORR    R/S"
 345 For example:
 346 .Dl "Leap       1974    Dec     31      23:59:60        +       S"
 347 The
 348 .Em YEAR ,
 349 .Em MONTH ,
 350 .Em DAY ,
 351 and
 352 .Em HH:MM:SS
 353 fields tell when the leap second happened.
 354 The
 355 .Em CORR
 356 field
 357 should be
 358 .Dq +
 359 if a second was added
 360 or
 361 .Dq -
 362 if a second was skipped.
 363 .\" There's no need to document the following, since it's impossible for more
 364 .\" than one leap second to be inserted or deleted at a time.
 365 .\" The C Standard is in error in suggesting the possibility.
 366 .\" See Terry J Quinn, The BIPM and the accurate measure of time,
 367 .\" Proc IEEE 79, 7 (July 1991), 894-905.
 368 .\"     or
 369 .\"     .q ++
 370 .\"     if two seconds were added
 371 .\"     or
 372 .\"     .q --
 373 .\"     if two seconds were skipped.
 374 The
 375 .Em R/S
 376 field
 377 should be (an abbreviation of)
 378 .Dq Stationary
 379 if the leap second time given by the other fields should be interpreted as UTC
 380 or
 381 (an abbreviation of)
 382 .Dq Rolling
 383 if the leap second time given by the other fields should be interpreted as
 384 local wall clock time.
 385 .Sh "EXTENDED EXAMPLE"
 386 Here is an extended example of
 387 .Nm
 388 input, intended to illustrate many of its features.
 389 .Bd -literal
 390 # Rule  NAME    FROM    TO      TYPE    IN      ON      AT      SAVE    LETTER/S
 391 Rule    Swiss   1940    only    -       Nov     2       0:00    1:00    S
 392 Rule    Swiss   1940    only    -       Dec     31      0:00    0       -
 393 Rule    Swiss   1941    1942    -       May     Sun>=1  2:00    1:00    S
 394 Rule    Swiss   1941    1942    -       Oct     Sun>=1  0:00    0
 395
 396 Rule    EU      1977    1980    -       Apr     Sun>=1  1:00u   1:00    S
 397 Rule    EU      1977    only    -       Sep     lastSun 1:00u   0       -
 398 Rule    EU      1978    only    -       Oct      1      1:00u   0       -
 399 Rule    EU      1979    1995    -       Sep     lastSun 1:00u   0       -
 400 Rule    EU      1981    max     -       Mar     lastSun 1:00u   1:00    S
 401 Rule    EU      1996    max     -       Oct     lastSun 1:00u   0       -
 402
 403 # Zone  NAME    GMTOFF  RULES   FORMAT  UNTIL
 404 Zone    Europe/Zurich   0:34:08 -       LMT     1848 Sep 12
 405                 0:29:44 -       BMT     1894 Jun
 406                 1:00    Swiss   CE%sT   1981
 407                 1:00    EU      CE%sT
 408
 409 Link    Europe/Zurich   Switzerland
 410 .Ed
 411 .Pp
 412 In this example, the zone is named Europe/Zurich but it has an alias
 413 as Switzerland.
 414 Zurich was 34 minutes and 8 seconds west of GMT until
 415 1848-09-12 at 00:00, when the offset changed to 29 minutes and 44
 416 seconds.
 417 After 1894-06-01 at 00:00 Swiss daylight saving rules (defined
 418 with lines beginning with
 419 .Dq Rule Swiss )
 420 apply, and the GMT offset became one hour.
 421 From 1981 to the present, EU daylight saving rules have
 422 applied, and the UTC offset has remained at one hour.
 423 .Pp
 424 In 1940, daylight saving time applied from November 2 at 00:00 to
 425 December 31 at 00:00.
 426 In 1941 and 1942, daylight saving time applied
 427 from the first Sunday in May at 02:00 to the first Sunday in October
 428 at 00:00.
 429 The pre-1981 EU daylight-saving rules have no effect
 430 here, but are included for completeness.
 431 Since 1981, daylight
 432 saving has begun on the last Sunday in March at 01:00 UTC.
 433 Until 1995 it ended the last Sunday in September at 01:00 UTC,
 434 but this changed to the last Sunday in October starting in 1996.
 435 .Pp
 436 For purposes of
 437 display,
 438 .Dq LMT
 439 and
 440 .Dq BMT
 441 were initially used, respectively.
 442 Since
 443 Swiss rules and later EU rules were applied, the display name for the
 444 timezone has been CET for standard time and CEST for daylight saving
 445 time.
 446 .Sh NOTES
 447 For areas with more than two types of local time,
 448 you may need to use local standard time in the
 449 .Em AT
 450 field of the earliest transition time's rule to ensure that
 451 the earliest transition time recorded in the compiled file is correct.
 452 .Pp
 453 If,
 454 for a particular zone,
 455 a clock advance caused by the start of daylight saving
 456 coincides with and is equal to
 457 a clock retreat caused by a change in UTC offset,
 458 .Nm
 459 produces a single transition to daylight saving at the new UTC offset
 460 (without any change in wall clock time).
 461 To get separate transitions
 462 use multiple zone continuation lines
 463 specifying transition instants using universal time.
 464 .Sh FILES
 465 .Bl -tag -width ".Pa /usr/share/zoneinfo" -compact
 466 .It Pa /usr/share/zoneinfo
 467 standard directory used for created files
 468 .El
 469 .Sh "SEE ALSO"
 470 .Xr ctime 3 ,
 471 .Xr tzfile 5 ,
 472 .Xr zdump 8
 473 .\" @(#)zic.8   8.6