[ntpsec commit] Yes another step in documentation factoring.

Eric S. Raymond esr at ntpsec.org
Sun Oct 11 00:57:15 UTC 2015


Module:    ntpsec
Branch:    master
Commit:    78f02a0d6077cea2841c2014403fb88880cb6040
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=78f02a0d6077cea2841c2014403fb88880cb6040

Author:    Eric S. Raymond <esr at thyrsus.com>
Date:      Sat Oct 10 20:56:40 2015 -0400

Yes another step in documentation factoring.

---

 docs/assoc-auxcommands.txt | 43 +++++++++++++++++++++++++++++++++++++++++
 docs/confopt.txt           | 48 ++++++++--------------------------------------
 ntpd/ntp.conf.txt          | 42 ++--------------------------------------
 3 files changed, 53 insertions(+), 80 deletions(-)

diff --git a/docs/assoc-auxcommands.txt b/docs/assoc-auxcommands.txt
new file mode 100644
index 0000000..6132acc
--- /dev/null
+++ b/docs/assoc-auxcommands.txt
@@ -0,0 +1,43 @@
+// Auxilary association commands - included twice 
+
+`broadcastclient`::
+  This command enables reception of broadcast server messages to any
+  local interface (type b) address. Upon receiving a message for the
+  first time, the broadcast client measures the nominal server
+  propagation delay using a brief client/server exchange with the
+  server, then enters the broadcast client mode, in which it
+  synchronizes to succeeding broadcast messages. Note that, in order to
+  avoid accidental or malicious disruption in this mode, both the server
+  and client should operate using symmetric-key or public-key
+  authentication as described on the "Authentication Options" page.
+
+`manycastserver` _address..._::
+  This command enables reception of manycast client messages to the
+  multicast group address(es) (type m) specified. At least one address
+  is required, but the NTP multicast address 224.0.1.1 assigned by the
+  IANA should NOT be used, unless specific means are taken to limit the
+  span of the reply and avoid a possibly massive implosion at the
+  original sender. Note that, in order to avoid accidental or malicious
+  disruption in this mode, both the server and client should operate
+  using symmetric-key or public-key authentication as described on the
+  "Authentication Options" page.
+
+`multicastclient` _address..._::
+  This command enables reception of multicast server messages to the
+  multicast group address(es) (type m) specified. Upon receiving a
+  message for the first time, the multicast client measures the nominal
+  server propagation delay using a brief client/server exchange with the
+  server, then enters the broadcast client mode, in which it
+  synchronizes to succeeding multicast messages. Note that, in order to
+  avoid accidental or malicious disruption in this mode, both the server
+  and client should operate using symmetric-key or public-key
+  authentication as described on the "Authentication Options" page.
+
+`mdnstries` _number_::
+  If we are participating in mDNS, after we have synched for the first
+  time we attempt to register with the mDNS system. If that registration
+  attempt fails, we try again at one minute intervals for up to
+  _number_ times. After all, `{ntpd}` may be starting before mDNS. The
+  default value for `mdnstries` is 5.
+
+// end
diff --git a/docs/confopt.txt b/docs/confopt.txt
index 699f438..fc90f3a 100644
--- a/docs/confopt.txt
+++ b/docs/confopt.txt
@@ -57,9 +57,10 @@ qualifier forces DNS resolution to the IPv6 namespace.
 Unless noted otherwise, further information about these commands is at
 link:discover.html#pool[Automatic Server Discovery].
 
-Additional information about this command is on at
-{server-discovery}. The http://www.pool.ntp.org/[www.pool.ntp.org]
-page describes a compatible pool of public NTP servers.
+The http://www.pool.ntp.org/[www.pool.ntp.org] page describes a
+compatible pool of public NTP servers, which are probably what you
+want to define associations with unless you specifically know
+otherwise.
 
 include::assoc-commands.txt[]
 
@@ -71,43 +72,10 @@ include::assoc-options.txt[]
 [[aux]]
 == Auxiliary Commands ==
 
