From: Harlan Stenn Date: Sat, 4 Dec 2010 10:32:55 +0000 (-0500) Subject: Clean up the SNTP documentation X-Git-Tag: NTP_4_2_7P89~2^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dd01321c03d23a32098422693f1bcadae1892b8f;p=thirdparty%2Fntp.git Clean up the SNTP documentation bk: 4cfa18d7pqUrkOLWqubF8pnoL0w7Nw --- diff --git a/ChangeLog b/ChangeLog index 3c9a6dfbd..be1731989 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,7 @@ * Clean up m4 quoting in configure.ac, *.m4 files, resolving intermittent AC_LANG_PROGRAM possibly undefined errors. +* Clean up the SNTP documentation. --- (4.2.6p3-RC11) 2010/11/28 Released by Harlan Stenn diff --git a/sntp/sntp-opts.def b/sntp/sntp-opts.def index 7309df705..b4a130f5f 100644 --- a/sntp/sntp-opts.def +++ b/sntp/sntp-opts.def @@ -76,14 +76,14 @@ flag = { flag = { - name = syslog; + name = syslog; value = p; flags-cant = filelog; descrip = "Logging with syslog"; doc = <<- _EndOfDoc_ When this option is set all logging will be done using syslog. _EndOfDoc_; -}; +}; flag = { name = filelog; @@ -94,7 +94,7 @@ flag = { descrip = "Log to specified logfile"; doc = <<- _EndOfDoc_ This option causes the client to write log messages to the specified - logfile. + logfile. _EndOfDoc_; }; @@ -117,12 +117,12 @@ flag = { }; flag = { - name = broadcast; - value = b; + name = broadcast; + value = b; descrip = "Use broadcasts to the address specified for synchronisation"; arg-type = string; arg-name = "broadcast-address"; - doc = <<- _EndOfDoc_ + doc = <<- _EndOfDoc_ If specified SNTP will listen to the specified broadcast address for NTP broadcasts. The default maximum wait time, 68 seconds, can be modified with -t. @@ -130,20 +130,20 @@ flag = { }; flag = { - name = timeout; - value = t; + name = timeout; + value = t; descrip = "Specify the number of seconds to wait for broadcasts"; arg-type = number; arg-name = "seconds"; arg-default = 68; doc = <<- _EndOfDoc_ - When waiting for a broadcast packet SNTP will wait the number + When waiting for a broadcast packet SNTP will wait the number of seconds specified before giving up. Default 68 seconds. _EndOfDoc_; }; flag = { - name = authentication; + name = authentication; value = a; descrip = "Enable authentication with the key auth-keynumber"; arg-type = number; @@ -156,18 +156,18 @@ flag = { }; flag = { - name = keyfile; + name = keyfile; value = k; descrip = "Specify a keyfile. SNTP will look in this file for the key specified with -a"; arg-type = string; arg-name = "file-name"; doc = <<- _EndOfDoc_ - This option specifies the keyfile. SNTP will search for the key specified with -a keyno in this + This option specifies the keyfile. SNTP will search for the key specified with -a keyno in this file. Key files follow the following format: keyid keytype key - Where keyid is a number identifying this key + Where keyid is a number identifying this key keytype is one of the follow: S Key in 64 Bit hexadecimal number as specified in in the DES specification. N Key in 64 Bit hexadecimal number as specified in the NTP standard. @@ -178,24 +178,16 @@ flag = { _EndOfDoc_; }; - - detail = <<- _END_DETAIL -.I sntp -implements the Simple Network Time Protocol, and is used -to query an NTP or SNTP server and either -display the time -or -set the local system's time (given suitable privilege). - -It can be -run interactively from the command line or as a -.I cron -job. +sntp implements the Simple Network Time Protocol, and is used to query +an NTP or SNTP server and either display the time or set the local +system's time (given suitable privilege). -NTP and SNTP are defined by RFC 5905, which -obsoletes RFC 4330 and RFC 1305. +It can be run interactively from the command line or as a cron job. + +NTP and SNTP are defined by RFC 5905, which obsoletes RFC 4330 and RFC +1305. _END_DETAIL; prog-man-descrip = <<- _END_PROG_MAN_DESCRIP @@ -224,6 +216,36 @@ is believed to be correct to within seconds. _END_PROG_MAN_DESCRIP; +prog-info-descrip = <<- _END_PROG_INFO_DESCRIP +@code{sntp} +can be used as a SNTP client to query a NTP or SNTP server and either display +the time or set the local system's time (given suitable privilege). It can be +run as an interactive command or in a +@code{cron} +job. + +NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol) +are defined and described by RFC 5905. + +@indent +The default is to write the estimated correct local date and time (i.e. not +UTC) to the standard output in a format like +@example +1996 Oct 15 20:17:25.123 +4.567 +/- 0.089 secs +@end example +where the +@example ++4.567 +/- 0.089 secs +@end example +indicates the local clock is 4.567 seconds behind the correct time +(so 4.567 seconds must be added to the local clock to get it to be correct), +and the time of +@code{1996 Oct 15 20:17:25.123} +is believed to be correct to within +@code{+/- 0.089} +seconds. + _END_PROG_INFO_DESCRIP; + man-doc = <<- _END_MAN_DOC .SH USAGE The simplest use of this program is as an unprivileged command to check the diff --git a/sntp/sntp.texi b/sntp/sntp.texi index b0d8a94e8..20303c550 100644 --- a/sntp/sntp.texi +++ b/sntp/sntp.texi @@ -35,7 +35,7 @@ well. It can be run as an interactive command or from a cron job. This document applies to version @value{VERSION} of @code{sntp}. -The program implements the SNTP protocol as defined by the draft NTPv4 +The program implements the SNTP protocol as defined by RFC 5905, the NTPv4 IETF specification. @shortcontents @@ -60,7 +60,7 @@ standard output in the format: where the +4.567 +/- 0.089 secs indicates the time offset and error bound of the system clock relative to the server clock. -@c @include sntp-opts.texi +@include sntp-opts.texi @node Usage, , sntp Description, Top @comment node-name, next, previous, up