ntpsweep.html revision 285612
11541Srgrimes<html lang="en"> 21541Srgrimes<head> 31541Srgrimes<title>ntpsweep User's Manual</title> 41541Srgrimes<meta http-equiv="Content-Type" content="text/html"> 51541Srgrimes<meta name="description" content="ntpsweep User's Manual"> 61541Srgrimes<meta name="generator" content="makeinfo 4.7"> 71541Srgrimes<link title="Top" rel="top" href="#Top"> 81541Srgrimes<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 91541Srgrimes<meta http-equiv="Content-Style-Type" content="text/css"> 101541Srgrimes<style type="text/css"><!-- 111541Srgrimes pre.display { font-family:inherit } 121541Srgrimes pre.format { font-family:inherit } 131541Srgrimes pre.smalldisplay { font-family:inherit; font-size:smaller } 141541Srgrimes pre.smallformat { font-family:inherit; font-size:smaller } 151541Srgrimes pre.smallexample { font-size:smaller } 161541Srgrimes pre.smalllisp { font-size:smaller } 171541Srgrimes span.sc { font-variant:small-caps } 181541Srgrimes span.roman { font-family: serif; font-weight: normal; } 191541Srgrimes--></style> 201541Srgrimes</head> 211541Srgrimes<body> 221541Srgrimes<h1 class="settitle">ntpsweep User's Manual</h1> 231541Srgrimes<div class="node"> 241541Srgrimes<p><hr> 251541Srgrimes<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 261541SrgrimesPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 271541SrgrimesUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 281541Srgrimes<br> 291541Srgrimes</div> 301541Srgrimes 311541Srgrimes <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 321541Srgrimes 3314482Shsu <p>This document applies to version 4.2.8p3 of <code>ntpsweep</code>. 3450477Speter 351541Srgrimes <div class="shortcontents"> 361541Srgrimes<h2>Short Contents</h2> 372165Spaul<ul> 382165Spaul</ul> 392165Spaul</div> 40102325Smike 41102325Smike<ul class="menu"> 4234319Sdufault<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 43102325Smike<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 441541Srgrimes</ul> 4582295Sdillon 4682295Sdillon<div class="node"> 4782295Sdillon<p><hr> 4882295Sdillon<a name="ntpsweep-Invocation"></a> 4982295Sdillon<br> 50102325Smike</div> 5182295Sdillon 5282295Sdillon<h3 class="section">0.1 Invoking ntpsweep</h3> 531541Srgrimes 541541Srgrimes<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 5514482Shsu<code>ntpsweep</code> 561541Srgrimesprints per host the NTP stratum level, the clock offset in seconds, the daemon 571541Srgrimesversion, the operating system and the processor. Optionally recursing through 581541Srgrimesall peers. 591541Srgrimes 601541Srgrimes <p>This section was generated by <strong>AutoGen</strong>, 611541Srgrimesusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 621541Srgrimes 631541Srgrimes<ul class="menu"> 649507Sdg<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) 659507Sdg<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 669507Sdg<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 671541Srgrimes<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 68102325Smike<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 691541Srgrimes<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 701541Srgrimes<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 711541Srgrimes</ul> 721541Srgrimes 731541Srgrimes<div class="node"> 741541Srgrimes<p><hr> 7582295Sdillon<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 7682285SdillonUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 771541Srgrimes<br> 7842360Sjulian</div> 7957550Sps 801541Srgrimes<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> 8157550Sps 82102325Smike<p><a name="index-ntpsweep-help-3"></a> 83102325SmikeThis is the automatically generated usage text for ntpsweep. 84102325Smike 85102325Smike <p>The text printed is the same whether selected with the <code>help</code> option 86102325Smike(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 87102325Smikethe usage text by passing it through a pager program. 8857550Sps<code>more-help</code> is disabled on platforms without a working 8957550Sps<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 9057550Spsused to select the program, defaulting to <span class="file">more</span>. Both will exit 91102325Smikewith a status code of 0. 9257550Sps 93102325Smike<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p3 941541SrgrimesUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 9534030Sdufault 9634030Sdufault -l, --host-list=str Host to execute actions on 9734030Sdufault - may appear multiple times 9834030Sdufault -p, --peers Recursively list all peers a host synchronizes to 99102325Smike -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 10034030Sdufault -s, --strip=str Strip this string from hostnames 10134030Sdufault -?, --help Display usage information and exit 10220346Salex --more-help Pass the extended usage text through a pager 10320346Salex 10432131SalexOptions are specified by doubled hyphens and their name or by a single 10520346Salexhyphen and the flag character. 10620346Salex</pre> 1077358Sdg <div class="node"> 1087358Sdg<p><hr> 10931497Sdyson<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 1107358SdgPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 1117358SdgUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 1127358Sdg<br> 113102325Smike</div> 1147358Sdg 1151541Srgrimes<h4 class="subsection">0.1.2 host-list option (-l)</h4> 1161541Srgrimes 1171541Srgrimes<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> 1181541SrgrimesThis is the “host to execute actions on” option. 1191541SrgrimesThis option takes a string argument. 1201541Srgrimes 1211541Srgrimes<p class="noindent">This option has some usage constraints. It: 12215873Sdyson <ul> 12354467Sdillon<li>may appear an unlimited number of times. 12454467Sdillon</ul> 12557550Sps 12657550Sps <p>Use this option to specify the host on which this script operates. 1271541Srgrimes May appear multiple times. 12815819Sdyson<div class="node"> 12915819Sdyson<p><hr> 13015819Sdyson<a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 13115819SdysonPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 13215819SdysonUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 13315819Sdyson<br> 13415819Sdyson</div> 13515819Sdyson 136102325Smike<h4 class="subsection">0.1.3 peers option (-p)</h4> 13715819Sdyson 138102325Smike<p><a name="index-ntpsweep_002dpeers-5"></a> 139102325SmikeThis is the “recursively list all peers a host synchronizes to” option. 140102325SmikeThis option has no <span class="samp">doc</span> documentation. 141102325Smike<div class="node"> 142102325Smike<p><hr> 143102325Smike<a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, 144102325SmikePrevious: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, 145102325SmikeUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 146102325Smike<br> 147102325Smike</div> 148102325Smike 149102325Smike<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> 150102325Smike 151102325Smike<p><a name="index-ntpsweep_002dmaxlevel-6"></a> 152102325SmikeThis is the “traverse peers up to this level (4 is a reasonable number)” option. 153102325SmikeThis option takes a number argument. 154102325SmikeThis option has no <span class="samp">doc</span> documentation. 155102325Smike<div class="node"> 156102325Smike<p><hr> 157102325Smike<a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, 15855205SpeterPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 1591541SrgrimesUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 1601541Srgrimes<br> 161102325Smike</div> 162102325Smike 163102325Smike<h4 class="subsection">0.1.5 strip option (-s)</h4> 164102325Smike 165102325Smike<p><a name="index-ntpsweep_002dstrip-7"></a> 166102325SmikeThis is the “strip this string from hostnames” option. 167102325SmikeThis option takes a string argument. 168102325SmikeThis option has no <span class="samp">doc</span> documentation. 169102325Smike<div class="node"> 170102325Smike<p><hr> 171102325Smike<a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, 17292719SalfredPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, 173102325SmikeUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 17424896Sbde<br> 17524896Sbde</div> 17692719Salfred 17724896Sbde<h4 class="subsection">0.1.6 host option (-h)</h4> 17892719Salfred 17992719Salfred<p><a name="index-ntpsweep_002dhost-8"></a> 18092719SalfredThis is the “specify a single host” option. 181102325SmikeThis option takes a string argument. 182102325SmikeThis option has no <span class="samp">doc</span> documentation. 183102325Smike 18492719Salfred <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 185102325Smike<div class="node"> 186102325Smike<p><hr> 187102325Smike<a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, 18834030SdufaultUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 1891541Srgrimes<br> 1901541Srgrimes</div> 19155205Speter 1922165Spaul<h4 class="subsection">0.1.7 ntpsweep exit status</h4> 193102325Smike 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