[Git][NTPsec/ntpsec][master] Factor ntpsweep manual page and add it to web docs.

[Eric S. Raymond]

Eric S. Raymond pushed to branch master at NTPsec / ntpsec


Commits:
0b2064e7 by Eric S. Raymond at 2016-12-24T07:06:54-05:00
Factor ntpsweep manual page and add it to web docs.

- - - - -


5 changed files:

- docs/includes/manual.txt
- + docs/includes/ntpsweep-body.txt
- + docs/ntpsweep.txt
- + docs/pic/SAppr.jpg
- ntpclients/ntpsweep-man.txt


Changes:

=====================================
docs/includes/manual.txt
=====================================
--- a/docs/includes/manual.txt
+++ b/docs/includes/manual.txt
@@ -6,6 +6,7 @@
 * link:ntpleapfetch.html[+ntpleapfetch+ fetch and manage leap-offset file]
 * link:ntpmon.html[+ntpmon+ - real-time NTP status monitor]
 * link:ntpq.html[+ntpq+ - standard NTP query program]
+* link:ntpsweep.html[+ntpsweep+ - print information about given NTP servers]
 * 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:ntpviz.html[+ntpviz+ - make offset, jitter, and other plots from logfiles]


=====================================
docs/includes/ntpsweep-body.txt
=====================================
--- /dev/null
+++ b/docs/includes/ntpsweep-body.txt
@@ -0,0 +1,44 @@
+// This is the body of the manual page for ntmon.
+// It's included in two places: once for the docs/ HTML
+// tree, and once to make an individual man page.
+
+== Synopsis ==
++ntpsweep+ [+-l+ 'host']... [-p] [+-m+ 'number'] [+-s+ 'prefix'] [+-h+ 'string']
+
+== Description ==
+
+`ntpsweep` prints per host the NTP stratum level, the clock offset in
+seconds, the daemon version, the operating system and the processor.
+Optionally recursing through all peers.
+
+If no hosts are specified, `ntpsweep` reports on localhost.
+
+`ntpsweep` relies on `ntpq` and Mode 6 queries to probe servers.  This
+depends on the remote host's _restrict_ configuration allowing
+queries. Nowadays effectively all public hosts set _noquery_, so this
+script is unlikely to be useful unless you have multiple specially-
+configured timeservers on a LAN.
+
+== Options ==
+
++-l+ string, +--host-list+=_string_::
+  Host to execute actions on. This option may appear an unlimited number
+  of times.
++
+Use this option to specify the host on which this script operates. May
+appear multiple times.
+
++-p+, +--peers+::
+  Recursively list all peers a host synchronizes to.
+
++-m+ number, +--maxlevel+=_number_::
+  Traverse peers up to this level (4 is a reasonable number). This
+  option takes an integer number as its argument.
+
++-s+ string, +--strip+=_string_::
+  Strip this string from hostnames.
+
++-h+ string, +--host+=_string_::
+  Specify a single host.  Deprecated option for backwards compatibility.
+
+// end


=====================================
docs/ntpsweep.txt
=====================================
--- /dev/null
+++ b/docs/ntpsweep.txt
@@ -0,0 +1,18 @@
+= ntpsweep - print information about NTP servers =
+
+[cols="10%,90%",frame="none",grid="none",style="verse"]
+|==============================
+|image:pic/SAppr.jpg[]        |
+from 'The Sorcerer's Apprentice', Walt Disney
+
+A new broom sweeps clean.
+
+|==============================
+
+'''''
+
+include::includes/ntpsweep-body.txt[]
+
+'''''
+
+include::includes/footer.txt[]


=====================================
docs/pic/SAppr.jpg
=====================================
Binary files /dev/null and b/docs/pic/SAppr.jpg differ


=====================================
ntpclients/ntpsweep-man.txt
=====================================
--- a/ntpclients/ntpsweep-man.txt
+++ b/ntpclients/ntpsweep-man.txt
@@ -4,44 +4,7 @@
 == NAME ==
 ntpsweep - print various information about given NTP servers
 
-== SYNOPSIS ==
-+ntpsweep+ [+-l+ 'host']... [-p] [+-m+ 'number'] [+-s+ 'prefix'] [+-h+ 'string']
-
-== DESCRIPTION ==
-
-`ntpsweep` prints per host the NTP stratum level, the clock offset in
-seconds, the daemon version, the operating system and the processor.
-Optionally recursing through all peers.
-
-If no hosts are specified, `ntpsweep` reports on localhost.
-
-`ntpsweep` relies on `ntpq` and Mode 6 queries to probe servers.  This
-depends on the remote host's _restrict_ configuration allowing
-queries. Nowadays effectively all public hosts set _noquery_, so this
-script is unlikely to be useful unless you have multiple specially-
-configured timeservers on a LAN.
-
-== OPTIONS ==
-
-+-l+ string, +--host-list+=_string_::
-  Host to execute actions on. This option may appear an unlimited number
-  of times.
-+
-Use this option to specify the host on which this script operates. May
-appear multiple times.
-
-+-p+, +--peers+::
-  Recursively list all peers a host synchronizes to.
-
-+-m+ number, +--maxlevel+=_number_::
-  Traverse peers up to this level (4 is a reasonable number). This
-  option takes an integer number as its argument.
-
-+-s+ string, +--strip+=_string_::
-  Strip this string from hostnames.
-
-+-h+ string, +--host+=_string_::
-  Specify a single host.  Deprecated option for backwards compatibility.
+include::../docs/includes/ntpsweep-body.txt[]
 
 == EXIT STATUS ==
 



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/0b2064e776949b0598d2da6aae98c46a75dae9ca
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20161224/6929b892/attachment.html>