ntpsweep.html revision 293423
11573Srgrimes<html lang="en"> 21573Srgrimes<head> 31573Srgrimes<title>ntpsweep User's Manual</title> 41573Srgrimes<meta http-equiv="Content-Type" content="text/html"> 51573Srgrimes<meta name="description" content="ntpsweep User's Manual"> 61573Srgrimes<meta name="generator" content="makeinfo 4.7"> 71573Srgrimes<link title="Top" rel="top" href="#Top"> 81573Srgrimes<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 91573Srgrimes<meta http-equiv="Content-Style-Type" content="text/css"> 101573Srgrimes<style type="text/css"><!-- 111573Srgrimes pre.display { font-family:inherit } 121573Srgrimes pre.format { font-family:inherit } 131573Srgrimes pre.smalldisplay { font-family:inherit; font-size:smaller } 141573Srgrimes pre.smallformat { font-family:inherit; font-size:smaller } 151573Srgrimes pre.smallexample { font-size:smaller } 161573Srgrimes pre.smalllisp { font-size:smaller } 171573Srgrimes span.sc { font-variant:small-caps } 181573Srgrimes span.roman { font-family: serif; font-weight: normal; } 191573Srgrimes--></style> 201573Srgrimes</head> 211573Srgrimes<body> 221573Srgrimes<h1 class="settitle">ntpsweep User's Manual</h1> 231573Srgrimes<div class="node"> 241573Srgrimes<p><hr> 251573Srgrimes<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 261573SrgrimesPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 271573SrgrimesUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 281573Srgrimes<br> 291573Srgrimes</div> 301573Srgrimes 311573Srgrimes <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 3265632Sphk 3365632Sphk <p>This document applies to version 4.2.8p5 of <code>ntpsweep</code>. 341573Srgrimes 351573Srgrimes <div class="shortcontents"> 361573Srgrimes<h2>Short Contents</h2> 3723658Speter<ul> 381573Srgrimes</ul> 391573Srgrimes</div> 401573Srgrimes 4165632Sphk<ul class="menu"> 421573Srgrimes<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 431573Srgrimes<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 441573Srgrimes</ul> 451573Srgrimes 461573Srgrimes<div class="node"> 471573Srgrimes<p><hr> 481573Srgrimes<a name="ntpsweep-Invocation"></a> 4965955Sphk<br> 5048882Sphk</div> 511573Srgrimes 5248882Sphk<h3 class="section">0.1 Invoking ntpsweep</h3> 5348882Sphk 541573Srgrimes<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 551573Srgrimes<code>ntpsweep</code> 561573Srgrimesprints per host the NTP stratum level, the clock offset in seconds, the daemon 571573Srgrimesversion, the operating system and the processor. Optionally recursing through 581573Srgrimesall peers. 591573Srgrimes 601573Srgrimes <p>This section was generated by <strong>AutoGen</strong>, 611573Srgrimesusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 621573Srgrimes 631573Srgrimes<ul class="menu"> 641573Srgrimes<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) 651573Srgrimes<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 6665955Sphk<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 671573Srgrimes<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 681573Srgrimes<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 6923658Speter<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 701573Srgrimes<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 711573Srgrimes</ul> 721573Srgrimes 731573Srgrimes<div class="node"> 741573Srgrimes<p><hr> 751573Srgrimes<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 761573SrgrimesUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 771573Srgrimes<br> 781573Srgrimes</div> 791573Srgrimes 801573Srgrimes<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> 8123658Speter 821573Srgrimes<p><a name="index-ntpsweep-help-3"></a> 8348882SphkThis is the automatically generated usage text for ntpsweep. 8448882Sphk 8548882Sphk <p>The text printed is the same whether selected with the <code>help</code> option 8648882Sphk(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 8748882Sphkthe usage text by passing it through a pager program. 8848882Sphk<code>more-help</code> is disabled on platforms without a working 8965955Sphk<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 9080552Stmmused to select the program, defaulting to <span class="file">more</span>. Both will exit 9180552Stmmwith a status code of 0. 9248882Sphk 9348882Sphk<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p5 9465632SphkUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 9548882Sphk 9665632Sphk -l, --host-list=str Host to execute actions on 9765632Sphk - may appear multiple times 9865632Sphk -p, --peers Recursively list all peers a host synchronizes to 9965632Sphk -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 10065632Sphk -s, --strip=str Strip this string from hostnames 10165632Sphk -?, --help Display usage information and exit 10265632Sphk --more-help Pass the extended usage text through a pager 10365632Sphk 10465632SphkOptions are specified by doubled hyphens and their name or by a single 10548882Sphkhyphen and the flag character. 10665632Sphk</pre> 10765632Sphk <div class="node"> 10865955Sphk<p><hr> 10965955Sphk<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 11065955SphkPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 11165955SphkUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 11265955Sphk<br> 11365955Sphk</div> 11465955Sphk 11548882Sphk<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