ntpsweep.mdoc.in revision 294905
155682Smarkm.Dd January 20 2016
255682Smarkm.Dt NTPSWEEP 1ntpsweepmdoc User Commands
355682Smarkm.Os
455682Smarkm.\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
555682Smarkm.\"
655682Smarkm.\"  It has been AutoGen-ed  January 20, 2016 at 04:10:09 AM by AutoGen 5.18.5
755682Smarkm.\"  From the definitions    ntpsweep-opts.def
855682Smarkm.\"  and the template file   agmdoc-cmd.tpl
955682Smarkm.Sh NAME
1055682Smarkm.Nm ntpsweep
1155682Smarkm.Nd Print various informations about given ntp servers
1255682Smarkm.Sh SYNOPSIS
1355682Smarkm.Nm
1455682Smarkm.\" Mixture of short (flag) options and long options
1555682Smarkm.Op Fl flags
1655682Smarkm.Op Fl flag Op Ar value
1755682Smarkm.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
1855682Smarkm[hostfile]
1955682Smarkm.Pp
2055682Smarkm.Sh DESCRIPTION
2155682Smarkm.Nm 
2255682Smarkmprints per host the NTP stratum level, the clock offset in seconds, the daemon
2355682Smarkmversion, the operating system and the processor. Optionally recursing through
2455682Smarkmall peers.
2555682Smarkm.Sh "OPTIONS"
2655682Smarkm.Bl -tag
2755682Smarkm.It  Fl l Ar string , Fl \-host\-list Ns = Ns Ar string 
2855682SmarkmHost to execute actions on.
2955682SmarkmThis option may appear an unlimited number of times.
3055682Smarkm.sp
3155682Smarkm            Use this option to specify the host on which this script operates.
3255682Smarkm            May appear multiple times.
3355682Smarkm.It  Fl p , Fl \-peers 
3455682SmarkmRecursively list all peers a host synchronizes to.
3555682Smarkm.sp
36178825SdfrThis option has not been fully documented.
3755682Smarkm.It  Fl m Ar number , Fl \-maxlevel Ns = Ns Ar number 
3855682SmarkmTraverse peers up to this level (4 is a reasonable number).
3955682SmarkmThis option takes an integer number as its argument.
4055682Smarkm.sp
41178825SdfrThis option has not been fully documented.
4255682Smarkm.It  Fl s Ar string , Fl \-strip Ns = Ns Ar string 
4355682SmarkmStrip this string from hostnames.
4455682Smarkm.sp
4555682SmarkmThis option has not been fully documented.
4655682Smarkm.It  Fl h Ar string , Fl \-host Ns = Ns Ar string 
4755682SmarkmSpecify a single host.
4855682Smarkm.sp
4955682SmarkmThis option has not been fully documented.
5072445Sassar.sp
5172445Sassar.B
5272445SassarNOTE: THIS OPTION IS DEPRECATED
5372445Sassar.It Fl \&? , Fl \-help
5455682SmarkmDisplay usage information and exit.
55178825Sdfr.It Fl \&! , Fl \-more\-help
56178825SdfrPass the extended usage information through a pager.
5755682Smarkm.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
58178825SdfrOutput version of program and exit.  The default mode is `v', a simple
5955682Smarkmversion.  The `c' mode will print copyright information and `n' will
6055682Smarkmprint the full copyright notice.
6155682Smarkm.El
6255682Smarkm.Sh "EXIT STATUS"
6355682SmarkmOne of the following exit values will be returned:
6455682Smarkm.Bl -tag
6555682Smarkm.It 0 " (EXIT_SUCCESS)"
6655682SmarkmSuccessful program execution.
6755682Smarkm.It 1 " (EXIT_FAILURE)"
6855682SmarkmThe operation failed or the command syntax was not valid.
6955682Smarkm.It 70 " (EX_SOFTWARE)"
7055682Smarkmlibopts had an internal operational error.  Please report
71178825Sdfrit to autogen\-users@lists.sourceforge.net.  Thank you.
7255682Smarkm.El
7355682Smarkm.Sh "NOTES"
7455682SmarkmThis manual page was \fIAutoGen\fP\-erated from the \fBntpsweep\fP
7555682Smarkmoption definitions.
76178825Sdfr