contrib/tzcode/zic/README

   1 @(#)README      8.3
   2 This file is in the public domain, so clarified as of
   3 2009-05-17 by Arthur David Olson.
   4
   5 $FreeBSD$
   6
   7 "What time is it?" -- Richard Deacon as The King
   8 "Any time you want it to be." -- Frank Baxter as The Scientist
   9                                         (from the Bell System film "About Time")
  10
  11 The 1989 update of the time zone package featured
  12
  13 *       POSIXization (including interpretation of POSIX-style TZ environment
  14         variables, provided by Guy Harris),
  15 *       ANSIfication (including versions of "mktime" and "difftime"),
  16 *       SVIDulation (an "altzone" variable)
  17 *       MACHination (the "gtime" function)
  18 *       corrections to some time zone data (including corrections to the rules
  19         for Great Britain and New Zealand)
  20 *       reference data from the United States Naval Observatory for folks who
  21         want to do additional time zones
  22 *       and the 1989 data for Saudi Arabia.
  23
  24 (Since this code will be treated as "part of the implementation" in some places
  25 and as "part of the application" in others, there's no good way to name
  26 functions, such as timegm, that are not part of the proposed ANSI C standard;
  27 such functions have kept their old, underscore-free names in this update.)
  28
  29 And the "dysize" function has disappeared; it was present to allow compilation
  30 of the "date" command on old BSD systems, and a version of "date" is now
  31 provided in the package.  The "date" command is not created when you "make all"
  32 since it may lack options provided by the version distributed with your
  33 operating system, or may not interact with the system in the same way the
  34 native version does.
  35
  36 Since POSIX frowns on correct leap second handling, the default behavior of
  37 the "zic" command (in the absence of a "-L" option) has been changed to omit
  38 leap second information from its output files.
  39
  40 Here is a recipe for acquiring, building, installing, and testing the
  41 tz distribution on a GNU/Linux or similar host.
  42
  43         mkdir tz
  44         cd tz
  45         wget 'ftp://elsie.nci.nih.gov/pub/tz*.tar.gz'
  46         gzip -dc tzcode*.tar.gz | tar -xf -
  47         gzip -dc tzdata*.tar.gz | tar -xf -
  48
  49 Be sure to read the comments in "Makefile" and make any changes needed
  50 to make things right for your system, especially if you are using some
  51 platform other than GNU/Linux.  Then run the following commands,
  52 substituting your desired installation directory for "$HOME/tzdir":
  53
  54         make TOPDIR=$HOME/tzdir install
  55         $HOME/tzdir/etc/zdump -v America/Los_Angeles
  56
  57 To use the new functions, use a "-ltz" option when compiling or linking.
  58
  59 Historical local time information has been included here to:
  60
  61 *       provide a compendium of data about the history of civil time
  62         that is useful even if the data are not 100% accurate;
  63
  64 *       give an idea of the variety of local time rules that have
  65         existed in the past and thus an idea of the variety that may be
  66         expected in the future;
  67
  68 *       provide a test of the generality of the local time rule description
  69         system.
  70
  71 The information in the time zone data files is by no means authoritative;
  72 the files currently do not even attempt to cover all time stamps before
  73 1970, and there are undoubtedly errors even for time stamps since 1970.
  74 If you know that the rules are different from those in a file, by all means
  75 feel free to change file (and please send the changed version to
  76 tz@elsie.nci.nih.gov for use in the future).  Europeans take note!
  77
  78 Thanks to these Timezone Caballeros who've made major contributions to the
  79 time conversion package:  Keith Bostic; Bob Devine; Paul Eggert; Robert Elz;
  80 Guy Harris; Mark Horton; John Mackin; and Bradley White.  Thanks also to
  81 Michael Bloom, Art Neilson, Stephen Prince, John Sovereign, and Frank Wales
  82 for testing work, and to Gwillim Law for checking local mean time data.
  83 None of them are responsible for remaining errors.
  84
  85 Look in the ~ftp/pub directory of elsie.nci.nih.gov
  86 for updated versions of these files.
  87
  88 Please send comments or information to tz@elsie.nci.nih.gov.