[Bug 2530] Fix documentation for enable/disable mode7 and pps

bk: 52cd278dW5oTtQfJP7hDbGLWUhOFIw

diff --git a/ChangeLog b/ChangeLog
index fe67773e638d7879ef28783e0f9cd4800b620caa..265a013dcee053529ee27f04a83abb668b6968dd 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,6 @@
 * [Bug 2332] Force reference to 'libgcc_s' when using GCC, because
   threading+restricted user+locked memory otherwise fails on Linux.
+* [Bug 2530] Fix documentation for enable/disable mode7 and pps.
 * Cleanup to the new scripts/*/Makefile.am files.
 (4.2.7p409) 2014/01/04 Released by Harlan Stenn <stenn@ntp.org>
 * [Bug 2060] Warn about restrictions with "kod" but not "limited".

diff --git a/html/miscopt.html b/html/miscopt.html
index 6e5fefb889283f5dde91a6402288d1cf04d6b972..03ad785f7571c359669f8d06d511b73a3bf01c9e 100644 (file)
--- a/html/miscopt.html
+++ b/html/miscopt.html
@@ -26,8 +26,8 @@
   <dd>This command specifies the complete path and name of the file used to record the frequency of the local clock oscillator. This is the same operation as the <tt>-f</tt> command line option. This command is mutually exclusive with the <tt>freq</tt> option of the <tt>tinker</tt> command.</dd>
   <dd> If the file exists, it is read at startup in order to set the initial frequency and then updated once per hour or more with the current frequency computed by the daemon. If the file name is specified, but the file itself does not exist, the starts with an initial frequency of zero and creates the file when writing it for the first time. If this command is not given, the daemon will always start with an initial frequency of zero.</dd>
   <dd>The file format consists of a single line containing a single floating point number, which records the frequency offset measured in parts-per-million (PPM). The file is updated by first writing the current drift value into a temporary file and then renaming this file to replace the old version.</dd>
-  <dt id="enable"><tt>enable [auth | bclient | calibrate | kernel | monitor | ntp | pps | stats]</tt><br>
-    <tt>disable [auth | bclient | calibrate | kernel | monitor | ntp | pps | stats]</tt></dt>
+  <dt id="enable"><tt>enable [auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats]</tt><br>
+    <tt>disable [auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats]</tt></dt>
   <dd>Provides a way to enable or disable various system options. Flags not mentioned are unaffected. Note that most of these flags can be modified remotely using <a href="ntpq.html"><tt>ntpq</tt></a> utility program's <tt>:config</tt> and <tt>config-from-file</tt> commands.
     <dl>
       <dt><tt>auth</tt></dt>
@@ -38,11 +38,11 @@
       <dd>Enables the calibrate feature for reference clocks. The default for this flag is disable.</dd>
       <dt><tt>kernel</tt></dt>
       <dd>Enables the kernel time discipline, if available. The default for this flag is enable if support is available, otherwise disable.</dd>
+      <dt><tt>mode7</tt></dt>
+      <dd>Enables processing of NTP mode 7 implementation-specific requests which are used by the deprecated <tt>ntpdc</tt> program. The default for this flag is disable. This flag is excluded from runtime configuration using <tt>ntpq</tt>. The <tt>ntpq</tt> program provides the same capabilities as <tt>ntpdc</tt> using standard mode 6 requests.</dd>
       <dt><tt>monitor</tt></dt>
       <dd>Enables the monitoring facility. See the <a href="ntpq.html"><tt>ntpq</tt> program</a> and the <tt>monstats</tt> and <tt>mrulist</tt> commands, as well as the <a href="accopt.html#discard">Access Control Options</a> for details.
         The monitoring facility is also enabled by the presence of <a href="accopt.html#limited"><tt>limited</tt></a> in any <tt>restrict</tt> commands. The default for this flag is enable.</dd>
-      <dt><tt>mode7</tt></dt>
-      <dd>Enables processing of NTP mode 7 implementation-specific requests which are used by the deprecated <tt>ntpdc</tt> program. The default for this flag is disable. This flag is excluded from runtime configuration using <tt>ntpq</tt>. The <tt>ntpq</tt> program provides the same capabilities as <tt>ntpdc</tt> using standard mode 6 requests.</dd>
       <dt><tt>ntp</tt></dt>
       <dd>Enables time and frequency discipline. In effect, this switch opens and closes the feedback loop, which is useful for testing. The default for this flag is enable.</dd>
       <dt><tt>stats</tt></dt>

diff --git a/ntpd/ntp.conf.def b/ntpd/ntp.conf.def
index cd3d6a10fdf9759f8924c347681e92e40e76cf05..e0ea34f0c5a886b611a96469124591703e5aca81 100644 (file)
--- a/ntpd/ntp.conf.def
+++ b/ntpd/ntp.conf.def
@@ -2366,16 +2366,16 @@ otherwise, should be avoided.
 .Oo
 .Cm auth | Cm bclient |
 .Cm calibrate | Cm kernel |
-.Cm monitor | Cm ntp |
-.Cm pps | Cm stats
+.Cm mode7 | monitor |
+.Cm ntp | Cm stats
 .Oc
 .Xc
 .It Xo Ic disable
 .Oo
 .Cm auth | Cm bclient |
 .Cm calibrate | Cm kernel |
-.Cm monitor | Cm ntp |
-.Cm pps | Cm stats
+.Cm mode7 | monitor |
+.Cm ntp | Cm stats
 .Oc
 .Xc
 Provides a way to enable or disable various server options.
@@ -2411,6 +2411,19 @@ flag is
 .Ic enable
 if support is available, otherwise
 .Ic disable .
+.It Cm mode7
+Enables processing of NTP mode 7 implementation-specific requests
+which are used by the deprecated
+.Xr ntpdc 1ntpdcmdoc
+program.
+The default for this flag is disable.
+This flag is excluded from runtime configuration using
+.Xr ntpq 1ntpqmdoc .
+The
+.Xr ntpq 1ntpqmdoc
+program provides the same capabilities as
+.Xr ntpdc 1ntpdcmdoc
+using standard mode 6 requests.
 .It Cm monitor
 Enables the monitoring facility.
 See the
@@ -2429,17 +2442,6 @@ closes the feedback loop, which is useful for testing.
 The default for
 this flag is
 .Ic enable .
-.It Cm pps
-Enables the pulse-per-second (PPS) signal when frequency and time is
-disciplined by the precision time kernel modifications.
-See the
-.Qq A Kernel Model for Precision Timekeeping
-(available as part of the HTML documentation
-provided in
-.Pa /usr/share/doc/ntp )
-page for further information.
-The default for this flag is
-.Ic disable .
 .It Cm stats
 Enables the statistics facility.
 See the