ntpsweep.mdoc.in revision 293650
1232366Sdavide.Dd January 7 2016
2232366Sdavide.Dt NTPSWEEP 1ntpsweepmdoc User Commands
3232366Sdavide.Os
4232366Sdavide.\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
5232366Sdavide.\"
6232366Sdavide.\"  It has been AutoGen-ed  January  7, 2016 at 11:26:50 PM by AutoGen 5.18.5
7232366Sdavide.\"  From the definitions    ntpsweep-opts.def
8232366Sdavide.\"  and the template file   agmdoc-cmd.tpl
9232366Sdavide.Sh NAME
10232366Sdavide.Nm ntpsweep
11232366Sdavide.Nd Print various informations about given ntp servers
12232366Sdavide.Sh SYNOPSIS
13232366Sdavide.Nm
14232366Sdavide.\" Mixture of short (flag) options and long options
15232366Sdavide.Op Fl flags
16232366Sdavide.Op Fl flag Op Ar value
17232366Sdavide.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18232366Sdavide[hostfile]
19232366Sdavide.Pp
20232366Sdavide.Sh DESCRIPTION
21232366Sdavide.Nm 
22232366Sdavideprints per host the NTP stratum level, the clock offset in seconds, the daemon
23232366Sdavideversion, the operating system and the processor. Optionally recursing through
24232366Sdavideall peers.
25232366Sdavide.Sh "OPTIONS"
26232366Sdavide.Bl -tag
27241741Ssbruno.It  Fl l Ar string , Fl \-host\-list Ns = Ns Ar string 
28232377SpluknetHost to execute actions on.
29232377SpluknetThis option may appear an unlimited number of times.
30232366Sdavide.sp
31232366Sdavide            Use this option to specify the host on which this script operates.
32232377Spluknet            May appear multiple times.
33232366Sdavide.It  Fl p , Fl \-peers 
34232366SdavideRecursively list all peers a host synchronizes to.
35232366Sdavide.sp
36232366SdavideThis option has not been fully documented.
37232366Sdavide.It  Fl m Ar number , Fl \-maxlevel Ns = Ns Ar number 
38232366SdavideTraverse peers up to this level (4 is a reasonable number).
39232366SdavideThis option takes an integer number as its argument.
40232366Sdavide.sp
41232366SdavideThis option has not been fully documented.
42232366Sdavide.It  Fl s Ar string , Fl \-strip Ns = Ns Ar string 
43232366SdavideStrip this string from hostnames.
44232366Sdavide.sp
45232366SdavideThis option has not been fully documented.
46232366Sdavide.It  Fl h Ar string , Fl \-host Ns = Ns Ar string 
47232366SdavideSpecify a single host.
48232366Sdavide.sp
49232366SdavideThis option has not been fully documented.
50232366Sdavide.sp
51232366Sdavide.B
52232366SdavideNOTE: THIS OPTION IS DEPRECATED
53232366Sdavide.It Fl \&? , Fl \-help
54232366SdavideDisplay usage information and exit.
55232366Sdavide.It Fl \&! , Fl \-more\-help
56232366SdavidePass the extended usage information through a pager.
57232366Sdavide.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
58232366SdavideOutput version of program and exit.  The default mode is `v', a simple
59232377Spluknetversion.  The `c' mode will print copyright information and `n' will
60232366Sdavideprint the full copyright notice.
61232366Sdavide.El
62232377Spluknet.Sh "EXIT STATUS"
63232366SdavideOne of the following exit values will be returned:
64232366Sdavide.Bl -tag
65232366Sdavide.It 0 " (EXIT_SUCCESS)"
66232366SdavideSuccessful program execution.
67232366Sdavide.It 1 " (EXIT_FAILURE)"
68232366SdavideThe operation failed or the command syntax was not valid.
69232366Sdavide.It 70 " (EX_SOFTWARE)"
70232366Sdavidelibopts had an internal operational error.  Please report
71232366Sdavideit to autogen\-users@lists.sourceforge.net.  Thank you.
72232366Sdavide.El
73232366Sdavide.Sh "NOTES"
74232366SdavideThis manual page was \fIAutoGen\fP\-erated from the \fBntpsweep\fP
75232366Sdavideoption definitions.
76232366Sdavide