ntpsweep.html revision 294569
1238423Sjhb<html lang="en"> 2238423Sjhb<head> 3283927Sjhb<title>ntpsweep User's Manual</title> 4238423Sjhb<meta http-equiv="Content-Type" content="text/html"> 5238423Sjhb<meta name="description" content="ntpsweep User's Manual"> 6238423Sjhb<meta name="generator" content="makeinfo 4.7"> 7238423Sjhb<link title="Top" rel="top" href="#Top"> 8238423Sjhb<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9238423Sjhb<meta http-equiv="Content-Style-Type" content="text/css"> 10238423Sjhb<style type="text/css"><!-- 11238423Sjhb pre.display { font-family:inherit } 12238423Sjhb pre.format { font-family:inherit } 13238423Sjhb pre.smalldisplay { font-family:inherit; font-size:smaller } 14238423Sjhb pre.smallformat { font-family:inherit; font-size:smaller } 15238423Sjhb pre.smallexample { font-size:smaller } 16238423Sjhb pre.smalllisp { font-size:smaller } 17238423Sjhb span.sc { font-variant:small-caps } 18238423Sjhb span.roman { font-family: serif; font-weight: normal; } 19238423Sjhb--></style> 20238423Sjhb</head> 21238423Sjhb<body> 22238423Sjhb<h1 class="settitle">ntpsweep User's Manual</h1> 23238423Sjhb<div class="node"> 24238423Sjhb<p><hr> 25238423Sjhb<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 26238423SjhbPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27238423SjhbUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28238423Sjhb<br> 29238423Sjhb</div> 30238423Sjhb 31238423Sjhb <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 32263221Sjmmv 33238423Sjhb <p>This document applies to version 4.2.8p6 of <code>ntpsweep</code>. 34238423Sjhb 35238423Sjhb <div class="shortcontents"> 36238423Sjhb<h2>Short Contents</h2> 37258063Sjhb<ul> 38238423Sjhb</ul> 39238423Sjhb</div> 40238423Sjhb 41258063Sjhb<ul class="menu"> 42258063Sjhb<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 43258063Sjhb<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 44238423Sjhb</ul> 45258063Sjhb 46258063Sjhb<div class="node"> 47258063Sjhb<p><hr> 48238423Sjhb<a name="ntpsweep-Invocation"></a> 49238423Sjhb<br> 50238423Sjhb</div> 51238423Sjhb 52238423Sjhb<h3 class="section">0.1 Invoking ntpsweep</h3> 53238423Sjhb 54238423Sjhb<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 55238423Sjhb<code>ntpsweep</code> 56238423Sjhbprints per host the NTP stratum level, the clock offset in seconds, the daemon 57238423Sjhbversion, the operating system and the processor. Optionally recursing through 58238423Sjhball peers. 59238423Sjhb 60238423Sjhb <p>This section was generated by <strong>AutoGen</strong>, 61238423Sjhbusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 62238423Sjhb 63238423Sjhb<ul class="menu"> 64238423Sjhb<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) 65238423Sjhb<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 66238423Sjhb<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 67238423Sjhb<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 68238423Sjhb<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 69238423Sjhb<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 70238423Sjhb<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 71238423Sjhb</ul> 72238423Sjhb 73238423Sjhb<div class="node"> 74238423Sjhb<p><hr> 75238423Sjhb<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 76238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 77238423Sjhb<br> 78238423Sjhb</div> 79238423Sjhb 80238423Sjhb<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> 81238423Sjhb 82238423Sjhb<p><a name="index-ntpsweep-help-3"></a> 83238423SjhbThis is the automatically generated usage text for ntpsweep. 84238423Sjhb 85238423Sjhb <p>The text printed is the same whether selected with the <code>help</code> option 86238423Sjhb(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 87238423Sjhbthe usage text by passing it through a pager program. 88238423Sjhb<code>more-help</code> is disabled on platforms without a working 89238423Sjhb<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 90238423Sjhbused to select the program, defaulting to <span class="file">more</span>. Both will exit 91238423Sjhbwith a status code of 0. 92238423Sjhb 93238423Sjhb<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p6 94238423SjhbUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 95238423Sjhb 96238423Sjhb -l, --host-list=str Host to execute actions on 97238423Sjhb - may appear multiple times 98238423Sjhb -p, --peers Recursively list all peers a host synchronizes to 99238423Sjhb -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 100238423Sjhb -s, --strip=str Strip this string from hostnames 101238423Sjhb -?, --help Display usage information and exit 102238423Sjhb --more-help Pass the extended usage text through a pager 103238423Sjhb 104238423SjhbOptions are specified by doubled hyphens and their name or by a single 105238423Sjhbhyphen and the flag character. 106238423Sjhb</pre> 107238423Sjhb <div class="node"> 108238423Sjhb<p><hr> 109238423Sjhb<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 110238423SjhbPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 111238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 112238423Sjhb<br> 113238423Sjhb</div> 114238423Sjhb 115238423Sjhb<h4 class="subsection">0.1.2 host-list option (-l)</h4> 116238423Sjhb 117238423Sjhb<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> 118238423SjhbThis is the “host to execute actions on” option. 119238423SjhbThis option takes a string argument. 120238423Sjhb 121238423Sjhb<p class="noindent">This option has some usage constraints. It: 122238423Sjhb <ul> 123238423Sjhb<li>may appear an unlimited number of times. 124238423Sjhb</ul> 125238423Sjhb 126238423Sjhb <p>Use this option to specify the host on which this script operates. 127238423Sjhb May appear multiple times. 128238423Sjhb<div class="node"> 129238423Sjhb<p><hr> 130238423Sjhb<a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 131238423SjhbPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 132238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 133238423Sjhb<br> 134238423Sjhb</div> 135238423Sjhb 136238423Sjhb<h4 class="subsection">0.1.3 peers option (-p)</h4> 137238423Sjhb 138238423Sjhb<p><a name="index-ntpsweep_002dpeers-5"></a> 139238423SjhbThis is the “recursively list all peers a host synchronizes to” option. 140238423SjhbThis option has no <span class="samp">doc</span> documentation. 141238423Sjhb<div class="node"> 142238423Sjhb<p><hr> 143238423Sjhb<a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, 144238423SjhbPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, 145238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 146238423Sjhb<br> 147238423Sjhb</div> 148238423Sjhb 149238423Sjhb<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> 150238423Sjhb 151238423Sjhb<p><a name="index-ntpsweep_002dmaxlevel-6"></a> 152238423SjhbThis is the “traverse peers up to this level (4 is a reasonable number)” option. 153238423SjhbThis option takes a number argument. 154238423SjhbThis option has no <span class="samp">doc</span> documentation. 155238423Sjhb<div class="node"> 156238423Sjhb<p><hr> 157238423Sjhb<a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, 158238423SjhbPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 159238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 160238423Sjhb<br> 161238423Sjhb</div> 162238423Sjhb 163238423Sjhb<h4 class="subsection">0.1.5 strip option (-s)</h4> 164238423Sjhb 165238423Sjhb<p><a name="index-ntpsweep_002dstrip-7"></a> 166238423SjhbThis is the “strip this string from hostnames” option. 167238423SjhbThis option takes a string argument. 168238423SjhbThis option has no <span class="samp">doc</span> documentation. 169238423Sjhb<div class="node"> 170238423Sjhb<p><hr> 171238423Sjhb<a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, 172238423SjhbPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, 173238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 174238423Sjhb<br> 175238423Sjhb</div> 176238423Sjhb 177238423Sjhb<h4 class="subsection">0.1.6 host option (-h)</h4> 178238423Sjhb 179238423Sjhb<p><a name="index-ntpsweep_002dhost-8"></a> 180238423SjhbThis is the “specify a single host” option. 181238423SjhbThis option takes a string argument. 182238423SjhbThis option has no <span class="samp">doc</span> documentation. 183238423Sjhb 184238423Sjhb <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 185238423Sjhb<div class="node"> 186238423Sjhb<p><hr> 187238423Sjhb<a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, 188238423SjhbUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 189238423Sjhb<br> 190238423Sjhb</div> 191238423Sjhb 192238423Sjhb<h4 class="subsection">0.1.7 ntpsweep exit status</h4> 193238423Sjhb 194238423Sjhb<p>One of the following exit values will be returned: 195238423Sjhb <dl> 196238423Sjhb<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 197238423Sjhb<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 198238423Sjhb</dl> 199238423Sjhb 200238423Sjhb</body></html> 201238423Sjhb 202238423Sjhb