home *** CD-ROM | disk | FTP | other *** search
/ nisttime.carsoncity.k12.mi.us / nisttime.carsoncity.k12.mi.us.tar / nisttime.carsoncity.k12.mi.us / pub / daytime / nistimen.man < prev    next >
Text File  |  1996-11-18  |  7KB  |  193 lines
  1. Name
  2.    nistimen.exe -- compare the time of the PC clock with the NIST 
  3.            internet time server. 
  4.            This version is for PCs which have the PC/TCP 
  5.            Network software.
  6.  
  7. Syntax
  8.    nistimen  [ options ]
  9.  
  10. Description
  11.    This program connects to the NIST internet time server named 
  12.    time_a.timefreq.bldrdoc.gov using tcp/ip port 13.  The time
  13.    server responds with a packet containing the time in a format
  14.    similar to that used by the NIST Automated Computer Time Service
  15.    (ACTS).  The received time is compared with the time of the local 
  16.    clock, and the difference may be used to correct the local DOS clock.
  17.    If the -c option is specified, the time of the CMOS battery clock 
  18.    can also be checked and set. 
  19.  
  20.    This version requires the PC/TCP kernel to send and receive messages,
  21.    and this software must be present and running before the nistimen 
  22.    program can be used.
  23.  
  24.  
  25.    The program may be called with the following options:
  26.  
  27.      (note that upper and lower case letters are distinct)
  28.  
  29.    -m0          Do not display the received time message.  The 
  30.         time difference between the DOS clock and NIST (in 
  31.         seconds) is written to the standard output.  A 
  32.         positive value for the difference means that the
  33.         the local clock is fast with respect to NIST.  The
  34.         -c option is ignored.
  35.  
  36.    -m1 or -M    Display short time messages.
  37.  
  38.    -m2          Display longer time messages including an explanation
  39.         of each parameter.
  40.  
  41.    -s0          Do not set the local clock.
  42.  
  43.    -s1 or -S    Set the local clock only if the server is healthy.
  44.  
  45.    -s2          Set the local clock even if the server is not healthy.
  46.  
  47.    -s3          Query operator before setting the clock. 
  48.  
  49.    -c or -C     A CMOS battery clock is present.  Its time will be
  50.         compared against NIST.  If a time set is requested,
  51.         this clock will be set too.
  52.  
  53.     If no options are used, the default is -M -s3: the program
  54. displays short time messages and will ask you before setting the
  55. clock.  The local clock will not be adjusted if the measured time 
  56. difference is 0.
  57.  
  58. Message Format
  59.  
  60.     The message received from NIST is shown below:
  61.  
  62.             D  L
  63.  MJD  YY MM DD HH MM SS ST S H  Adv.
  64. 49010 93-01-23 22:01:22 00 0 0  50.0 UTC(NIST) * 
  65.  
  66.  
  67. The heading is not part of the message and is shown only
  68. to identify the parameters.  The first number is the date 
  69. expressed as a Modified Julian Day number (MJD), and the next 
  70. 6 values give the Universal Coordinated date and time (formerly 
  71. called Greenwich Mean Time) as year, month, day, hour, minute and 
  72. second.
  73.  
  74.     The eighth number is the daylight saving time flag, DST.
  75. It is based on the continental US system, which has transitions on
  76. the first Sunday in April and the last Sunday in October.
  77.  
  78. DST =  0 means standard time is currently in effect.
  79. DST = 50 means daylight saving time is currently in effect.
  80. DST = 51 means the transition from standard time to daylight time is
  81.      at 2am local time today.
  82. DST =  1 means the transition from daylight time to standard time is
  83.      at 2am local time today.
  84.  
  85. DST > 51 gives advance notice of the number of days to the transition 
  86.      to daylight time.  The DST parameter is decremented at 0000 
  87.      every day during this advance notice period, and the transition
  88.      will occur when the parameter reaches 51 as discussed above.
  89.  
  90. 1 < DST < 50  gives advance notice of the number of days to the 
  91.           transition to standard time.  The DST parameter is 
  92.           decremented at 0000 every day during this advance 
  93.           notice period, and the transition will occur when the
  94.           parameter reaches 1 as discussed above.
  95.  
  96.     The DST parameter is not used by this version of the program,
  97.     which uses Universal Time and the locally defined time zone
  98.     parameter both to check the clock and to set it if necessary 
  99.     (see the installation information below). 
  100.  
  101.     The next number is the leap second flag, LS.
  102.  
  103. LS = 0 means no leap second is scheduled.
  104.  
  105. LS = 1 means that a leap second is to be added as 23:59:60 on the
  106.        last day of the current month.  The last minute will therefore
  107.        be 61 seconds long. Leap seconds are usually added at the end
  108.        of either June or December.
  109.  
  110. LS = 2 means that second 23:59:59 is to be dropped on the last day of 
  111.        the current month.  The second following 23:59:58 will be 00:00:00
  112.        of the next day.  This minute will therefore be 59 seconds 
  113.        long.  This situation is unlikely to be necessary in the
  114.        foreseeable future.
  115.  
  116.     Note that leap seconds are inserted or deleted at the specified
  117. Universal Times, while daylight savings transitions are always with
  118. respect to local time.
  119.     
  120.     The health parameter, H, gives the health of the server:
  121.  
  122. H = 0 means that the server is healthy.
  123.  
  124. H = 1 means that the server is operating properly but that its
  125.       time may be in error by up to 5 seconds. This state should
  126.       change to fully healthy within 10 minutes.
  127.  
  128. H = 2 means that the server is operating properly but that its
  129.       time is known to be wrong by more than 5 seconds.  
  130.  
  131. H = 3 means that the hardware or software have failed and that the
  132.       time error is unknown.
  133.  
  134.     The advance parameter, ADV, gives the time advance of the
  135. transmissions, in milliseconds.  Each time packet is sent out early
  136. by this amount to compensate (approximately) for the network delay.
  137.  
  138.     The remaining characters on the line identify the time 
  139. source and are included for compatibility with the ACTS time
  140. system.
  141.  
  142. Installation
  143.  
  144.     The program may be installed in any directory and may be
  145.     run either by a keyboard command or from a batch file.
  146.  
  147.     This program uses an environmental parameter named TZ 
  148.     (for time-zone) to convert from the universal time received 
  149.     from NIST to the local time of the user.  You must set this
  150.     parameter in your environment, and this easiest way to do
  151.     this is to add a line to your autoexec.bat file so that TZ
  152.     is set whenver the computer is started.  Here are some
  153.     examples of how to do this:
  154.  
  155.     If your time zone is --                  use this line --
  156.     Eastern time with daylight saving time:      set TZ = est5edt  
  157.     Central time with daylight saving time:      set TZ = cst6cdt
  158.     Mountain time with daylight saving time:     set TZ = mst7mdt
  159.     Pacific time with daylight saving time:      set TZ = pst8pdt
  160.     
  161.     etc.
  162.  
  163.     In each case, the first 3 letters are the abbreviation for
  164.     the local time zone, the digit specifies the number of 
  165.     hours to subtract from universal time to get local standard
  166.     time, and the last three letters specify that daylight 
  167.     saving time is observed using the standard US model.  If
  168.     your area does not follow daylight saving time, then you
  169.     should omit the last three letters. For example:
  170.  
  171.     Mountain time without daylight saving time:  set TZ = mst7
  172.     
  173. Restrictions
  174.  
  175.     This program uses the PC/TCP kernel to interface to 
  176.     the internet and this software must be running before
  177.     nistimen is called.
  178.  
  179. Bugs
  180.  
  181.     This version does not estimate the transmission delay 
  182.     in the network.  This is unlikely to be a limitation
  183.     since the DOS clock can only be set or read to +/- 55 msec
  184.     and the CMOS battery clock can only be read to the nearest
  185.     second.  
  186.  
  187. Files
  188.     nistimen.exe            Compiled and linked version of the program.
  189.     nistimen.man            This document.
  190.  
  191.  
  192. Last Modified: 2 June 1993
  193.