1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 4<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6<title>ntpsweep User’s Manual</title> 7 8<meta name="description" content="ntpsweep User’s Manual"> 9<meta name="keywords" content="ntpsweep User’s Manual"> 10<meta name="resource-type" content="document"> 11<meta name="distribution" content="global"> 12<meta name="Generator" content="makeinfo"> 13<link href="#Top" rel="start" title="Top"> 14<link href="dir.html#Top" rel="up" title="(dir)"> 15<style type="text/css"> 16<!-- 17a.summary-letter {text-decoration: none} 18blockquote.indentedblock {margin-right: 0em} 19div.display {margin-left: 3.2em} 20div.example {margin-left: 3.2em} 21div.lisp {margin-left: 3.2em} 22kbd {font-style: oblique} 23pre.display {font-family: inherit} 24pre.format {font-family: inherit} 25pre.menu-comment {font-family: serif} 26pre.menu-preformatted {font-family: serif} 27span.nolinebreak {white-space: nowrap} 28span.roman {font-family: initial; font-weight: normal} 29span.sansserif {font-family: sans-serif; font-weight: normal} 30ul.no-bullet {list-style: none} 31--> 32</style> 33 34 35</head> 36 37<body lang="en"> 38<h1 class="settitle" align="center">ntpsweep User’s Manual</h1> 39 40 41 42 43 44<span id="Top"></span><div class="header"> 45<p> 46Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 47</div> 48<h1 class="node-heading">Top</h1> 49 50<p>This document describes the use of the NTP Project’s <code>ntpsweep</code> program. 51</p> 52<p>This document applies to version 4.2.8p18 of <code>ntpsweep</code>. 53</p> 54<span id="SEC_Overview"></span> 55<h2 class="shortcontents-heading">Short Table of Contents</h2> 56 57<div class="shortcontents"> 58<li><a id="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li> 59 60</div> 61 62 63<table class="menu" border="0" cellspacing="0"> 64<tr><td align="left" valign="top">• ntpsweep Description</td><td> </td><td align="left" valign="top">Description 65</td></tr> 66<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 67</td></tr> 68</table> 69 70<hr> 71<span id="ntpsweep-Invocation"></span><div class="header"> 72<p> 73Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 74</div> 75<span id="Invoking-ntpsweep"></span><h3 class="section">1 Invoking ntpsweep</h3> 76<span id="index-ntpsweep"></span> 77<span id="index-Print-various-informations-about-given-ntp-servers"></span> 78 79<p><code>ntpsweep</code> 80prints per host the NTP stratum level, the clock offset in seconds, the daemon 81version, the operating system and the processor. Optionally recursing through 82all peers. 83</p> 84<p>This section was generated by <strong>AutoGen</strong>, 85using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. 86</p> 87<table class="menu" border="0" cellspacing="0"> 88<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>) 89</td></tr> 90<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) 91</td></tr> 92<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) 93</td></tr> 94<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) 95</td></tr> 96<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) 97</td></tr> 98<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) 99</td></tr> 100<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 101</td></tr> 102</table> 103 104<hr> 105<span id="ntpsweep-usage"></span><div class="header"> 106<p> 107Next: <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> 108</div> 109<span id="ntpsweep-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1 ntpsweep help/usage (<samp>--help</samp>)</h4> 110<span id="index-ntpsweep-help"></span> 111 112<p>This is the automatically generated usage text for ntpsweep. 113</p> 114<p>The text printed is the same whether selected with the <code>help</code> option 115(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 116the usage text by passing it through a pager program. 117<code>more-help</code> is disabled on platforms without a working 118<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 119used to select the program, defaulting to <samp>more</samp>. Both will exit 120with a status code of 0. 121</p> 122<div class="example"> 123<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p18 124USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] 125 126 -l, --host-list=str Host to execute actions on 127 - may appear multiple times 128 -p, --peers Recursively list all peers a host synchronizes to 129 -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 130 -s, --strip=str Strip this string from hostnames 131 -?, --help Display usage information and exit 132 --more-help Pass the extended usage text through a pager 133 134Options are specified by doubled hyphens and their name or by a single 135hyphen and the flag character. 136</pre></div> 137 138<hr> 139<span id="ntpsweep-host_002dlist"></span><div class="header"> 140<p> 141Next: <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> 142</div> 143<span id="host_002dlist-option-_0028_002dl_0029"></span><h4 class="subsection">1.2 host-list option (-l)</h4> 144<span id="index-ntpsweep_002dhost_002dlist"></span> 145 146<p>This is the “host to execute actions on” option. 147This option takes a string argument. 148</p> 149<p>This option has some usage constraints. It: 150</p><ul> 151<li> may appear an unlimited number of times. 152</li></ul> 153 154<p>Use this option to specify the host on which this script operates. 155 May appear multiple times. 156</p><hr> 157<span id="ntpsweep-peers"></span><div class="header"> 158<p> 159Next: <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> 160</div> 161<span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.3 peers option (-p)</h4> 162<span id="index-ntpsweep_002dpeers"></span> 163 164<p>This is the “recursively list all peers a host synchronizes to” option. 165This option has no ‘<samp>doc</samp>’ documentation. 166</p><hr> 167<span id="ntpsweep-maxlevel"></span><div class="header"> 168<p> 169Next: <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> 170</div> 171<span id="maxlevel-option-_0028_002dm_0029"></span><h4 class="subsection">1.4 maxlevel option (-m)</h4> 172<span id="index-ntpsweep_002dmaxlevel"></span> 173 174<p>This is the “traverse peers up to this level (4 is a reasonable number)” option. 175This option takes a number argument. 176This option has no ‘<samp>doc</samp>’ documentation. 177</p><hr> 178<span id="ntpsweep-strip"></span><div class="header"> 179<p> 180Next: <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> 181</div> 182<span id="strip-option-_0028_002ds_0029"></span><h4 class="subsection">1.5 strip option (-s)</h4> 183<span id="index-ntpsweep_002dstrip"></span> 184 185<p>This is the “strip this string from hostnames” option. 186This option takes a string argument. 187This option has no ‘<samp>doc</samp>’ documentation. 188</p><hr> 189<span id="ntpsweep-host"></span><div class="header"> 190<p> 191Next: <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> 192</div> 193<span id="host-option-_0028_002dh_0029"></span><h4 class="subsection">1.6 host option (-h)</h4> 194<span id="index-ntpsweep_002dhost"></span> 195 196<p>This is the “specify a single host” option. 197This option takes a string argument. 198This option has no ‘<samp>doc</samp>’ documentation. 199</p> 200<p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> 201</p><hr> 202<span id="ntpsweep-exit-status"></span><div class="header"> 203<p> 204Previous: <a href="#ntpsweep-host" accesskey="p" rel="prev">ntpsweep host</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> 205</div> 206<span id="ntpsweep-exit-status-1"></span><h4 class="subsection">1.7 ntpsweep exit status</h4> 207 208<p>One of the following exit values will be returned: 209</p><dl compact="compact"> 210<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 211<dd><p>Successful program execution. 212</p></dd> 213<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 214<dd><p>The operation failed or the command syntax was not valid. 215</p></dd> 216</dl> 217<hr> 218 219 220 221</body> 222</html> 223