From: Harlan Stenn Date: Tue, 28 Jan 2014 07:07:13 +0000 (+0000) Subject: [Bug 898] Documentation fixes X-Git-Tag: NTP_4_2_7P414~9 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7af5f1846b853dba27f40df158e2a9941518d314;p=thirdparty%2Fntp.git [Bug 898] Documentation fixes bk: 52e75721EviM_fFfPOdkDeKQXuzyGQ --- diff --git a/ChangeLog b/ChangeLog index 6520af51a..74d7d96d9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,5 @@ * [Bug 792] TrueTime TL-3 WWV refclock support. +* [Bug 898] Documentation fixes. * [Bug 2545] Cleanup of scripts/monitoring/ntptrap. (4.2.7p413) 2014/01/27 Released by Harlan Stenn * Require a version string for perl scripts that use autogen. diff --git a/html/ntpd.html b/html/ntpd.html index f7be20353..63d587c5e 100644 --- a/html/ntpd.html +++ b/html/ntpd.html @@ -33,6 +33,10 @@

The ntpd program normally operates continuously while adjusting the system time and frequency, but in some cases this might not be practical. With the -q option ntpd operates as in continuous mode, but exits just after setting the clock for the first time. Most applications will probably want to specify the iburst option with the server command. With this option a volley of messages is exchanged to groom the data and set the clock in about ten seconds. If nothing is heard after a few minutes, the daemon times out and exits without setting the clock.

Command Line Options

+
-4 +
Force DNS resolution of host names to the IPv4 namespace. +
-6 +
Force DNS resolution of host names to the IPv6 namespace.
-a
Require cryptographic authentication for broadcast client, multicast client and symmetric passive associations. This is the same operation as the enable auth command and is the default.
-A
@@ -46,7 +50,7 @@
-D level
Specify debugging level directly, with level corresponding to the numbe of -d options..
-f driftfile
-
Specify the name and path of the frequency file. This is the same operation as the driftfile command.
+
Specify the name and path of the frequency file. This is the same operation as the driftfile driftfile configuration command.
-g
Normally, ntpd exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that, ntpd will exit with a message to the system log. This option can be used with the -q and -x options. See the tinker command for other options.
-i jaildir
diff --git a/html/ntpdate.html b/html/ntpdate.html index 401c5cb46..8437d906a 100644 --- a/html/ntpdate.html +++ b/html/ntpdate.html @@ -17,9 +17,9 @@

Disclaimer: The functionality of this program is now available in the ntpd program. See the -q command line option in the ntpd - Network Time Protocol (NTP) daemon page. After a suitable period of mourning, the ntpdate program is to be retired from this distribution

Synopsis

-ntpdate [ -bBdoqsuv ] [ -a key ] [ -e authdelay ] [ -k keyfile ] [ -o version ] [ -p samples ] [ -t timeout ] server [ ... ] +ntpdate [ -46bBdqsuv ] [ -a key ] [ -e authdelay ] [ -k keyfile ] [ -o version ] [ -p samples ] [ -t timeout ] server [ ... ]

Description

-ntpdate sets the local date and time by polling the Network Time Protocol (NTP) server(s) given as the server arguments to determine the correct time. It must be run as root on the local host. A number of samples are obtained from each of the servers specified and a subset of the NTP clock filter and selection algorithms are applied to select the best of these. Note that the accuracy and reliability of ntpdate depends on the number of servers, the number of polls each time it is run and the interval between runs. +

ntpdate sets the local date and time by polling the Network Time Protocol (NTP) server(s) given as the server arguments to determine the correct time. It must be run as root on the local host. A number of samples are obtained from each of the servers specified and a subset of the NTP clock filter and selection algorithms are applied to select the best of these. Note that the accuracy and reliability of ntpdate depends on the number of servers, the number of polls each time it is run and the interval between runs.

ntpdate can be run manually as necessary to set the host clock, or it can be run from the host startup script to set the clock at boot time. This is useful in some cases to set the clock initially before starting the NTP daemon ntpd. It is also possible to run ntpdate from a cron script. However, it is important to note that ntpdate with contrived cron scripts is no substitute for the NTP daemon, which uses sophisticated algorithms to maximize accuracy and reliability while minimizing resource use. Finally, since ntpdate does not discipline the host clock frequency as does ntpd, the accuracy using ntpdate is limited.

Time adjustments are made by ntpdate in one of two ways. If ntpdate determines the clock is in error more than 0.5 second it will simply step the time by calling the system settimeofday() routine. If the error is less than 0.5 seconds, it will slew the time by calling the system adjtime() routine. The latter technique is less disruptive and more accurate when the error is small, and works quite well when ntpdate is run by cron every hour or two.

ntpdate will, if the -u flag was not specified, decline to set the date if an NTP server daemon (e.g., ntpd) is running on the same host. When running ntpdate on a regular basis from cron as an alternative to running a daemon, doing so once every hour or two will result in precise enough timekeeping to avoid stepping the clock.

