1052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2052d159aSCy Schubert<html> 3a466cc55SCy Schubert<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 42b15cb3dSCy Schubert<head> 5052d159aSCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6052d159aSCy Schubert<title>ntpsweep User’s Manual</title> 7052d159aSCy Schubert 8052d159aSCy Schubert<meta name="description" content="ntpsweep User’s Manual"> 9052d159aSCy Schubert<meta name="keywords" content="ntpsweep User’s Manual"> 10052d159aSCy Schubert<meta name="resource-type" content="document"> 11052d159aSCy Schubert<meta name="distribution" content="global"> 12052d159aSCy Schubert<meta name="Generator" content="makeinfo"> 13052d159aSCy Schubert<link href="#Top" rel="start" title="Top"> 14052d159aSCy Schubert<link href="dir.html#Top" rel="up" title="(dir)"> 15052d159aSCy Schubert<style type="text/css"> 16052d159aSCy Schubert<!-- 17052d159aSCy Schuberta.summary-letter {text-decoration: none} 18052d159aSCy Schubertblockquote.indentedblock {margin-right: 0em} 19052d159aSCy Schubertdiv.display {margin-left: 3.2em} 20052d159aSCy Schubertdiv.example {margin-left: 3.2em} 21052d159aSCy Schubertdiv.lisp {margin-left: 3.2em} 22052d159aSCy Schubertkbd {font-style: oblique} 232b15cb3dSCy Schubertpre.display {font-family: inherit} 242b15cb3dSCy Schubertpre.format {font-family: inherit} 25052d159aSCy Schubertpre.menu-comment {font-family: serif} 26052d159aSCy Schubertpre.menu-preformatted {font-family: serif} 27052d159aSCy Schubertspan.nolinebreak {white-space: nowrap} 28052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal} 29052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 30052d159aSCy Schubertul.no-bullet {list-style: none} 31052d159aSCy Schubert--> 32052d159aSCy Schubert</style> 33052d159aSCy Schubert 34052d159aSCy Schubert 352b15cb3dSCy Schubert</head> 36052d159aSCy Schubert 37052d159aSCy Schubert<body lang="en"> 38052d159aSCy Schubert<h1 class="settitle" align="center">ntpsweep User’s Manual</h1> 39052d159aSCy Schubert 40052d159aSCy Schubert 41052d159aSCy Schubert 42052d159aSCy Schubert 43052d159aSCy Schubert 44a466cc55SCy Schubert<span id="Top"></span><div class="header"> 45052d159aSCy Schubert<p> 46052d159aSCy SchubertPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 472b15cb3dSCy Schubert</div> 48052d159aSCy Schubert<h1 class="node-heading">Top</h1> 492b15cb3dSCy Schubert 50052d159aSCy Schubert<p>This document describes the use of the NTP Project’s <code>ntpsweep</code> program. 51052d159aSCy Schubert</p> 52*f5f40dd6SCy Schubert<p>This document applies to version 4.2.8p18 of <code>ntpsweep</code>. 53052d159aSCy Schubert</p> 54a466cc55SCy Schubert<span id="SEC_Overview"></span> 55052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 562b15cb3dSCy Schubert 572b15cb3dSCy Schubert<div class="shortcontents"> 58a466cc55SCy Schubert<li><a id="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li> 59052d159aSCy Schubert 602b15cb3dSCy Schubert</div> 612b15cb3dSCy Schubert 622b15cb3dSCy Schubert 63052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 64a466cc55SCy Schubert<tr><td align="left" valign="top">• ntpsweep Description</td><td> </td><td align="left" valign="top">Description 65052d159aSCy Schubert</td></tr> 66a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-Invocation" accesskey="2">ntpsweep Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntpsweep 67052d159aSCy Schubert</td></tr> 68052d159aSCy Schubert</table> 69052d159aSCy Schubert 70052d159aSCy Schubert<hr> 71a466cc55SCy Schubert<span id="ntpsweep-Invocation"></span><div class="header"> 72052d159aSCy Schubert<p> 73052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 742b15cb3dSCy Schubert</div> 75a466cc55SCy Schubert<span id="Invoking-ntpsweep"></span><h3 class="section">1 Invoking ntpsweep</h3> 76a466cc55SCy Schubert<span id="index-ntpsweep"></span> 77a466cc55SCy Schubert<span id="index-Print-various-informations-about-given-ntp-servers"></span> 782b15cb3dSCy Schubert 79052d159aSCy Schubert<p><code>ntpsweep</code> 802b15cb3dSCy Schubertprints per host the NTP stratum level, the clock offset in seconds, the daemon 812b15cb3dSCy Schubertversion, the operating system and the processor. Optionally recursing through 822b15cb3dSCy Schubertall peers. 83052d159aSCy Schubert</p> 842b15cb3dSCy Schubert<p>This section was generated by <strong>AutoGen</strong>, 852b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 86052d159aSCy Schubert</p> 87052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 88a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-usage" accesskey="1">ntpsweep usage</a></td><td> </td><td align="left" valign="top">ntpsweep help/usage (<samp>--help</samp>) 89052d159aSCy Schubert</td></tr> 90a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-host_002dlist" accesskey="2">ntpsweep host-list</a></td><td> </td><td align="left" valign="top">host-list option (-l) 91052d159aSCy Schubert</td></tr> 92a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-peers" accesskey="3">ntpsweep peers</a></td><td> </td><td align="left" valign="top">peers option (-p) 93052d159aSCy Schubert</td></tr> 94a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-maxlevel" accesskey="4">ntpsweep maxlevel</a></td><td> </td><td align="left" valign="top">maxlevel option (-m) 95052d159aSCy Schubert</td></tr> 96a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-strip" accesskey="5">ntpsweep strip</a></td><td> </td><td align="left" valign="top">strip option (-s) 97052d159aSCy Schubert</td></tr> 98a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-host" accesskey="6">ntpsweep host</a></td><td> </td><td align="left" valign="top">host option (-h) 99052d159aSCy Schubert</td></tr> 100a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#ntpsweep-exit-status" accesskey="7">ntpsweep exit status</a></td><td> </td><td align="left" valign="top">exit status 101052d159aSCy Schubert</td></tr> 102052d159aSCy Schubert</table> 1032b15cb3dSCy Schubert 104052d159aSCy Schubert<hr> 105a466cc55SCy Schubert<span id="ntpsweep-usage"></span><div class="header"> 106052d159aSCy Schubert<p> 107052d159aSCy SchubertNext: <a href="#ntpsweep-host_002dlist" accesskey="n" rel="next">ntpsweep host-list</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1082b15cb3dSCy Schubert</div> 109a466cc55SCy Schubert<span id="ntpsweep-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1 ntpsweep help/usage (<samp>--help</samp>)</h4> 110a466cc55SCy Schubert<span id="index-ntpsweep-help"></span> 1112b15cb3dSCy Schubert 112052d159aSCy Schubert<p>This is the automatically generated usage text for ntpsweep. 113052d159aSCy Schubert</p> 1142b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 115052d159aSCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 1162b15cb3dSCy Schubertthe usage text by passing it through a pager program. 1172b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working 1182b15cb3dSCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 119052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1202b15cb3dSCy Schubertwith a status code of 0. 121052d159aSCy Schubert</p> 122052d159aSCy Schubert<div class="example"> 123*f5f40dd6SCy Schubert<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p18 1242b15cb3dSCy SchubertUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 1252b15cb3dSCy Schubert 1262b15cb3dSCy Schubert -l, --host-list=str Host to execute actions on 1272b15cb3dSCy Schubert - may appear multiple times 1282b15cb3dSCy Schubert -p, --peers Recursively list all peers a host synchronizes to 1292b15cb3dSCy Schubert -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 1302b15cb3dSCy Schubert -s, --strip=str Strip this string from hostnames 1312b15cb3dSCy Schubert -?, --help Display usage information and exit 1322b15cb3dSCy Schubert --more-help Pass the extended usage text through a pager 1332b15cb3dSCy Schubert 1342b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single 1352b15cb3dSCy Schuberthyphen and the flag character. 136052d159aSCy Schubert</pre></div> 137052d159aSCy Schubert 138052d159aSCy Schubert<hr> 139a466cc55SCy Schubert<span id="ntpsweep-host_002dlist"></span><div class="header"> 140052d159aSCy Schubert<p> 141052d159aSCy SchubertNext: <a href="#ntpsweep-peers" accesskey="n" rel="next">ntpsweep peers</a>, Previous: <a href="#ntpsweep-usage" accesskey="p" rel="prev">ntpsweep usage</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1422b15cb3dSCy Schubert</div> 143a466cc55SCy Schubert<span id="host_002dlist-option-_0028_002dl_0029"></span><h4 class="subsection">1.2 host-list option (-l)</h4> 144a466cc55SCy Schubert<span id="index-ntpsweep_002dhost_002dlist"></span> 1452b15cb3dSCy Schubert 146052d159aSCy Schubert<p>This is the “host to execute actions on” option. 1472b15cb3dSCy SchubertThis option takes a string argument. 148052d159aSCy Schubert</p> 149052d159aSCy Schubert<p>This option has some usage constraints. It: 150052d159aSCy Schubert</p><ul> 1512b15cb3dSCy Schubert<li> may appear an unlimited number of times. 152052d159aSCy Schubert</li></ul> 1532b15cb3dSCy Schubert 1542b15cb3dSCy Schubert<p>Use this option to specify the host on which this script operates. 1552b15cb3dSCy Schubert May appear multiple times. 156052d159aSCy Schubert</p><hr> 157a466cc55SCy Schubert<span id="ntpsweep-peers"></span><div class="header"> 158052d159aSCy Schubert<p> 159052d159aSCy SchubertNext: <a href="#ntpsweep-maxlevel" accesskey="n" rel="next">ntpsweep maxlevel</a>, Previous: <a href="#ntpsweep-host_002dlist" accesskey="p" rel="prev">ntpsweep host-list</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1602b15cb3dSCy Schubert</div> 161a466cc55SCy Schubert<span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.3 peers option (-p)</h4> 162a466cc55SCy Schubert<span id="index-ntpsweep_002dpeers"></span> 1632b15cb3dSCy Schubert 164052d159aSCy Schubert<p>This is the “recursively list all peers a host synchronizes to” option. 165052d159aSCy SchubertThis option has no ‘<samp>doc</samp>’ documentation. 166052d159aSCy Schubert</p><hr> 167a466cc55SCy Schubert<span id="ntpsweep-maxlevel"></span><div class="header"> 168052d159aSCy Schubert<p> 169052d159aSCy SchubertNext: <a href="#ntpsweep-strip" accesskey="n" rel="next">ntpsweep strip</a>, Previous: <a href="#ntpsweep-peers" accesskey="p" rel="prev">ntpsweep peers</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1702b15cb3dSCy Schubert</div> 171a466cc55SCy Schubert<span id="maxlevel-option-_0028_002dm_0029"></span><h4 class="subsection">1.4 maxlevel option (-m)</h4> 172a466cc55SCy Schubert<span id="index-ntpsweep_002dmaxlevel"></span> 1732b15cb3dSCy Schubert 174052d159aSCy Schubert<p>This is the “traverse peers up to this level (4 is a reasonable number)” option. 1752b15cb3dSCy SchubertThis option takes a number argument. 176052d159aSCy SchubertThis option has no ‘<samp>doc</samp>’ documentation. 177052d159aSCy Schubert</p><hr> 178a466cc55SCy Schubert<span id="ntpsweep-strip"></span><div class="header"> 179052d159aSCy Schubert<p> 180052d159aSCy SchubertNext: <a href="#ntpsweep-host" accesskey="n" rel="next">ntpsweep host</a>, Previous: <a href="#ntpsweep-maxlevel" accesskey="p" rel="prev">ntpsweep maxlevel</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1812b15cb3dSCy Schubert</div> 182a466cc55SCy Schubert<span id="strip-option-_0028_002ds_0029"></span><h4 class="subsection">1.5 strip option (-s)</h4> 183a466cc55SCy Schubert<span id="index-ntpsweep_002dstrip"></span> 1842b15cb3dSCy Schubert 185052d159aSCy Schubert<p>This is the “strip this string from hostnames” option. 1862b15cb3dSCy SchubertThis option takes a string argument. 187052d159aSCy SchubertThis option has no ‘<samp>doc</samp>’ documentation. 188052d159aSCy Schubert</p><hr> 189a466cc55SCy Schubert<span id="ntpsweep-host"></span><div class="header"> 190052d159aSCy Schubert<p> 191052d159aSCy SchubertNext: <a href="#ntpsweep-exit-status" accesskey="n" rel="next">ntpsweep exit status</a>, Previous: <a href="#ntpsweep-strip" accesskey="p" rel="prev">ntpsweep strip</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 1922b15cb3dSCy Schubert</div> 193a466cc55SCy Schubert<span id="host-option-_0028_002dh_0029"></span><h4 class="subsection">1.6 host option (-h)</h4> 194a466cc55SCy Schubert<span id="index-ntpsweep_002dhost"></span> 1952b15cb3dSCy Schubert 196052d159aSCy Schubert<p>This is the “specify a single host” option. 1972b15cb3dSCy SchubertThis option takes a string argument. 198052d159aSCy SchubertThis option has no ‘<samp>doc</samp>’ documentation. 199052d159aSCy Schubert</p> 2002b15cb3dSCy Schubert<p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 201052d159aSCy Schubert</p><hr> 202a466cc55SCy Schubert<span id="ntpsweep-exit-status"></span><div class="header"> 203052d159aSCy Schubert<p> 204052d159aSCy SchubertPrevious: <a href="#ntpsweep-host" accesskey="p" rel="prev">ntpsweep host</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 2052b15cb3dSCy Schubert</div> 206a466cc55SCy Schubert<span id="ntpsweep-exit-status-1"></span><h4 class="subsection">1.7 ntpsweep exit status</h4> 2072b15cb3dSCy Schubert 2082b15cb3dSCy Schubert<p>One of the following exit values will be returned: 209052d159aSCy Schubert</p><dl compact="compact"> 210052d159aSCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 211052d159aSCy Schubert<dd><p>Successful program execution. 212052d159aSCy Schubert</p></dd> 213052d159aSCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 214052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid. 215052d159aSCy Schubert</p></dd> 2162b15cb3dSCy Schubert</dl> 217052d159aSCy Schubert<hr> 2182b15cb3dSCy Schubert 2192b15cb3dSCy Schubert 220052d159aSCy Schubert 221052d159aSCy Schubert</body> 222052d159aSCy Schubert</html> 223