ntpsweep.html revision 293893
1259698Sdim<html lang="en"> 2259698Sdim<head> 3259698Sdim<title>ntpsweep User's Manual</title> 4259698Sdim<meta http-equiv="Content-Type" content="text/html"> 5259698Sdim<meta name="description" content="ntpsweep User's Manual"> 6259698Sdim<meta name="generator" content="makeinfo 4.7"> 7259698Sdim<link title="Top" rel="top" href="#Top"> 8259698Sdim<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9259698Sdim<meta http-equiv="Content-Style-Type" content="text/css"> 10259698Sdim<style type="text/css"><!-- 11259698Sdim pre.display { font-family:inherit } 12259698Sdim pre.format { font-family:inherit } 13259698Sdim pre.smalldisplay { font-family:inherit; font-size:smaller } 14259698Sdim pre.smallformat { font-family:inherit; font-size:smaller } 15259698Sdim pre.smallexample { font-size:smaller } 16259698Sdim pre.smalllisp { font-size:smaller } 17259698Sdim span.sc { font-variant:small-caps } 18259698Sdim span.roman { font-family: serif; font-weight: normal; } 19259698Sdim--></style> 20259698Sdim</head> 21259698Sdim<body> 22259698Sdim<h1 class="settitle">ntpsweep User's Manual</h1> 23259698Sdim<div class="node"> 24259698Sdim<p><hr> 25259698Sdim<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, 26259698SdimPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27259698SdimUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28259698Sdim<br> 29259698Sdim</div> 30259698Sdim 31259698Sdim <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. 32259698Sdim 33259698Sdim <p>This document applies to version 4.2.8p5 of <code>ntpsweep</code>. 34259698Sdim 35259698Sdim <div class="shortcontents"> 36259698Sdim<h2>Short Contents</h2> 37259698Sdim<ul> 38259698Sdim</ul> 39259698Sdim</div> 40259698Sdim 41259698Sdim<ul class="menu"> 42259698Sdim<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description 43259698Sdim<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep 44259698Sdim</ul> 45259698Sdim 46259698Sdim<div class="node"> 47259698Sdim<p><hr> 48259698Sdim<a name="ntpsweep-Invocation"></a> 49259698Sdim<br> 50259698Sdim</div> 51259698Sdim 52259698Sdim<h3 class="section">0.1 Invoking ntpsweep</h3> 53259698Sdim 54259698Sdim<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> 55259698Sdim<code>ntpsweep</code> 56259698Sdimprints per host the NTP stratum level, the clock offset in seconds, the daemon 57259698Sdimversion, the operating system and the processor. Optionally recursing through 58259698Sdimall peers. 59259698Sdim 60259698Sdim <p>This section was generated by <strong>AutoGen</strong>, 61259698Sdimusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 62259698Sdim 63259698Sdim<ul class="menu"> 64259698Sdim<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) 65259698Sdim<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) 66259698Sdim<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) 67259698Sdim<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) 68259698Sdim<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) 69259698Sdim<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) 70259698Sdim<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status 71259698Sdim</ul> 72259698Sdim 73259698Sdim<div class="node"> 74259698Sdim<p><hr> 75259698Sdim<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 76259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 77259698Sdim<br> 78259698Sdim</div> 79259698Sdim 80259698Sdim<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> 81259698Sdim 82259698Sdim<p><a name="index-ntpsweep-help-3"></a> 83259698SdimThis is the automatically generated usage text for ntpsweep. 84259698Sdim 85259698Sdim <p>The text printed is the same whether selected with the <code>help</code> option 86259698Sdim(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 87259698Sdimthe usage text by passing it through a pager program. 88259698Sdim<code>more-help</code> is disabled on platforms without a working 89259698Sdim<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 90259698Sdimused to select the program, defaulting to <span class="file">more</span>. Both will exit 91259698Sdimwith a status code of 0. 92259698Sdim 93259698Sdim<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p5 94259698SdimUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 95259698Sdim 96259698Sdim -l, --host-list=str Host to execute actions on 97259698Sdim - may appear multiple times 98259698Sdim -p, --peers Recursively list all peers a host synchronizes to 99259698Sdim -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 100259698Sdim -s, --strip=str Strip this string from hostnames 101259698Sdim -?, --help Display usage information and exit 102259698Sdim --more-help Pass the extended usage text through a pager 103259698Sdim 104259698SdimOptions are specified by doubled hyphens and their name or by a single 105259698Sdimhyphen and the flag character. 106259698Sdim</pre> 107259698Sdim <div class="node"> 108259698Sdim<p><hr> 109259698Sdim<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, 110259698SdimPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, 111259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 112259698Sdim<br> 113259698Sdim</div> 114259698Sdim 115259698Sdim<h4 class="subsection">0.1.2 host-list option (-l)</h4> 116259698Sdim 117259698Sdim<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> 118259698SdimThis is the “host to execute actions on” option. 119259698SdimThis option takes a string argument. 120259698Sdim 121259698Sdim<p class="noindent">This option has some usage constraints. It: 122259698Sdim <ul> 123259698Sdim<li>may appear an unlimited number of times. 124259698Sdim</ul> 125259698Sdim 126259698Sdim <p>Use this option to specify the host on which this script operates. 127259698Sdim May appear multiple times. 128259698Sdim<div class="node"> 129259698Sdim<p><hr> 130259698Sdim<a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 131259698SdimPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, 132259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 133259698Sdim<br> 134259698Sdim</div> 135259698Sdim 136259698Sdim<h4 class="subsection">0.1.3 peers option (-p)</h4> 137259698Sdim 138259698Sdim<p><a name="index-ntpsweep_002dpeers-5"></a> 139259698SdimThis is the “recursively list all peers a host synchronizes to” option. 140259698SdimThis option has no <span class="samp">doc</span> documentation. 141259698Sdim<div class="node"> 142259698Sdim<p><hr> 143259698Sdim<a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, 144259698SdimPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, 145259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 146259698Sdim<br> 147259698Sdim</div> 148259698Sdim 149259698Sdim<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> 150259698Sdim 151259698Sdim<p><a name="index-ntpsweep_002dmaxlevel-6"></a> 152259698SdimThis is the “traverse peers up to this level (4 is a reasonable number)” option. 153259698SdimThis option takes a number argument. 154259698SdimThis option has no <span class="samp">doc</span> documentation. 155259698Sdim<div class="node"> 156259698Sdim<p><hr> 157259698Sdim<a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, 158259698SdimPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, 159259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 160259698Sdim<br> 161259698Sdim</div> 162259698Sdim 163259698Sdim<h4 class="subsection">0.1.5 strip option (-s)</h4> 164259698Sdim 165259698Sdim<p><a name="index-ntpsweep_002dstrip-7"></a> 166259698SdimThis is the “strip this string from hostnames” option. 167259698SdimThis option takes a string argument. 168259698SdimThis option has no <span class="samp">doc</span> documentation. 169259698Sdim<div class="node"> 170259698Sdim<p><hr> 171259698Sdim<a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, 172259698SdimPrevious: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, 173259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 174259698Sdim<br> 175259698Sdim</div> 176259698Sdim 177259698Sdim<h4 class="subsection">0.1.6 host option (-h)</h4> 178259698Sdim 179259698Sdim<p><a name="index-ntpsweep_002dhost-8"></a> 180259698SdimThis is the “specify a single host” option. 181259698SdimThis option takes a string argument. 182259698SdimThis option has no <span class="samp">doc</span> documentation. 183259698Sdim 184259698Sdim <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 185259698Sdim<div class="node"> 186259698Sdim<p><hr> 187259698Sdim<a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, 188259698SdimUp: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> 189259698Sdim<br> 190259698Sdim</div> 191259698Sdim 192259698Sdim<h4 class="subsection">0.1.7 ntpsweep exit status</h4> 193259698Sdim 194259698Sdim<p>One of the following exit values will be returned: 195259698Sdim <dl> 196259698Sdim<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 197259698Sdim<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 198259698Sdim</dl> 199259698Sdim 200259698Sdim</body></html> 201259698Sdim 202259698Sdim