@@ -32,9 +32,9 @@
-6
Force DNS resolution of following host names on the command line to the IPv6 namespace.
-a key
-
Enable the authentication function and specify the key identifier to be used for authentication as the argument keyntpdate. The keys and key identifiers must match in both the client and server key files. The default is to disable the authentication function.
+
Enable the authentication function and specify the key identifier to be used for authentication as the argument key. The keys and key identifiers must match in both the client and server key files. The default is to disable the authentication function.
-B
-
Force the time to always be slewed using the adjtime() system call, even if the measured offset is greater than +-128 ms. The default is to step the time using settimeofday() if the offset is greater than +-128 ms. Note that, if the offset is much greater than +-128 ms in this case, that it can take a long time (hours) to slew the clock to the correct value. During this time. the host should not be used to synchronize clients.
+
Force the time to always be slewed using the adjtime() system call, even if the measured offset is greater than +-500 ms. The default is to step the time using settimeofday() if the offset is greater than +-500 ms. Note that, if the offset is much greater than +-500 ms in this case, that it can take a long time (hours) to slew the clock to the correct value. During this time. the host should not be used to synchronize clients.
-b
Force the time to be stepped using the settimeofday() system call, rather than slewed (default) using the adjtime() system call. This option should be used when called from a startup file at boot time.
-d
@@ -55,7 +55,7 @@
-t timeout
Specify the maximum time waiting for a server response as the value timeout, in seconds and fraction. The value is is rounded to a multiple of 0.2 seconds. The default is 1 second, a value suitable for polling across a LAN.
-u
-
Direct ntpdate to use an unprivileged port or outgoing packets. This is most useful when behind a firewall that blocks incoming traffic to privileged ports, and you want to synchronise with hosts beyond the firewall. Note that the -d option always uses unprivileged ports.
+
Direct ntpdate to use an unprivileged port for outgoing packets. This is most useful when behind a firewall that blocks incoming traffic to privileged ports, and you want to synchronize with hosts beyond the firewall. Note that the -d option always uses unprivileged ports.
-v
Be verbose. This option will cause ntpdate's version identification string to be logged.
diff --git a/html/ntpdc.html b/html/ntpdc.html index 0ec61a1a3..5adb07dcd 100644 --- a/html/ntpdc.html +++ b/html/ntpdc.html @@ -18,9 +18,9 @@

Synopsis

-ntpdc [ -ilnps ] [ -c command ] [ host ] [ ... ] +ntpdc [ -46dilnps ] [ -c command ] [ host ] [ ... ]

Description

-ntpdc is used to query the ntpd daemon about its current state and to request changes in that state. The program may be run either in interactive mode or controlled using command line arguments. Extensive state and statistics information is available through the ntpdc interface. In addition, nearly all the configuration options which can be specified at startup using ntpd's configuration file may also be specified at run time using ntpdc. +

ntpdc is used to query the ntpd daemon about its current state and to request changes in that state. The program may be run either in interactive mode or controlled using command line arguments. Extensive state and statistics information is available through the ntpdc interface. In addition, nearly all the configuration options which can be specified at startup using ntpd's configuration file may also be specified at run time using ntpdc.

If one or more request options are included on the command line when ntpdc is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpdc will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpdc will prompt for commands if the standard input is a terminal device.

ntpdc uses NTP mode 7 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpdc makes no attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.

The operation of ntpdc are specific to the particular implementation of the ntpd daemon and can be expected to work only with this and maybe some previous versions of the daemon. Requests from a remote ntpdc program which affect the state of the local server must be authenticated, which requires both the remote program and local server share a common key and key identifier.

@@ -34,6 +34,8 @@
Force DNS resolution of following host names on the command line to the IPv6 namespace.
-c command
The following argument is interpreted as an interactive format command and is added to the list of commands to be executed on the specified host(s). Multiple -c options may be given.
+
-d +
Turn on debugging mode.
-i
Force ntpdc to operate in interactive mode. Prompts will be written to the standard output and commands read from the standard input.
-l
diff --git a/html/ntpq.html b/html/ntpq.html index fae782198..b0cf59db9 100644 --- a/html/ntpq.html +++ b/html/ntpq.html @@ -18,7 +18,7 @@

Synopsis

-ntpq [-inp] [-c command] [host] [...] +ntpq [-46dinp] [-c command] [host] [...]

Description

The ntpq utility program is used to monitor NTP daemon ntpd operations and determine performance. It uses the standard NTP mode 6 control diff --git a/html/ntptrace.html b/html/ntptrace.html index 9c2139de5..0e33311f8 100644 --- a/html/ntptrace.html +++ b/html/ntptrace.html @@ -16,7 +16,7 @@

Synopsis

-ntptrace [ -n ] [ -m max_hosts ] [ server ] +ntptrace [ -n ] [ -m maxhosts ] [ server ]

Description

ntptrace is a perl script that uses the ntpq utility program to follow the chain of NTP servers from a given host back to the primary time source. For ntptrace to work properly, each of these servers must implement the NTP Control and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.

If given no arguments, ntptrace starts with localhost. Here is an example of the output from ntptrace: