3 <title>ntpsweep User's Manual</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="ntpsweep User's Manual">
6 <meta name="generator" content="makeinfo 4.7">
7 <link title="Top" rel="top" href="#Top">
8 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9 <meta http-equiv="Content-Style-Type" content="text/css">
10 <style type="text/css"><!--
11 pre.display { font-family:inherit }
12 pre.format { font-family:inherit }
13 pre.smalldisplay { font-family:inherit; font-size:smaller }
14 pre.smallformat { font-family:inherit; font-size:smaller }
15 pre.smallexample { font-size:smaller }
16 pre.smalllisp { font-size:smaller }
17 span.sc { font-variant:small-caps }
18 span.roman { font-family: serif; font-weight: normal; }
22 <h1 class="settitle">ntpsweep User's Manual</h1>
25 <a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>,
26 Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27 Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
31 <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program.
33 <p>This document applies to version 4.2.8p5 of <code>ntpsweep</code>.
35 <div class="shortcontents">
36 <h2>Short Contents</h2>
42 <li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description
43 <li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep
48 <a name="ntpsweep-Invocation"></a>
52 <h3 class="section">0.1 Invoking ntpsweep</h3>
54 <p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a>
56 prints per host the NTP stratum level, the clock offset in seconds, the daemon
57 version, the operating system and the processor. Optionally recursing through
60 <p>This section was generated by <strong>AutoGen</strong>,
61 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program.
64 <li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>)
65 <li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l)
66 <li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p)
67 <li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m)
68 <li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s)
69 <li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h)
70 <li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status
75 <a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
76 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
80 <h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4>
82 <p><a name="index-ntpsweep-help-3"></a>
83 This is the automatically generated usage text for ntpsweep.
85 <p>The text printed is the same whether selected with the <code>help</code> option
86 (<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print
87 the usage text by passing it through a pager program.
88 <code>more-help</code> is disabled on platforms without a working
89 <code>fork(2)</code> function. The <code>PAGER</code> environment variable is
90 used to select the program, defaulting to <span class="file">more</span>. Both will exit
91 with a status code of 0.
93 <pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p5
94 USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile]
96 -l, --host-list=str Host to execute actions on
97 - may appear multiple times
98 -p, --peers Recursively list all peers a host synchronizes to
99 -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number)
100 -s, --strip=str Strip this string from hostnames
101 -?, --help Display usage information and exit
102 --more-help Pass the extended usage text through a pager
104 Options are specified by doubled hyphens and their name or by a single
105 hyphen and the flag character.
109 <a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>,
110 Previous: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>,
111 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
115 <h4 class="subsection">0.1.2 host-list option (-l)</h4>
117 <p><a name="index-ntpsweep_002dhost_002dlist-4"></a>
118 This is the “host to execute actions on” option.
119 This option takes a string argument.
121 <p class="noindent">This option has some usage constraints. It:
123 <li>may appear an unlimited number of times.
126 <p>Use this option to specify the host on which this script operates.
127 May appear multiple times.
130 <a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
131 Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
132 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
136 <h4 class="subsection">0.1.3 peers option (-p)</h4>
138 <p><a name="index-ntpsweep_002dpeers-5"></a>
139 This is the “recursively list all peers a host synchronizes to” option.
140 This option has no <span class="samp">doc</span> documentation.
143 <a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>,
144 Previous: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>,
145 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
149 <h4 class="subsection">0.1.4 maxlevel option (-m)</h4>
151 <p><a name="index-ntpsweep_002dmaxlevel-6"></a>
152 This is the “traverse peers up to this level (4 is a reasonable number)” option.
153 This option takes a number argument.
154 This option has no <span class="samp">doc</span> documentation.
157 <a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>,
158 Previous: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
159 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
163 <h4 class="subsection">0.1.5 strip option (-s)</h4>
165 <p><a name="index-ntpsweep_002dstrip-7"></a>
166 This is the “strip this string from hostnames” option.
167 This option takes a string argument.
168 This option has no <span class="samp">doc</span> documentation.
171 <a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>,
172 Previous: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>,
173 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
177 <h4 class="subsection">0.1.6 host option (-h)</h4>
179 <p><a name="index-ntpsweep_002dhost-8"></a>
180 This is the “specify a single host” option.
181 This option takes a string argument.
182 This option has no <span class="samp">doc</span> documentation.
184 <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong>
187 <a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>,
188 Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
192 <h4 class="subsection">0.1.7 ntpsweep exit status</h4>
194 <p>One of the following exit values will be returned:
196 <dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution.
197 <br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid.