[ntpsec commit] Refactor ntp-wait documentation.
Eric S. Raymond
esr at ntpsec.org
Thu Oct 8 16:19:06 UTC 2015
Module: ntpsec
Branch: master
Commit: d75086774b07ddf368e14f03d11449505ea9c326
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=d75086774b07ddf368e14f03d11449505ea9c326
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Thu Oct 8 12:18:42 2015 -0400
Refactor ntp-wait documentation.
---
devel-docs/TODO | 1 -
docs/ntp-wait-body.txt | 43 +++++++++++++++++++++++++++++++++++++++++++
docs/ntp-wait.txt | 25 +++----------------------
ntpd/ntp.conf.txt | 10 +++++-----
scripts/ntp-wait/ntp-wait.txt | 40 ++--------------------------------------
5 files changed, 53 insertions(+), 66 deletions(-)
diff --git a/devel-docs/TODO b/devel-docs/TODO
index 0f424de..51909f1 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -102,7 +102,6 @@ is not yet tested anywhere but in ntpd itself.
| Inside docs | Outside docs
| docs/ntp_conf.txt | ntpd/ntp.conf.txt
| docs/ntpdsim.txt | docs/ntpdsim_new.txt
-| docs/ntpwait.txt | scripts/ntp-wait/ntp-wait.txt
| docs/tickadj.txt | -
| - | ntpd/ntp.keys.txt
| - | scripts/calc_tickadj/calc_tickadj.txt
diff --git a/docs/ntp-wait-body.txt b/docs/ntp-wait-body.txt
new file mode 100644
index 0000000..9e4fbab
--- /dev/null
+++ b/docs/ntp-wait-body.txt
@@ -0,0 +1,43 @@
+== SYNOPSIS ==
+{ntpwait} [-v] [-n 'number'] [-s 'secs']
+
+== DESCRIPTION ==
+
+The `{ntpwait}` program blocks until {ntpd} is in synchronized state. This
+can be useful at boot time, to delay the boot sequence until after "{ntpd}
+-g" has set the time.
+
+`{ntpwait}` will send at most _num-tries_ queries to {ntpdman}, sleeping
+for _secs-between_ after each status return that says {ntpdman} has not
+yet produced a synchronized and stable system clock._
+
+`{ntpwait}` will do this quietly, unless the `-v` flag is provided.
+
+== OPTIONS ==
+
+`-n` number, `--tries`=_number_::
+ Number of times to check {ntpd}. This option takes an integer number as
+ its argument. The default _number_ for this option is: 100.
++
+The maximum number of times we will check _{ntpd}_ to see if it has been
+able to synchronize and stabilize the system clock.
+
+`-s` secs-between-tries, `--sleep`=_secs-between-tries_::
+ How long to sleep between tries. This option takes an integer number
+ as its argument. The default _secs-between-tries_ for this option
+ is: 6.
++
+We will sleep for _secs-between-tries_ after each query of _{ntpd}_ that
+returns "the time is not yet stable".
+
+`-v`, `--verbose`::
+ Be verbose.
++
+By default, `{ntpwait}` is silent. With this option, `ntp-wait` will
+provide status information.
+
+== AUTHOR ==
+
+Harlan Stenn.
+
+//end
diff --git a/docs/ntp-wait.txt b/docs/ntp-wait.txt
index c50e39f..4810637 100644
--- a/docs/ntp-wait.txt
+++ b/docs/ntp-wait.txt
@@ -1,26 +1,7 @@
-= `{ntpwait}` - waits until {ntpd} is in synchronized state =
+= `{ntpwait}` - wait until {ntpd} is in synchronized state =
-'''''
-
-== Synopsis ==
-
-`{ntpwait}` [ `-v` ] [ `-n` 'tries' ] [ `-s` 'seconds' ]
-
-== Description ==
-
-The `{ntpwait}` program blocks until {ntpd} is in synchronized state. This
-can be useful at boot time, to delay the boot sequence until after "{ntpd}
--g" has set the time.
+include::ntp-wait-body.txt[]
-== Command Line Options ==
-
-`-n` 'tries'::
-Number of tries before giving up. The default is 1000.
-
-`-s` 'seconds'::
-Seconds to sleep between tries. The default is 6 seconds.
-
-`-v`::
-Be verbose.
+'''''
include::includes/footer.txt[]
diff --git a/ntpd/ntp.conf.txt b/ntpd/ntp.conf.txt
index 5015edb..d36d8d8 100644
--- a/ntpd/ntp.conf.txt
+++ b/ntpd/ntp.conf.txt
@@ -64,7 +64,6 @@ applicable to each command are listed below. Use of options not listed
may not be caught as an error, but may result in some weird and even
destructive behavior.
-FIXME: --enable-ipv6 ??
If the Basic Socket Interface Extensions for IPv6 (RFC-2553) is
detected, support for the IPv6 address family is generated in addition
to the default support of the IPv4 address family. In a few cases,
@@ -74,10 +73,11 @@ presence of colons ":" in the address field. IPv6 addresses can
be used almost everywhere where IPv4 addresses can be used, with the
exception of reference clock addresses, which are always IPv4.
-Note that in contexts where a host name is expected, a `-4` qualifier
-preceding the host name forces DNS resolution to the IPv4 namespace,
-while a `-6` qualifier forces DNS resolution to the IPv6 namespace. See
-IPv6 references for the equivalent classes for that address family.
+Note that in contexts where a host name is expected, a `-4`or `--ipv4`
+qualifier preceding the host name forces DNS resolution to the IPv4
+namespace, while a `-6` or `--ipv6' qualifier forces DNS resolution to
+the IPv6 namespace. See IPv6 references for the equivalent classes for
+that address family.
`pool` _address_ [`burst`] [`iburst`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_]::
`server` _address_ [`key` _key_ | `autokey`] [`burst`] [`iburst`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_]::
diff --git a/scripts/ntp-wait/ntp-wait.txt b/scripts/ntp-wait/ntp-wait.txt
index 1558aac..a8453a1 100644
--- a/scripts/ntp-wait/ntp-wait.txt
+++ b/scripts/ntp-wait/ntp-wait.txt
@@ -4,41 +4,7 @@
== NAME ==
{ntpwait} - Wait for {ntpd} to stabilize the system clock
-== SYNOPSIS ==
-{ntpwait} [-v] [-n 'number'] [-s 'secs']
-
-== DESCRIPTION ==
-
-`{ntpwait}` will send at most _num-tries_ queries to {ntpdman}, sleeping
-for _secs-between_ after each status return that says {ntpdman} has not
-yet produced a synchronized and stable system clock._
-
-`{ntpwait}` will do this quietly, unless the `-v` flag is provided. This
-can be useful at boot time, to delay the boot sequence until after
-_{ntpd}_ `-g` has set the time.
-
-== OPTIONS ==
-
-`-n` number, `--tries`=_number_::
- Number of times to check {ntpd}. This option takes an integer number as
- its argument. The default _number_ for this option is: 100.
-+
-The maximum number of times we will check _{ntpd}_ to see if it has been
-able to synchronize and stabilize the system clock.
-
-`-s` secs-between-tries, `--sleep`=_secs-between-tries_::
- How long to sleep between tries. This option takes an integer number
- as its argument. The default _secs-between-tries_ for this option
- is: 6.
-+
-We will sleep for _secs-between-tries_ after each query of _{ntpd}_ that
-returns "the time is not yet stable".
-
-`-v`, `--verbose`::
- Be verbose.
-+
-By default, `{ntpwait}` is silent. With this option, `ntp-wait` will
-provide status information.
+ at ../../docs/ntp-wait-body.txt@
== EXIT STATUS ==
@@ -49,7 +15,5 @@ One of the following exit values will be returned:
1 (EXIT_FAILURE)::
The operation failed or the command syntax was not valid.
-== AUTHORS ==
-
-Harlan Stenn.
+// end
More information about the vc
mailing list