xref: /freebsd/contrib/ntp/scripts/ntpsweep/ntpsweep.mdoc.in (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
1.Dd June 2 2016
2.Dt NTPSWEEP 1ntpsweepmdoc User Commands
3.Os
4.\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
5.\"
6.\"  It has been AutoGen-ed  June  2, 2016 at 07:24:55 AM by AutoGen 5.18.5
7.\"  From the definitions    ntpsweep-opts.def
8.\"  and the template file   agmdoc-cmd.tpl
9.Sh NAME
10.Nm ntpsweep
11.Nd Print various informations about given ntp servers
12.Sh SYNOPSIS
13.Nm
14.\" Mixture of short (flag) options and long options
15.Op Fl flags
16.Op Fl flag Op Ar value
17.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18[hostfile]
19.Pp
20.Sh DESCRIPTION
21.Nm
22prints per host the NTP stratum level, the clock offset in seconds, the daemon
23version, the operating system and the processor. Optionally recursing through
24all peers.
25.Sh "OPTIONS"
26.Bl -tag
27.It  Fl l Ar string , Fl \-host\-list Ns = Ns Ar string
28Host to execute actions on.
29This option may appear an unlimited number of times.
30.sp
31            Use this option to specify the host on which this script operates.
32            May appear multiple times.
33.It  Fl p , Fl \-peers
34Recursively list all peers a host synchronizes to.
35.sp
36This option has not been fully documented.
37.It  Fl m Ar number , Fl \-maxlevel Ns = Ns Ar number
38Traverse peers up to this level (4 is a reasonable number).
39This option takes an integer number as its argument.
40.sp
41This option has not been fully documented.
42.It  Fl s Ar string , Fl \-strip Ns = Ns Ar string
43Strip this string from hostnames.
44.sp
45This option has not been fully documented.
46.It  Fl h Ar string , Fl \-host Ns = Ns Ar string
47Specify a single host.
48.sp
49This option has not been fully documented.
50.sp
51.B
52NOTE: THIS OPTION IS DEPRECATED
53.It Fl \&? , Fl \-help
54Display usage information and exit.
55.It Fl \&! , Fl \-more\-help
56Pass the extended usage information through a pager.
57.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
58Output version of program and exit.  The default mode is `v', a simple
59version.  The `c' mode will print copyright information and `n' will
60print the full copyright notice.
61.El
62.Sh "EXIT STATUS"
63One of the following exit values will be returned:
64.Bl -tag
65.It 0 " (EXIT_SUCCESS)"
66Successful program execution.
67.It 1 " (EXIT_FAILURE)"
68The operation failed or the command syntax was not valid.
69.It 70 " (EX_SOFTWARE)"
70libopts had an internal operational error.  Please report
71it to autogen\-users@lists.sourceforge.net.  Thank you.
72.El
73.Sh "NOTES"
74This manual page was \fIAutoGen\fP\-erated from the \fBntpsweep\fP
75option definitions.
76