xref: /freebsd/contrib/ntp/scripts/ntpsweep/ntpsweep.man.in (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
ntpsweep 1ntpsweepman "21 Nov 2016" "ntp (4.2.8p9)" "User Commands"

EDIT THIS FILE WITH CAUTION (/tmp/.ag-pTaqL6/ag-CTayK6)

It has been AutoGen-ed November 21, 2016 at 07:58:56 AM by AutoGen 5.18.5
From the definitions ntpsweep-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]ntpsweep - Print various informations about given ntp servers
SYNOPSIS
\f\*[B-Font]ntpsweep Mixture of short (flag) options and long options
[\f\*[B-Font]-flags\f[]] [\f\*[B-Font]-flag\f[] [\f\*[I-Font]value\f[]]] [\f\*[B-Font]--option-name\f[][[=| ]\f\*[I-Font]value\f[]]] [hostfile]
DESCRIPTION
\f\*[B-Font]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.
"OPTIONS"

.NOP \f\*[B-Font]-l\f[] \f\*[I-Font]string\f[], \f\*[B-Font]--host-list\f[]=\f\*[I-Font]string\f[] 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.

.NOP \f\*[B-Font]-p\f[], \f\*[B-Font]--peers\f[] Recursively list all peers a host synchronizes to. This option has not been fully documented.

.NOP \f\*[B-Font]-m\f[] \f\*[I-Font]number\f[], \f\*[B-Font]--maxlevel\f[]=\f\*[I-Font]number\f[] Traverse peers up to this level (4 is a reasonable number). This option takes an integer number as its argument. This option has not been fully documented.

.NOP \f\*[B-Font]-s\f[] \f\*[I-Font]string\f[], \f\*[B-Font]--strip\f[]=\f\*[I-Font]string\f[] Strip this string from hostnames. This option has not been fully documented.

.NOP \f\*[B-Font]-h\f[] \f\*[I-Font]string\f[], \f\*[B-Font]--host\f[]=\f\*[I-Font]string\f[] Specify a single host. This option has not been fully documented. NOTE: THIS OPTION IS DEPRECATED

.NOP \f\*[B-Font]-?\f[], \f\*[B-Font]--help\f[] Display usage information and exit.

.NOP \f\*[B-Font]-!\f[], \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.

.NOP \f\*[B-Font]-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}]}] Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice.

"EXIT STATUS"
One of the following exit values will be returned:

.NOP 0 " (EXIT_SUCCESS)" Successful program execution.

.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.

.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

"NOTES"
This manual page was AutoGen-erated from the ntpsweep option definitions.