ntpsweep.1ntpsweepmdoc revision 301301
175584Sru.Dd June 2 2016
275584Sru.Dt NTPSWEEP 1ntpsweepmdoc User Commands
375584Sru.Os
4104862Sru.\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
575584Sru.\"
675584Sru.\"  It has been AutoGen-ed  June  2, 2016 at 07:24:55 AM by AutoGen 5.18.5
775584Sru.\"  From the definitions    ntpsweep-opts.def
875584Sru.\"  and the template file   agmdoc-cmd.tpl
975584Sru.Sh NAME
1075584Sru.Nm ntpsweep
1175584Sru.Nd Print various informations about given ntp servers
1275584Sru.Sh SYNOPSIS
1375584Sru.Nm
1475584Sru.\" Mixture of short (flag) options and long options
15104862Sru.Op Fl flags
1675584Sru.Op Fl flag Op Ar value
1775584Sru.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
1875584Sru[hostfile]
1975584Sru.Pp
2075584Sru.Sh DESCRIPTION
2175584Sru.Nm 
22104862Sruprints per host the NTP stratum level, the clock offset in seconds, the daemon
2375584Sruversion, the operating system and the processor. Optionally recursing through
2475584Sruall peers.
2575584Sru.Sh "OPTIONS"
2675584Sru.Bl -tag
2775584Sru.It  Fl l Ar string , Fl \-host\-list Ns = Ns Ar string 
2875584SruHost to execute actions on.
2975584SruThis option may appear an unlimited number of times.
3075584Sru.sp
3175584Sru            Use this option to specify the host on which this script operates.
3275584Sru            May appear multiple times.
3375584Sru.It  Fl p , Fl \-peers 
3475584SruRecursively list all peers a host synchronizes to.
3575584Sru.sp
3675584SruThis option has not been fully documented.
3775584Sru.It  Fl m Ar number , Fl \-maxlevel Ns = Ns Ar number 
3875584SruTraverse peers up to this level (4 is a reasonable number).
3975584SruThis option takes an integer number as its argument.
4075584Sru.sp
4175584SruThis option has not been fully documented.
4275584Sru.It  Fl s Ar string , Fl \-strip Ns = Ns Ar string 
4375584SruStrip this string from hostnames.
4475584Sru.sp
4575584SruThis option has not been fully documented.
4675584Sru.It  Fl h Ar string , Fl \-host Ns = Ns Ar string 
4775584SruSpecify a single host.
4875584Sru.sp
4975584SruThis option has not been fully documented.
5075584Sru.sp
5175584Sru.B
5275584SruNOTE: THIS OPTION IS DEPRECATED
5375584Sru.It Fl \&? , Fl \-help
5475584SruDisplay usage information and exit.
5575584Sru.It Fl \&! , Fl \-more\-help
5675584SruPass the extended usage information through a pager.
5775584Sru.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
5875584SruOutput version of program and exit.  The default mode is `v', a simple
5975584Sruversion.  The `c' mode will print copyright information and `n' will
6075584Sruprint the full copyright notice.
6175584Sru.El
6275584Sru.Sh "EXIT STATUS"
6375584SruOne of the following exit values will be returned:
6475584Sru.Bl -tag
6575584Sru.It 0 " (EXIT_SUCCESS)"
6675584SruSuccessful program execution.
6775584Sru.It 1 " (EXIT_FAILURE)"
6875584SruThe operation failed or the command syntax was not valid.
6975584Sru.It 70 " (EX_SOFTWARE)"
7075584Srulibopts had an internal operational error.  Please report
7175584Sruit to autogen\-users@lists.sourceforge.net.  Thank you.
7275584Sru.El
7375584Sru.Sh "NOTES"
7475584SruThis manual page was \fIAutoGen\fP\-erated from the \fBntpsweep\fP
7575584Sruoption definitions.
7675584Sru