aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/ntp/scripts/ntpsweep/ntpsweep.html
blob: 8f09545ad95e554ffa7b6ca4db57b40c8ffb4355 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<html lang="en">
<head>
<title>ntpsweep User's Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="ntpsweep User's Manual">
<meta name="generator" content="makeinfo 4.7">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc { font-variant:small-caps }
  span.roman { font-family: serif; font-weight: normal; } 
--></style>
</head>
<body>
<h1 class="settitle">ntpsweep User's Manual</h1>
<div class="node">
<p><hr>
<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
<br>
</div>

  <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program.

  <p>This document applies to version 4.2.8p9 of <code>ntpsweep</code>.

  <div class="shortcontents">
<h2>Short Contents</h2>
<ul>
</ul>
</div>

<ul class="menu">
<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>:             Description
<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: 		Invoking ntpsweep
</ul>

<div class="node">
<p><hr>
<a name="ntpsweep-Invocation"></a>
<br>
</div>

<h3 class="section">0.1 Invoking ntpsweep</h3>

<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a>
<code>ntpsweep</code>
prints per host the NTP stratum level, the clock offset in seconds, the daemon
version, the operating system and the processor. Optionally recursing through
all peers.

  <p>This section was generated by <strong>AutoGen</strong>,
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program.

<ul class="menu">
<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>:                   ntpsweep help/usage (<span class="option">--help</span>)
<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>:               host-list option (-l)
<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>:                   peers option (-p)
<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>:                maxlevel option (-m)
<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>:                   strip option (-s)
<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>:                    host option (-h)
<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>:             exit status
</ul>

<div class="node">
<p><hr>
<a name="ntpsweep-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4>

<p><a name="index-ntpsweep-help-3"></a>
This is the automatically generated usage text for ntpsweep.

  <p>The text printed is the same whether selected with the <code>help</code> option
(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
the usage text by passing it through a pager program. 
<code>more-help</code> is disabled on platforms without a working
<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
used to select the program, defaulting to <span class="file">more</span>.  Both will exit
with a status code of 0.

<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p9
USAGE: ntpsweep [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]... [hostfile]

    -l, --host-list=str          Host to execute actions on
                                   - may appear multiple times
    -p, --peers                  Recursively list all peers a host synchronizes to
    -m, --maxlevel=num           Traverse peers up to this level (4 is a reasonable number)
    -s, --strip=str              Strip this string from hostnames
    -?, --help                   Display usage information and exit
        --more-help              Pass the extended usage text through a pager

Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
</pre>
  <div class="node">
<p><hr>
<a name="ntpsweep-host_002dlist"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.2 host-list option (-l)</h4>

<p><a name="index-ntpsweep_002dhost_002dlist-4"></a>
This is the &ldquo;host to execute actions on&rdquo; option. 
This option takes a string argument.

<p class="noindent">This option has some usage constraints.  It:
     <ul>
<li>may appear an unlimited number of times. 
</ul>

  <p>Use this option to specify the host on which this script operates. 
            May appear multiple times. 
<div class="node">
<p><hr>
<a name="ntpsweep-peers"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.3 peers option (-p)</h4>

<p><a name="index-ntpsweep_002dpeers-5"></a>
This is the &ldquo;recursively list all peers a host synchronizes to&rdquo; option. 
This option has no <span class="samp">doc</span> documentation. 
<div class="node">
<p><hr>
<a name="ntpsweep-maxlevel"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.4 maxlevel option (-m)</h4>

<p><a name="index-ntpsweep_002dmaxlevel-6"></a>
This is the &ldquo;traverse peers up to this level (4 is a reasonable number)&rdquo; option. 
This option takes a number argument. 
This option has no <span class="samp">doc</span> documentation. 
<div class="node">
<p><hr>
<a name="ntpsweep-strip"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.5 strip option (-s)</h4>

<p><a name="index-ntpsweep_002dstrip-7"></a>
This is the &ldquo;strip this string from hostnames&rdquo; option. 
This option takes a string argument. 
This option has no <span class="samp">doc</span> documentation. 
<div class="node">
<p><hr>
<a name="ntpsweep-host"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.6 host option (-h)</h4>

<p><a name="index-ntpsweep_002dhost-8"></a>
This is the &ldquo;specify a single host&rdquo; option. 
This option takes a string argument. 
This option has no <span class="samp">doc</span> documentation.

  <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong>
<div class="node">
<p><hr>
<a name="ntpsweep-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a>
<br>
</div>

<h4 class="subsection">0.1.7 ntpsweep exit status</h4>

<p>One of the following exit values will be returned:
     <dl>
<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
</dl>

</body></html>