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