-`broadcastclient`::
-  Enable reception of broadcast server messages to any local interface
-  (type b address). Ordinarily, upon receiving a broadcast message for
-  the first time, the broadcast client measures the nominal server
-  propagation delay using a brief client/server exchange, after which it
-  continues in listen-only mode. If a nonzero value is specified in the
-  `broadcastdelay` command, the value becomes the delay and the volley
-  is not executed. Note: the `novolley` option has been deprecated for
-  future enhancements. Note that, in order to avoid accidental or
-  malicious disruption in this mode, both the server and client should
-  operate using symmetric key or public key authentication as described
-  in the link:authopt.html[Authentication Options] page. Note that the
-  volley is required with public key authentication in order to run the
-  Autokey protocol.
-`manycastserver` 'address' [...]::
-  Enable reception of manycast client messages (type m) to the
-  multicasts group address(es) (type m) specified. At least one address
-  is required. Note that, in order to avoid accidental or malicious
-  disruption, both the server and client should operate using symmetric
-  key or public key authentication as described in the
-  link:authopt.html[Authentication Options] page.
-`multicastclient` 'address' [...]::
-  Enable reception of multicast server messages to the multicast group
-  address(es) (type m) specified. Upon receiving a message for the first
-  time, the multicast client measures the nominal server propagation
-  delay using a brief client/server exchange with the server, then
-  enters the broadcast client mode, in which it synchronizes to
-  succeeding multicast messages. Note that, in order to avoid accidental
-  or malicious disruption in this mode, both the server and client
-  should operate using symmetric key or public key authentication as
-  described in the link:authopt.html[Authentication Options] page.
-`mdnstries` 'number'::
-  If we are participating in mDNS, after we have synched for the first
-  time we attempt to register with the mDNS system. If that registration
-  attempt fails, we try again at one minute intervals for up to
-  `mdnstries` times. After all, `{ntpd}` may be starting before mDNS. The
-  default value for `mdnstries` is 5.
+Information on authentication for broadcast, manycast, and
+manycat options can be found at link:authopt.html[Authentication Options].
+
+include::assoc-auxcommands.txt[]
 
 '''''
 
diff --git a/ntpd/ntp.conf.txt b/ntpd/ntp.conf.txt
index 402b9d6..841bd9b 100644
--- a/ntpd/ntp.conf.txt
+++ b/ntpd/ntp.conf.txt
@@ -86,49 +86,11 @@ include::../docs/assoc-commands.txt[]
 
 === Association Options ===
 
-
+include::../docs/assoc-options.txt[]
 
 === Auxiliary Commands ===
 
-`broadcastclient`::
-  This command enables reception of broadcast server messages to any
-  local interface (type b) address. Upon receiving a message for the
-  first time, the broadcast client measures the nominal server
-  propagation delay using a brief client/server exchange with the
-  server, then enters the broadcast client mode, in which it
-  synchronizes to succeeding broadcast messages. Note that, in order to
-  avoid accidental or malicious disruption in this mode, both the server
-  and client should operate using symmetric-key or public-key
-  authentication as described in 'Authentication Options'.
-
-`manycastserver` _address..._::
-  This command enables reception of manycast client messages to the
-  multicast group address(es) (type m) specified. At least one address
-  is required, but the NTP multicast address 224.0.1.1 assigned by the
-  IANA should NOT be used, unless specific means are taken to limit the
-  span of the reply and avoid a possibly massive implosion at the
-  original sender. Note that, in order to avoid accidental or malicious
-  disruption in this mode, both the server and client should operate
-  using symmetric-key or public-key authentication as described in
-  'Authentication Options'.
-
-`multicastclient` _address..._::
-  This command enables reception of multicast server messages to the
-  multicast group address(es) (type m) specified. Upon receiving a
-  message for the first time, the multicast client measures the nominal
-  server propagation delay using a brief client/server exchange with the
-  server, then enters the broadcast client mode, in which it
-  synchronizes to succeeding multicast messages. Note that, in order to
-  avoid accidental or malicious disruption in this mode, both the server
-  and client should operate using symmetric-key or public-key
-  authentication as described in 'Authentication Options'.
-
-`mdnstries` _number_::
-  If we are participating in mDNS, after we have synched for the first
-  time we attempt to register with the mDNS system. If that registration
-  attempt fails, we try again at one minute intervals for up to
-  _number_ times. After all, `{ntpd}` may be starting before mDNS. The
-  default value for `mdnstries` is 5.
+include::../docs/assoc-auxcommands.txt[]
 
 == Authentication Support ==
 



More information about the vc mailing list