[ntpsec commit] Fully document ntpleapfetch, in-tree and out of tree.
Eric S. Raymond
esr at ntpsec.org
Sun Oct 18 23:42:39 UTC 2015
Module: ntpsec
Branch: master
Commit: 3286c7ba000e2124095166b8078952571dcc0795
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=3286c7ba000e2124095166b8078952571dcc0795
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Sun Oct 18 19:41:55 2015 -0400
Fully document ntpleapfetch, in-tree and out of tree.
---
devel-docs/TODO | 1 -
docs/asciidoc.conf | 2 +
docs/includes/manual.txt | 7 +-
.../includes/ntpleapfetch-body.txt | 77 ++++++++++++++--------
docs/ntpleapfetch.txt | 23 +++++++
ntpleapfetch/ntpleapfetch.txt.in | 22 +++++++
wscript | 1 +
7 files changed, 100 insertions(+), 33 deletions(-)
diff --git a/devel-docs/TODO b/devel-docs/TODO
index 7098f7f..81e7ba1 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -95,7 +95,6 @@ they are salvageable.
scripts/summary.txt
scripts/ntpsweep/ntpsweep.txt
scripts/plot_summary.txt
- scripts/ntpleapfetch/ntpleapfetch.txt
* The format and organization of the NEWS file needs a rethink.
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
index 789e6e1..b4a04b2 100644
--- a/docs/asciidoc.conf
+++ b/docs/asciidoc.conf
@@ -23,6 +23,7 @@ ntpdsim=ntpdsim
ntpfrob=ntpfrob
ntpkeygen=ntpkeygen
ntpkeys=ntp.keys
+ntpleapfetch=ntpleapfetch
ntpq=ntpq
ntptime=ntptime
ntpwait=ntpwait
@@ -34,6 +35,7 @@ ntpdsim=ntpdsim(8)
ntpkeygenman=ntpkeygen(8)
ntpkeysman=ntp.keys(5)
ntpdman=ntpd(8)
+ntpleapfetch=ntpleapfetch(8)
ntpqman=ntpq(1)
ntptimeman=ntptime(8)
ntpwaitman=ntpwait(8)
diff --git a/docs/includes/manual.txt b/docs/includes/manual.txt
index e3b9aff..3f6518b 100644
--- a/docs/includes/manual.txt
+++ b/docs/includes/manual.txt
@@ -1,11 +1,12 @@
== Program Manual Pages ==
* link:ntpd.html[+{ntpd}+ - Network Time Protocol (NTP) daemon]
-* link:ntpq.html[+{ntpq}+ - standard NTP query program]
* link:ntpdig.html[+{ntpdig}+ - Simple Network Time Protocol (SNTP) client]
-* link:ntptrace.html[`ntptrace` - trace a chain of NTP servers back to the primary source]
+* link:ntpq.html[+{ntpq}+ - standard NTP query program]
* link:ntpfrob.html[+{ntpfrob}+ - frob the local clock hardware]
-* link:ntptime.html[+{ntptime}+ - read and set kernel time variables]
* link:ntpkeygen.html[+{ntpkeygen}+ - generate public and private keys]
+* link:ntpleapfetch.html[+{ntpleapfetch}+ fetch and manage leap-offset file]
* link:ntpdsim.html[+{ntpdsim}+ - Network Time Protocol (NTP) simulator]
+* link:ntptime.html[+{ntptime}+ - read and set kernel time variables]
+* link:ntptrace.html[`ntptrace` - trace a chain of NTP servers back to the primary source]
* link:sitemap.html[Site Map]
diff --git a/ntpleapfetch/ntpleapfetch.txt b/docs/includes/ntpleapfetch-body.txt
similarity index 62%
rename from ntpleapfetch/ntpleapfetch.txt
rename to docs/includes/ntpleapfetch-body.txt
index 5eef3ec..0f93ee4 100644
--- a/ntpleapfetch/ntpleapfetch.txt
+++ b/docs/includes/ntpleapfetch-body.txt
@@ -1,11 +1,15 @@
-== ntpleapfetch(1) ==
-:doctype: manpage
-
-== NAME ==
-ntpleapfetch - leap-seconds file manager/updater
+// This is the body of the manual page for ntpleapfetch.
+// It's included in two places: once for the docs/ HTML
+// tree, and once to make an individual man page.
+[[synop]]
== SYNOPSIS ==
-ntpleapfetch [-flags | -flag 'value' | --option-name='value']
+[verse]
++ntpleapfetch+
+ [+-46+] [+-d+ 'localfile'] [+-e+ 'expiry'] [+-f+ 'config']
+ [+-F+] [+-i+ 'interval'] [+-l+] [+L+] [+-p+ {4|6}] [+-P+ 'loglevel']
+ [+-q+] [+r+ 'retries'] [+-s+ 'source-url'] [-t 'path'] [-v]
+ [+-z+ 'path'] [+-Z+]
== DESCRIPTION ==
@@ -33,60 +37,75 @@ For cron-friendly behavior, define CRONJOB=1 in the crontab.
== OPTIONS ==
-`-s` string, `--source-url`=_string_::
- The URL of the master copy of the leapseconds file.
- +
-Specify the URL of the master copy to download $LEAPSRC
-
-`-4`, `--ipv4`::
++-4+::
Use only IPv4 addresses for DNS name resolution. This option must not
appear in combination with any of the following options: --ipv6.
-`-6`, `--ipv6`::
++-6+::
Use only IPv6 addresses for DNS name resolution. This option must not
appear in combination with any of the following options: --ipv4.
-`-d` float, `--destination`=_float_::
++-c+::
+ Command to restart {ntpd} after installing a new file. Without such a
+ command. {ntpd} checks the file daily.
+
++-d+ localfile::
Filename on the local system.
+
The name to use to store the leapfile on the local system. $LEAPFILE
-`-e` string, `--expiration`=_string_::
++-e+ string::
Refresh the leapfile this long before it expires.
+
Specify how long before expiration the file is to be refreshed Units
are required, e.g. "-e 60 days" Note that larger values imply more
frequent refreshes.
-`-f` string, `--ntp-conf-file`=_string_::
++-f+ string::
Location of the {ntpconf} file.
+
Specify location of {ntpconf} (used to make sure leapfile directive is
present and to default leapfile) /etc/{ntpconf}
-`-F`, `--force-update`::
++-F+::
Force update of the leapfile.
+
Force update even if current file is OK and not close to expiring.
-`--dont-wait`::
- Don't wait for keystroke between plots.
++-i 'interval'+::
+ Number of retries.
-== USAGE ==
++-l+::
+ Use syslog for output (Implied if CRONJOB is set).
-Usage stuff
++-L+::
+ Don't use syslog for output
-== EXIT STATUS ==
++-p+ {+4+|+6+}::
+ Prefer IPv4 or IPv6 (as specified) addresses, but use either.
+
++-P+ 'loglevel'::
+ Specify the syslog facility for logging
+
++-q+::
+ Only report errors to stdout
+
++-r 'retries'+::
+ Number of retries.
+
++-s+ string, +--source-url+=_string_::
+ The URL of the master copy of the leapseconds file.
-One of the following exit values will be returned:
++-t+ 'path'::
+ Name of temporary file used in validation.
-0 (EXIT_SUCCESS)::
- Successful program execution.
-1 (EXIT_FAILURE)::
- The operation failed or the command syntax was not valid.
++-v+::
+ Verbose output.
-== AUTHORS ==
++-z+ 'path'::
+ Specify path for utilities.
-Timothe Litt
++-Z+::
+ Use system path only.
// end
diff --git a/docs/ntpleapfetch.txt b/docs/ntpleapfetch.txt
new file mode 100644
index 0000000..6e95b2a
--- /dev/null
+++ b/docs/ntpleapfetch.txt
@@ -0,0 +1,23 @@
+= +{ntpleapfetch}+ - fetch and manage local leap file =
+
+//FIXME: Image duplicates the one used for ntpfrob
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/pogo3a.gif[]|
+{millshome}pictures.html[from 'Pogo', Walt Kelly]
+
+Occasionally, the leap-second needs an update.
+
+|==============================
+
+== More Help ==
+
+include::includes/manual.txt[]
+
+'''''
+
+include::includes/ntpleapfetch-body.txt[]
+
+'''''
+
+include::includes/footer.txt[]
diff --git a/ntpleapfetch/ntpleapfetch.txt.in b/ntpleapfetch/ntpleapfetch.txt.in
new file mode 100644
index 0000000..627b79a
--- /dev/null
+++ b/ntpleapfetch/ntpleapfetch.txt.in
@@ -0,0 +1,22 @@
+== ntpleapfetch(8) ==
+:doctype: manpage
+
+== NAME ==
+{ntpleapfetch} - leap-seconds file manager/updater
+
+ at ..docs/includes/ntpleapfetch-body.txt@
+
+== EXIT STATUS ==
+
+One of the following exit values will be returned:
+
+0 (EXIT_SUCCESS)::
+ Successful program execution.
+1 (EXIT_FAILURE)::
+ The operation failed or the command syntax was not valid.
+
+== AUTHORS ==
+
+Timothe Litt
+
+// end
diff --git a/wscript b/wscript
index 5a8119c..0e03943 100644
--- a/wscript
+++ b/wscript
@@ -126,6 +126,7 @@ def build(ctx):
"ntpd/complete.conf.in",
"ntpd/ntpd-man.txt.in",
"ntpq/ntpq-man.txt.in",
+ "ntpleapfetch/ntpleapfetch.txt.in",
"scripts/ntpwait/ntpwait-man.txt.in",
"scripts/ntptrace/ntptrace-man.txt.in",
"ntpdig/ntpdig-man.txt.in",
More information about the vc
mailing list