From: Harlan Stenn Date: Mon, 13 Dec 2010 06:06:37 +0000 (-0500) Subject: SNTP documentation cleanup X-Git-Tag: NTP_4_2_7P94~7^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e547cad2b9aabb75348087178496793e3ef73e30;p=thirdparty%2Fntp.git SNTP documentation cleanup bk: 4d05b7edVYhiVScLEPcxPclnxW8aag --- diff --git a/sntp/Makefile.am b/sntp/Makefile.am index 39995019e..4bcc0e3b4 100644 --- a/sntp/Makefile.am +++ b/sntp/Makefile.am @@ -82,6 +82,10 @@ BUILT_SOURCES= \ man_MANS= $(srcdir)/sntp.1 +# HMS: Real Soon Now... +#info_TEXINFOS= sntp.texi +#sntp_TEXINFOS= sntp-opts.texi + noinst_DATA= \ $(srcdir)/sntp.html \ $(srcdir)/sntp-opts.texi \ diff --git a/sntp/sntp.html b/sntp/sntp.html index fa2455909..5aa1d6f53 100644 --- a/sntp/sntp.html +++ b/sntp/sntp.html @@ -38,7 +38,7 @@ well. It can be run as an interactive command or from a cron job.

This document applies to version 4.2.6p3-RC11 of 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.

@@ -50,15 +50,13 @@ IETF specification.

-Next: , -Previous: Top, -Up: Top +
@@ -73,11 +71,299 @@ 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. -

-Previous: sntp Description, -Up: Top + +
+
+ +

Invoking sntp

+ +

This program has no explanation. + +

.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. + +

NTP and SNTP are defined by RFC 5905, which +obsoletes RFC 4330 and RFC 1305. + +

This section was generated by AutoGen, +the aginfo template and the option descriptions for the sntp program. It documents the sntp usage text and option meanings. + +

This software is released under a specialized copyright license. + +

+ +
+

+Next: , +Up: sntp Invocation +
+
+ +

sntp usage help (-?)

+ +

+This is the automatically generated usage text for sntp: + +

sntp is unavailable - no --help
+
+
+

+Next: , +Previous: sntp usage, +Up: sntp Invocation +
+
+ +

adjtime option (-j)

+ +

+This is the “set (slew) the time with adjtime()” option. + +

This option has some usage constraints. It: +

+ +
+

+Next: , +Previous: sntp adjtime, +Up: sntp Invocation +
+
+ +

authentication option (-a)

+ +

+This is the “enable authentication with the key auth-keynumber” option. +This option enables authentication using the key specified in this option's argument. +The argument of this option is the keyid, a number specified in the keyfile as this +key's identifier. See the keyfile option (-k) for more details. + +

+

+Next: , +Previous: sntp authentication, +Up: sntp Invocation +
+
+ +

broadcast option (-b)

+ +

+This is the “use broadcasts to the address specified for synchronisation” option. +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. + +

+

+Next: , +Previous: sntp broadcast, +Up: sntp Invocation +
+
+ +

filelog option (-l)

+ +

+This is the “log to specified logfile” option. + +

This option has some usage constraints. It: +

+ +

This option causes the client to write log messages to the specified +logfile. + +

+

+Next: , +Previous: sntp filelog, +Up: sntp Invocation +
+
+ +

ipv4 option (-4)

+ +

+This is the “force ipv4 dns name resolution” option. + +

This option has some usage constraints. It: +

+ +

Force DNS resolution of following host names on the command line +to the IPv4 namespace. + +

+

+Next: , +Previous: sntp ipv4, +Up: sntp Invocation +
+
+ +

ipv6 option (-6)

+ +

+This is the “force ipv6 dns name resolution” option. + +

This option has some usage constraints. It: +

+ +

Force DNS resolution of following host names on the command line +to the IPv6 namespace. + +

+

+Next: , +Previous: sntp ipv6, +Up: sntp Invocation +
+
+ +

keyfile option (-k)

+ +

+This is the “specify a keyfile. sntp will look in this file for the key specified with -a” option. +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 +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. +A Key in a 1-to-8 character ASCII string. +M Key in a 1-to-8 character ASCII string using the MD5 authentication scheme. + +

For more information see ntp.keys(5). + +

+

+Next: , +Previous: sntp keyfile, +Up: sntp Invocation +
+
+ +

kod option (-K)

+ +

+This is the “kod history filename” option. +Modifies the filename to be used to persist the history of KoD +responses received from servers. The default is +/var/db/ntp-kod. + +

+

+Next: , +Previous: sntp kod, +Up: sntp Invocation +
+
+ +

normalverbose option (-d)

+ +

+This is the “normal verbose” option. +Diagnostic messages for non-fatal errors and a limited amount of +tracing should be written to standard error. Fatal ones always +produce a diagnostic. This option should be set when there is a +suspected problem with the server, network or the source. + +

+

+Next: , +Previous: sntp normalverbose, +Up: sntp Invocation +
+
+ +

settod option (-s)

+ +

+This is the “set (step) the time with settimeofday()” option. + +

This option has some usage constraints. It: +

+ +
+

+Next: , +Previous: sntp settod, +Up: sntp Invocation +
+
+ +

syslog option (-p)

+ +

+This is the “logging with syslog” option. + +

This option has some usage constraints. It: +

+ +

When this option is set all logging will be done using syslog. + +

+

+Previous: sntp syslog, +Up: sntp Invocation +
+
+ +

timeout option (-t)

+ +

+This is the “specify the number of seconds to wait for broadcasts” option. +When waiting for a broadcast packet SNTP will wait the number +of seconds specified before giving up. Default 68 seconds. + +

+

+
@@ -88,14 +374,14 @@ Up: Top check the current time, offset, and error in the local clock. For example: -
     sntp ntpserver.somewhere
+
    sntp ntpserver.somewhere
 

   
With suitable privilege, it can be run as a command or in a
 crom job to reset the local clock from a reliable server, like
 the ntpdate and rdate commands. 
 For example:
 
-
     sntp -a ntpserver.somewhere
+
    sntp -a ntpserver.somewhere
 

   
 
diff --git a/sntp/sntp.texi b/sntp/sntp.texi
index f24b6a49f..482cf1eb0 100644
--- a/sntp/sntp.texi
+++ b/sntp/sntp.texi
@@ -46,7 +46,7 @@ IETF specification.
 * Usage::                       Usage
 @end menu
 
-@node sntp Description, sntp Invocation, Top, Top
+@node sntp Description
 @comment  node-name,  next,  previous,  up
 @section Description
 
@@ -62,7 +62,7 @@ error bound of the system clock relative to the server clock.
 
 @include sntp-opts.texi
 
-@node Usage,  , sntp Invocation, Top
+@node Usage
 @comment  node-name,  next,  previous,  up
 @section Usage