1 @node ntpsweep Invocation
2 @section Invoking ntpsweep
4 @cindex Print various informations about given ntp servers
7 # EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi)
9 # It has been AutoGen-ed October 21, 2015 at 12:34:18 PM by AutoGen 5.18.5
10 # From the definitions ntpsweep-opts.def
11 # and the template file agtexi-cmd.tpl
15 prints per host the NTP stratum level, the clock offset in seconds, the daemon
16 version, the operating system and the processor. Optionally recursing through
19 This section was generated by @strong{AutoGen},
20 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program.
23 * ntpsweep usage:: ntpsweep help/usage (@option{--help})
24 * ntpsweep host-list:: host-list option (-l)
25 * ntpsweep peers:: peers option (-p)
26 * ntpsweep maxlevel:: maxlevel option (-m)
27 * ntpsweep strip:: strip option (-s)
28 * ntpsweep host:: host option (-h)
29 * ntpsweep exit status:: exit status
33 @subsection ntpsweep help/usage (@option{--help})
36 This is the automatically generated usage text for ntpsweep.
38 The text printed is the same whether selected with the @code{help} option
39 (@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
40 the usage text by passing it through a pager program.
41 @code{more-help} is disabled on platforms without a working
42 @code{fork(2)} function. The @code{PAGER} environment variable is
43 used to select the program, defaulting to @file{more}. Both will exit
44 with a status code of 0.
48 ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p4
49 USAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile]
51 -l, --host-list=str Host to execute actions on
52 - may appear multiple times
53 -p, --peers Recursively list all peers a host synchronizes to
54 -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number)
55 -s, --strip=str Strip this string from hostnames
56 -?, --help Display usage information and exit
57 --more-help Pass the extended usage text through a pager
59 Options are specified by doubled hyphens and their name or by a single
60 hyphen and the flag character.
64 @node ntpsweep host-list
65 @subsection host-list option (-l)
66 @cindex ntpsweep-host-list
68 This is the ``host to execute actions on'' option.
69 This option takes a string argument.
72 This option has some usage constraints. It:
75 may appear an unlimited number of times.
78 Use this option to specify the host on which this script operates.
79 May appear multiple times.
81 @subsection peers option (-p)
82 @cindex ntpsweep-peers
84 This is the ``recursively list all peers a host synchronizes to'' option.
85 This option has no @samp{doc} documentation.
86 @node ntpsweep maxlevel
87 @subsection maxlevel option (-m)
88 @cindex ntpsweep-maxlevel
90 This is the ``traverse peers up to this level (4 is a reasonable number)'' option.
91 This option takes a number argument.
92 This option has no @samp{doc} documentation.
94 @subsection strip option (-s)
95 @cindex ntpsweep-strip
97 This is the ``strip this string from hostnames'' option.
98 This option takes a string argument.
99 This option has no @samp{doc} documentation.
101 @subsection host option (-h)
102 @cindex ntpsweep-host
104 This is the ``specify a single host'' option.
105 This option takes a string argument.
106 This option has no @samp{doc} documentation.
108 @strong{NOTE}@strong{: THIS OPTION IS DEPRECATED}
109 @node ntpsweep exit status
110 @subsection ntpsweep exit status
112 One of the following exit values will be returned:
114 @item 0 (EXIT_SUCCESS)
115 Successful program execution.
116 @item 1 (EXIT_FAILURE)
117 The operation failed or the command syntax was not valid.