From: Harlan Stenn Date: Tue, 2 Sep 2014 03:43:55 +0000 (-0400) Subject: html/ cleanups from Hal Murray X-Git-Tag: NTP_4_2_7P470~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cf703c9be01cc662047d3190f109a6891b8d9e33;p=thirdparty%2Fntp.git html/ cleanups from Hal Murray bk: 54053cfbxw8H9YkSvKIawCdLMvtgAw --- diff --git a/ChangeLog b/ChangeLog index 7c2432e76..0a18429c1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,6 @@ * [Bug 2502] Autogen text replacement errors. * autogen-5.18.5pre1 +* html/ cleanups from Hal Murray. (4.2.7p469) 2014/09/01 Released by Harlan Stenn * [Bug 2536] ntpd sandboxing support (libseccomp2) cleanup. (4.2.7p468) 2014/08/31 Released by Harlan Stenn diff --git a/html/clockopt.html b/html/clockopt.html index 6432f4f73..0fe4c2467 100644 --- a/html/clockopt.html +++ b/html/clockopt.html @@ -31,7 +31,7 @@
Specifies a mode number which is interpreted in a device-specific fashion. For instance, it selects a dialing protocol in the ACTS driver and a device subtype in the parse drivers.
minpoll int
maxpoll int
-
These options specify the minimum and maximum polling interval for reference clock messages in log2 seconds. For most directly connected reference clocks, both minpoll and maxpoll default to 6 (64 s). For modem reference clocks, minpoll is ordinarily set to 10 (about m) and maxpoll to 15 (about 9 h). The allowable range is 4 (16 s) to 17 (36 h) inclusive.
+
These options specify the minimum and maximum polling interval for reference clock messages in log2 seconds. For most directly connected reference clocks, both minpoll and maxpoll default to 6 (64 s). For modem reference clocks, minpoll is ordinarily set to 10 (about 17 m) and maxpoll to 15 (about 9 h). The allowable range is 4 (16 s) to 17 (36 h) inclusive.
fudge 127.127.t.u [time1 sec] [time2 sec] diff --git a/html/miscopt.html b/html/miscopt.html index 8eeac6127..62f41b6c5 100644 --- a/html/miscopt.html +++ b/html/miscopt.html @@ -100,7 +100,7 @@
setvar variable [default]
This command adds an additional system variable. These variables can be used to distribute additional information such as the access policy. If the variable of the form name = value is followed by the default keyword, the variable will be listed as part of the default system variables (ntpq rv command). These additional variables serve informational purposes only. They are not related to the protocol other that they can be listed. The known protocol variables will always override any variables defined via the setvar mechanism. There are three special variables that contain the names of all variable of the same group. The sys_var_list holds the names of all system variables. The peer_var_list holds the names of all peer variables and the clock_var_list holds the names of the reference clock variables.
tinker [allan allan | dispersion dispersion | freq freq | huffpuff huffpuff | panic panic | step step | stepout stepout]
-
This command alters certain system variables used by the clock discipline algorithm. The default values of these variables have been carefully optimized for a wide range of network speeds and reliability expectations. Very rarely is it necessary to change the default values; but, some folks can't resist twisting the knobs. Options are are as follows:
+
This command alters certain system variables used by the clock discipline algorithm. The default values of these variables have been carefully optimized for a wide range of network speeds and reliability expectations. Very rarely is it necessary to change the default values; but, some folks can't resist twisting the knobs. Options are as follows:
allan allan
@@ -121,7 +121,7 @@
rlimit [memlock Nmegabytes | stacksize N4kPages | filenum Nfiledescriptors]
-
This command alters certain process storage allocation limits, and is only available on some operating systems. Options are are as follows:
+
This command alters certain process storage allocation limits, and is only available on some operating systems. Options are as follows:
memlock Nmegabytes
diff --git a/html/refclock.html b/html/refclock.html index 78cc55e36..d8969e38c 100644 --- a/html/refclock.html +++ b/html/refclock.html @@ -28,7 +28,7 @@

NTP Version 4 supports almost four dozen satellite, radio and telephone modem reference clocks plus several audio devices for instrumentation signals. A general description of the reference clock support is on this page. Additional information about each reference clock driver can be found via links from this page. Additional information is on the Debugging Hints for Reference Clock Drivers and How To Write a Reference Clock Driver pages. Information on how to support pulse-per-second (PPS) signals produced by some devices is on the Pulse-per-second (PPS) Signal Interfacing page. All reference clock drivers require that the reference clock use only Coordinated Universal Time (UTC). Timezone and standard/daylight adjustments are performed by the operating system kernel.

A reference clock will generally (though not always) be a radio timecode receiver synchronized to standard time as provided by NIST and USNO in the US, NRC in Canada and their counterparts elsewhere in the world. A device driver specific to each reference clock must be compiled in the distribution; however, most common radio, satellite and telephone modem clocks are included by default and are activated by configuration commands.

Reference clocks are supported in the same way as ordinary NTP clients and use the same filter, select, cluster and combine algorithms. Drivers have addresses in the form 127.127.t.u, where t is the driver type and u is a unit number in the range 0-3 to distinguish multiple instances of the same driver. The connection to the computer is device dependent, usually a serial port, parallel port or special bus peripheral, but some can work directly from an audio codec or sound card. The particular device is specified by adding a soft link from the name used by the driver to the particular device name.

-

The server command is used to configure a reference clock. Only the minpoll, maxpoll, prefer and maxpoll options are supported for reference clocks, as described on the Reference Clock Commands page. The prefer option is discussed on the Mitigation Rules and the prefer Keyword page. Some of these options have meaning only for selected clock drivers.

+

The server command is used to configure a reference clock. Only the mode>,minpoll, maxpoll, and prefer options are supported for reference clocks, as described on the Reference Clock Commands page. The prefer option is discussed on the Mitigation Rules and the prefer Keyword page. Some of these options have meaning only for selected clock drivers.

The fudge command can be used to provide additional information for individual drivers and normally follows immediately after the server command. The reference clock stratum is by default 0, so that the server stratum appears to clients as 1. The stratum option can be used to set the stratum to any value in the range 0 through 15. The refid option can be used to change the reference identifier, as might in the case when the driver is disciplined by a pulse-per-second (PPS) source. The device-dependent mode, time and flag options can provide additional driver customization.

Special Considerations

The Audio Drivers page describes three software drivers that process audio signals from an audio codec or sound card. One is for the NIST time and frequency stations WWV and WWVH, another for the Canadian time and frequency station CHU. These require an external shortwave radio and antenna. A third is for the generic IRIG signal produced by some timing devices. Currently, these are supported in FreeBSD, Solaris and SunOS and likely in other system as well.