1275970Scy<html lang="en"> 2275970Scy<head> 3275970Scy<title>ntpsweep User's Manual</title> 4275970Scy<meta http-equiv="Content-Type" content="text/html"> 5275970Scy<meta name="description" content="ntpsweep User's Manual"> 6275970Scy<meta name="generator" content="makeinfo 4.7"> 7275970Scy<link title="Top" rel="top" href="#Top"> 8275970Scy<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9275970Scy<meta http-equiv="Content-Style-Type" content="text/css"> 10275970Scy<style type="text/css"><!-- 11275970Scy pre.display { font-family:inherit } 12275970Scy pre.format { font-family:inherit } 13275970Scy pre.smalldisplay { font-family:inherit; font-size:smaller } 14275970Scy pre.smallformat { font-family:inherit; font-size:smaller } 15275970Scy pre.smallexample { font-size:smaller } 16275970Scy pre.smalllisp { font-size:smaller } 17275970Scy span.sc { font-variant:small-caps } 18275970Scy span.roman { font-family: serif; font-weight: normal; } 19275970Scy--></style> 20275970Scy</head> 21275970Scy<body> 22275970Scy<h1 class="settitle">ntpsweep User's Manual</h1> 23275970Scy<div class="node"> 24275970Scy<p><hr> 25275970Scy<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 26275970ScyPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27275970ScyUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28275970Scy<br> 29275970Scy</div> 30275970Scy 31275970Scy <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 32275970Scy 33316722Sdelphij <p>This document applies to version 4.2.8p10 of <code>ntpsweep</code>. 34275970Scy 35275970Scy <div class="shortcontents"> 36275970Scy<h2>Short Contents</h2> 37275970Scy<ul> 38275970Scy</ul> 39275970Scy</div> 40275970Scy 41275970Scy<ul class="menu"> 42275970Scy<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 43275970Scy<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 44275970Scy</ul> 45275970Scy 46275970Scy<div class="node"> 47275970Scy<p><hr> 48275970Scy<a name="ntpsweep-Invocation"></a> 49275970Scy<br> 50275970Scy</div> 51275970Scy 52275970Scy<h3 class="section">0.1 Invoking ntpsweep</h3> 53275970Scy 54275970Scy<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 55275970Scy<code>ntpsweep</code> 56275970Scyprints per host the NTP stratum level, the clock offset in seconds, the daemon 57275970Scyversion, the operating system and the processor. Optionally recursing through 58275970Scyall peers. 59275970Scy 60275970Scy <p>This section was generated by <strong>AutoGen</strong>, 61275970Scyusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 62275970Scy 63275970Scy<ul class="menu"> 64275970Scy<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) 65275970Scy<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 66275970Scy<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 67275970Scy<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 68275970Scy<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 69275970Scy<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 70275970Scy<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 71275970Scy</ul> 72275970Scy 73275970Scy<div class="node"> 74275970Scy<p><hr> 75275970Scy<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 76275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 77275970Scy<br> 78275970Scy</div> 79275970Scy 80275970Scy<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> 81275970Scy 82275970Scy<p><a name="index-ntpsweep-help-3"></a> 83275970ScyThis is the automatically generated usage text for ntpsweep. 84275970Scy 85275970Scy <p>The text printed is the same whether selected with the <code>help</code> option 86275970Scy(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 87275970Scythe usage text by passing it through a pager program. 88275970Scy<code>more-help</code> is disabled on platforms without a working 89275970Scy<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 90275970Scyused to select the program, defaulting to <span class="file">more</span>. Both will exit 91275970Scywith a status code of 0. 92275970Scy 93316722Sdelphij<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p10 94275970ScyUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 95275970Scy 96275970Scy -l, --host-list=str Host to execute actions on 97275970Scy - may appear multiple times 98275970Scy -p, --peers Recursively list all peers a host synchronizes to 99275970Scy -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 100275970Scy -s, --strip=str Strip this string from hostnames 101275970Scy -?, --help Display usage information and exit 102275970Scy --more-help Pass the extended usage text through a pager 103275970Scy 104275970ScyOptions are specified by doubled hyphens and their name or by a single 105275970Scyhyphen and the flag character. 106275970Scy</pre> 107275970Scy <div class="node"> 108275970Scy<p><hr> 109275970Scy<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 110275970ScyPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 111275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 112275970Scy<br> 113275970Scy</div> 114275970Scy 115275970Scy<h4 class="subsection">0.1.2 host-list option (-l)</h4> 116275970Scy 117275970Scy<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> 118275970ScyThis is the “host to execute actions on” option. 119275970ScyThis option takes a string argument. 120275970Scy 121275970Scy<p class="noindent">This option has some usage constraints. It: 122275970Scy <ul> 123275970Scy<li>may appear an unlimited number of times. 124275970Scy</ul> 125275970Scy 126275970Scy <p>Use this option to specify the host on which this script operates. 127275970Scy May appear multiple times. 128275970Scy<div class="node"> 129275970Scy<p><hr> 130275970Scy<a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 131275970ScyPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 132275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 133275970Scy<br> 134275970Scy</div> 135275970Scy 136275970Scy<h4 class="subsection">0.1.3 peers option (-p)</h4> 137275970Scy 138275970Scy<p><a name="index-ntpsweep_002dpeers-5"></a> 139275970ScyThis is the “recursively list all peers a host synchronizes to” option. 140275970ScyThis option has no <span class="samp">doc</span> documentation. 141275970Scy<div class="node"> 142275970Scy<p><hr> 143275970Scy<a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, 144275970ScyPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, 145275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 146275970Scy<br> 147275970Scy</div> 148275970Scy 149275970Scy<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> 150275970Scy 151275970Scy<p><a name="index-ntpsweep_002dmaxlevel-6"></a> 152275970ScyThis is the “traverse peers up to this level (4 is a reasonable number)” option. 153275970ScyThis option takes a number argument. 154275970ScyThis option has no <span class="samp">doc</span> documentation. 155275970Scy<div class="node"> 156275970Scy<p><hr> 157275970Scy<a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, 158275970ScyPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 159275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 160275970Scy<br> 161275970Scy</div> 162275970Scy 163275970Scy<h4 class="subsection">0.1.5 strip option (-s)</h4> 164275970Scy 165275970Scy<p><a name="index-ntpsweep_002dstrip-7"></a> 166275970ScyThis is the “strip this string from hostnames” option. 167275970ScyThis option takes a string argument. 168275970ScyThis option has no <span class="samp">doc</span> documentation. 169275970Scy<div class="node"> 170275970Scy<p><hr> 171275970Scy<a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, 172275970ScyPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, 173275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 174275970Scy<br> 175275970Scy</div> 176275970Scy 177275970Scy<h4 class="subsection">0.1.6 host option (-h)</h4> 178275970Scy 179275970Scy<p><a name="index-ntpsweep_002dhost-8"></a> 180275970ScyThis is the “specify a single host” option. 181275970ScyThis option takes a string argument. 182275970ScyThis option has no <span class="samp">doc</span> documentation. 183275970Scy 184275970Scy <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 185275970Scy<div class="node"> 186275970Scy<p><hr> 187275970Scy<a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, 188275970ScyUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 189275970Scy<br> 190275970Scy</div> 191275970Scy 192275970Scy<h4 class="subsection">0.1.7 ntpsweep exit status</h4> 193275970Scy 194275970Scy<p>One of the following exit values will be returned: 195275970Scy <dl> 196275970Scy<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 197275970Scy<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 198275970Scy</dl> 199275970Scy 200275970Scy</body></html> 201275970Scy 202