1<html lang="en"> 2<head> 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.8"> 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; } 19 span.sansserif { font-family:sans-serif; font-weight:normal; } 20--></style> 21</head> 22<body> 23<h1 class="settitle">ntpsweep User's Manual</h1> 24<div class="node"> 25<p><hr> 26<a name="Top"></a> 27Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 28Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 29Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 30 31</div> 32 33 <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 34 35 <p>This document applies to version 4.2.8p5 of <code>ntpsweep</code>. 36 37 <div class="shortcontents"> 38<h2>Short Contents</h2> 39<ul> 40</ul> 41</div> 42 43<ul class="menu"> 44<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 45<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 46</ul> 47 48<div class="node"> 49<p><hr> 50<a name="ntpsweep-Invocation"></a> 51 52 53</div> 54 55<h3 class="section">0.1 Invoking ntpsweep</h3> 56 57<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 58<code>ntpsweep</code> 59prints per host the NTP stratum level, the clock offset in seconds, the daemon 60version, the operating system and the processor. Optionally recursing through 61all peers. 62 63 <p>This section was generated by <strong>AutoGen</strong>, 64using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 65 66<ul class="menu"> 67<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<samp><span class="option">--help</span></samp>) 68<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 69<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 70<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 71<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 72<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 73<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 74</ul> 75 76<div class="node"> 77<p><hr> 78<a name="ntpsweep-usage"></a> 79Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 80Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 81 82</div> 83 84<h4 class="subsection">0.1.1 ntpsweep help/usage (<samp><span class="option">--help</span></samp>)</h4> 85 86<p><a name="index-ntpsweep-help-3"></a> 87This is the automatically generated usage text for ntpsweep. 88 89 <p>The text printed is the same whether selected with the <code>help</code> option 90(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <code>more-help</code> will print 91the usage text by passing it through a pager program. 92<code>more-help</code> is disabled on platforms without a working 93<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 94used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit 95with a status code of 0. 96 97<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p5 98USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 99 100 -l, --host-list=str Host to execute actions on 101 - may appear multiple times 102 -p, --peers Recursively list all peers a host synchronizes to 103 -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 104 -s, --strip=str Strip this string from hostnames 105 -?, --help Display usage information and exit 106 --more-help Pass the extended usage text through a pager 107 108Options are specified by doubled hyphens and their name or by a single 109hyphen and the flag character. 110</pre> 111 <div class="node"> 112<p><hr> 113<a name="ntpsweep-host-list"></a> 114<a name="ntpsweep-host_002dlist"></a> 115Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 116Previous: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 117Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 118 119</div> 120 121<h4 class="subsection">0.1.2 host-list option (-l)</h4> 122 123<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> 124This is the “host to execute actions on” option. 125This option takes a string argument. 126 127<p class="noindent">This option has some usage constraints. It: 128 <ul> 129<li>may appear an unlimited number of times. 130</ul> 131 132 <p>Use this option to specify the host on which this script operates. 133 May appear multiple times. 134<div class="node"> 135<p><hr> 136<a name="ntpsweep-peers"></a> 137Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 138Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 139Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 140 141</div> 142 143<h4 class="subsection">0.1.3 peers option (-p)</h4> 144 145<p><a name="index-ntpsweep_002dpeers-5"></a> 146This is the “recursively list all peers a host synchronizes to” option. 147This option has no `<samp><span class="samp">doc</span></samp>' documentation. 148<div class="node"> 149<p><hr> 150<a name="ntpsweep-maxlevel"></a> 151Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, 152Previous: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, 153Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 154 155</div> 156 157<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> 158 159<p><a name="index-ntpsweep_002dmaxlevel-6"></a> 160This is the “traverse peers up to this level (4 is a reasonable number)” option. 161This option takes a number argument. 162This option has no `<samp><span class="samp">doc</span></samp>' documentation. 163<div class="node"> 164<p><hr> 165<a name="ntpsweep-strip"></a> 166Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, 167Previous: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 168Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 169 170</div> 171 172<h4 class="subsection">0.1.5 strip option (-s)</h4> 173 174<p><a name="index-ntpsweep_002dstrip-7"></a> 175This is the “strip this string from hostnames” option. 176This option takes a string argument. 177This option has no `<samp><span class="samp">doc</span></samp>' documentation. 178<div class="node"> 179<p><hr> 180<a name="ntpsweep-host"></a> 181Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, 182Previous: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, 183Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 184 185</div> 186 187<h4 class="subsection">0.1.6 host option (-h)</h4> 188 189<p><a name="index-ntpsweep_002dhost-8"></a> 190This is the “specify a single host” option. 191This option takes a string argument. 192This option has no `<samp><span class="samp">doc</span></samp>' documentation. 193 194 <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 195<div class="node"> 196<p><hr> 197<a name="ntpsweep-exit-status"></a> 198Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, 199Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 200 201</div> 202 203<h4 class="subsection">0.1.7 ntpsweep exit status</h4> 204 205<p>One of the following exit values will be returned: 206 <dl> 207<dt>`<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>'<dd>Successful program execution. 208<br><dt>`<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>'<dd>The operation failed or the command syntax was not valid. 209</dl> 210 211</body></html> 212 213