Skip to content
Snippets Groups Projects
Commit 0b2064e7 authored by Eric S. Raymond's avatar Eric S. Raymond
Browse files

Factor ntpsweep manual page and add it to web docs.

parent cec3babc
No related branches found
No related tags found
Loading
......@@ -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]
......
// 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
= 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

11.5 KiB

......@@ -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 ==
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment