Return to sntp.texi CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / ntp / sntp

Annotation of embedaddon/ntp/sntp/sntp.texi, revision 1.1.1.1

1.1       misho       1: \input texinfo    @c -*-texinfo-*-
                      2: @c %**start of header
                      3: @setfilename sntp.info
                      4: @settitle Sntp User's Manual
                      5: @include version.texi
                      6: @paragraphindent 2
                      7: @c %**end of header
                      8: 
                      9: @ifinfo
                     10: This file documents the use of the NTP Project's SNTP, a program for
                     11: querying and setting the time.
                     12: @end ifinfo
                     13: 
                     14: @direntry
                     15: * sntp: (sntp).                               Simple Network Time Protocol
                     16: @end direntry
                     17: 
                     18: @titlepage
                     19: @title Simple Network Time Protocol User's Manual
                     20: @subtitle sntp, version @value{VERSION}, @value{UPDATED}
                     21: @c @author Max @email{foo@ntp.org}
                     22: @end titlepage
                     23: 
                     24: @c @page
                     25: @c @vskip 0pt plus 1filll
                     26: 
                     27: @node Top, sntp Description, (dir), (dir)
                     28: @top Simple Network Time Protocol User Manual
                     29: 
                     30: This document describes the use of the NTP Project's @code{sntp} program,
                     31: that can be used to query a Network Time Protocol (NTP) server and
                     32: display the time offset of the system clock relative to the server
                     33: clock.  Run as root, it can correct the system clock to this offset as
                     34: well.  It can be run as an interactive command or from a cron job.
                     35: 
                     36: This document applies to version @value{VERSION} of @code{sntp}.
                     37: 
                     38: The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
                     39: IETF specification.
                     40: 
                     41: @shortcontents
                     42: 
                     43: @menu
                     44: * sntp Description::            Description
                     45: * sntp Invocation::            Invoking sntp
                     46: * Usage::                       Usage
                     47: @end menu
                     48: 
                     49: @node sntp Description
                     50: @comment  node-name,  next,  previous,  up
                     51: @section Description
                     52: 
                     53: By default, @code{sntp} writes the local data and time (i.e., not UTC) to the
                     54: standard output in the format:
                     55: 
                     56: @example
                     57: 1996 Oct 15 20:17:25.123 +4.567 +/- 0.089 secs
                     58: @end example
                     59: 
                     60: where the +4.567 +/- 0.089 secs indicates the time offset and
                     61: error bound of the system clock relative to the server clock.
                     62: 
                     63: @include sntp-opts.texi
                     64: 
                     65: @node Usage
                     66: @comment  node-name,  next,  previous,  up
                     67: @section Usage
                     68: 
                     69: The simplest use of this program is as an unprivileged command to
                     70: check the current time, offset, and error in the local clock.
                     71: For example:
                     72: 
                     73: @example
                     74: sntp ntpserver.somewhere
                     75: @end example
                     76: 
                     77: With suitable privilege, it can be run as a command or in a
                     78: @code{crom} job to reset the local clock from a reliable server, like
                     79: the @code{ntpdate} and @code{rdate} commands.
                     80: For example:
                     81: 
                     82: @example
                     83: sntp -a ntpserver.somewhere
                     84: @end example