diff options
Diffstat (limited to 'contrib/ntp/scripts/ntpsweep/ntpsweep.html')
| -rw-r--r-- | contrib/ntp/scripts/ntpsweep/ntpsweep.html | 355 |
1 files changed, 201 insertions, 154 deletions
diff --git a/contrib/ntp/scripts/ntpsweep/ntpsweep.html b/contrib/ntp/scripts/ntpsweep/ntpsweep.html index 8c9737e95f81..61095d421ed1 100644 --- a/contrib/ntp/scripts/ntpsweep/ntpsweep.html +++ b/contrib/ntp/scripts/ntpsweep/ntpsweep.html @@ -1,96 +1,140 @@ -<html lang="en"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> <head> -<title>ntpsweep User's Manual</title> -<meta http-equiv="Content-Type" content="text/html"> -<meta name="description" content="ntpsweep User's Manual"> -<meta name="generator" content="makeinfo 4.7"> -<link title="Top" rel="top" href="#Top"> -<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> -<meta http-equiv="Content-Style-Type" content="text/css"> -<style type="text/css"><!-- - pre.display { font-family:inherit } - pre.format { font-family:inherit } - pre.smalldisplay { font-family:inherit; font-size:smaller } - pre.smallformat { font-family:inherit; font-size:smaller } - pre.smallexample { font-size:smaller } - pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family: serif; font-weight: normal; } ---></style> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>ntpsweep User’s Manual</title> + +<meta name="description" content="ntpsweep User’s Manual"> +<meta name="keywords" content="ntpsweep User’s Manual"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="#Top" rel="start" title="Top"> +<link href="dir.html#Top" rel="up" title="(dir)"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smalllisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + </head> -<body> -<h1 class="settitle">ntpsweep User's Manual</h1> -<div class="node"> -<p><hr> -<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-Description">ntpsweep Description</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -<br> + +<body lang="en"> +<h1 class="settitle" align="center">ntpsweep User’s Manual</h1> + + + + + +<a name="Top"></a> +<div class="header"> +<p> +Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> </div> +<h1 class="node-heading">Top</h1> - <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. +<p>This document describes the use of the NTP Project’s <code>ntpsweep</code> program. +</p> +<p>This document applies to version 4.2.8p13 of <code>ntpsweep</code>. +</p> +<a name="SEC_Overview"></a> +<h2 class="shortcontents-heading">Short Table of Contents</h2> - <p>This document applies to version 4.2.8p12 of <code>ntpsweep</code>. +<div class="shortcontents"> +<li><a name="stoc-Invoking-ntpsweep" href="#toc-Invoking-ntpsweep">1 Invoking ntpsweep</a></li> - <div class="shortcontents"> -<h2>Short Contents</h2> -<ul> -</ul> </div> -<ul class="menu"> -<li><a accesskey="1" href="#ntpsweep-Description">ntpsweep Description</a>: Description -<li><a accesskey="2" href="#ntpsweep-Invocation">ntpsweep Invocation</a>: Invoking ntpsweep -</ul> -<div class="node"> -<p><hr> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• ntpsweep Description:</td><td> </td><td align="left" valign="top">Description +</td></tr> +<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 +</td></tr> +</table> + +<hr> <a name="ntpsweep-Invocation"></a> -<br> +<div class="header"> +<p> +Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> </div> +<a name="Invoking-ntpsweep"></a> +<h3 class="section">1 Invoking ntpsweep</h3> +<a name="index-ntpsweep"></a> +<a name="index-Print-various-informations-about-given-ntp-servers"></a> -<h3 class="section">0.1 Invoking ntpsweep</h3> - -<p><a name="index-ntpsweep-1"></a><a name="index-Print-various-informations-about-given-ntp-servers-2"></a> -<code>ntpsweep</code> +<p><code>ntpsweep</code> prints per host the NTP stratum level, the clock offset in seconds, the daemon version, the operating system and the processor. Optionally recursing through all peers. - - <p>This section was generated by <strong>AutoGen</strong>, +</p> +<p>This section was generated by <strong>AutoGen</strong>, using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpsweep</code> program. - -<ul class="menu"> -<li><a accesskey="1" href="#ntpsweep-usage">ntpsweep usage</a>: ntpsweep help/usage (<span class="option">--help</span>) -<li><a accesskey="2" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>: host-list option (-l) -<li><a accesskey="3" href="#ntpsweep-peers">ntpsweep peers</a>: peers option (-p) -<li><a accesskey="4" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>: maxlevel option (-m) -<li><a accesskey="5" href="#ntpsweep-strip">ntpsweep strip</a>: strip option (-s) -<li><a accesskey="6" href="#ntpsweep-host">ntpsweep host</a>: host option (-h) -<li><a accesskey="7" href="#ntpsweep-exit-status">ntpsweep exit status</a>: exit status -</ul> - -<div class="node"> -<p><hr> -<a name="ntpsweep-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +</p> +<table class="menu" border="0" cellspacing="0"> +<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>) +</td></tr> +<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) +</td></tr> +<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) +</td></tr> +<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) +</td></tr> +<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) +</td></tr> +<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) +</td></tr> +<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 +</td></tr> +</table> + +<hr> +<a name="ntpsweep-usage"></a> +<div class="header"> +<p> +Next: <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> </div> - -<h4 class="subsection">0.1.1 ntpsweep help/usage (<span class="option">--help</span>)</h4> - -<p><a name="index-ntpsweep-help-3"></a> -This is the automatically generated usage text for ntpsweep. - - <p>The text printed is the same whether selected with the <code>help</code> option -(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print -the usage text by passing it through a pager program. +<a name="ntpsweep-help_002fusage-_0028_002d_002dhelp_0029"></a> +<h4 class="subsection">1.1 ntpsweep help/usage (<samp>--help</samp>)</h4> +<a name="index-ntpsweep-help"></a> + +<p>This is the automatically generated usage text for ntpsweep. +</p> +<p>The text printed is the same whether selected with the <code>help</code> option +(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print +the usage text by passing it through a pager program. <code>more-help</code> is disabled on platforms without a working <code>fork(2)</code> function. The <code>PAGER</code> environment variable is -used to select the program, defaulting to <span class="file">more</span>. Both will exit +used to select the program, defaulting to <samp>more</samp>. Both will exit with a status code of 0. - -<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p12 +</p> +<div class="example"> +<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p13 USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] -l, --host-list=str Host to execute actions on @@ -103,99 +147,102 @@ USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -</pre> - <div class="node"> -<p><hr> -<a name="ntpsweep-host_002dlist"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-peers">ntpsweep peers</a>, -Previous: <a rel="previous" accesskey="p" href="#ntpsweep-usage">ntpsweep usage</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> -</div> +</pre></div> -<h4 class="subsection">0.1.2 host-list option (-l)</h4> +<hr> +<a name="ntpsweep-host_002dlist"></a> +<div class="header"> +<p> +Next: <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> +</div> +<a name="host_002dlist-option-_0028_002dl_0029"></a> +<h4 class="subsection">1.2 host-list option (-l)</h4> +<a name="index-ntpsweep_002dhost_002dlist"></a> -<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> -This is the “host to execute actions on” option. +<p>This is the “host to execute actions on” option. This option takes a string argument. - -<p class="noindent">This option has some usage constraints. It: - <ul> -<li>may appear an unlimited number of times. -</ul> - - <p>Use this option to specify the host on which this script operates. - May appear multiple times. -<div class="node"> -<p><hr> -<a name="ntpsweep-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, -Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host_002dlist">ntpsweep host-list</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +</p> +<p>This option has some usage constraints. It: +</p><ul> +<li> may appear an unlimited number of times. +</li></ul> + +<p>Use this option to specify the host on which this script operates. + May appear multiple times. +</p><hr> +<a name="ntpsweep-peers"></a> +<div class="header"> +<p> +Next: <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> </div> - -<h4 class="subsection">0.1.3 peers option (-p)</h4> - -<p><a name="index-ntpsweep_002dpeers-5"></a> -This is the “recursively list all peers a host synchronizes to” option. -This option has no <span class="samp">doc</span> documentation. -<div class="node"> -<p><hr> -<a name="ntpsweep-maxlevel"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-strip">ntpsweep strip</a>, -Previous: <a rel="previous" accesskey="p" href="#ntpsweep-peers">ntpsweep peers</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +<a name="peers-option-_0028_002dp_0029"></a> +<h4 class="subsection">1.3 peers option (-p)</h4> +<a name="index-ntpsweep_002dpeers"></a> + +<p>This is the “recursively list all peers a host synchronizes to” option. +This option has no ‘<samp>doc</samp>’ documentation. +</p><hr> +<a name="ntpsweep-maxlevel"></a> +<div class="header"> +<p> +Next: <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> </div> - -<h4 class="subsection">0.1.4 maxlevel option (-m)</h4> - -<p><a name="index-ntpsweep_002dmaxlevel-6"></a> -This is the “traverse peers up to this level (4 is a reasonable number)” option. -This option takes a number argument. -This option has no <span class="samp">doc</span> documentation. -<div class="node"> -<p><hr> -<a name="ntpsweep-strip"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-host">ntpsweep host</a>, -Previous: <a rel="previous" accesskey="p" href="#ntpsweep-maxlevel">ntpsweep maxlevel</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +<a name="maxlevel-option-_0028_002dm_0029"></a> +<h4 class="subsection">1.4 maxlevel option (-m)</h4> +<a name="index-ntpsweep_002dmaxlevel"></a> + +<p>This is the “traverse peers up to this level (4 is a reasonable number)” option. +This option takes a number argument. +This option has no ‘<samp>doc</samp>’ documentation. +</p><hr> +<a name="ntpsweep-strip"></a> +<div class="header"> +<p> +Next: <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> </div> +<a name="strip-option-_0028_002ds_0029"></a> +<h4 class="subsection">1.5 strip option (-s)</h4> +<a name="index-ntpsweep_002dstrip"></a> -<h4 class="subsection">0.1.5 strip option (-s)</h4> - -<p><a name="index-ntpsweep_002dstrip-7"></a> -This is the “strip this string from hostnames” option. -This option takes a string argument. -This option has no <span class="samp">doc</span> documentation. -<div class="node"> -<p><hr> -<a name="ntpsweep-host"></a>Next: <a rel="next" accesskey="n" href="#ntpsweep-exit-status">ntpsweep exit status</a>, -Previous: <a rel="previous" accesskey="p" href="#ntpsweep-strip">ntpsweep strip</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +<p>This is the “strip this string from hostnames” option. +This option takes a string argument. +This option has no ‘<samp>doc</samp>’ documentation. +</p><hr> +<a name="ntpsweep-host"></a> +<div class="header"> +<p> +Next: <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> </div> +<a name="host-option-_0028_002dh_0029"></a> +<h4 class="subsection">1.6 host option (-h)</h4> +<a name="index-ntpsweep_002dhost"></a> -<h4 class="subsection">0.1.6 host option (-h)</h4> - -<p><a name="index-ntpsweep_002dhost-8"></a> -This is the “specify a single host” option. -This option takes a string argument. -This option has no <span class="samp">doc</span> documentation. - - <p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> -<div class="node"> -<p><hr> -<a name="ntpsweep-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpsweep-host">ntpsweep host</a>, -Up: <a rel="up" accesskey="u" href="#ntpsweep-Invocation">ntpsweep Invocation</a> -<br> +<p>This is the “specify a single host” option. +This option takes a string argument. +This option has no ‘<samp>doc</samp>’ documentation. +</p> +<p><strong>NOTE</strong><strong>: THIS OPTION IS DEPRECATED</strong> +</p><hr> +<a name="ntpsweep-exit-status"></a> +<div class="header"> +<p> +Previous: <a href="#ntpsweep-host" accesskey="p" rel="prev">ntpsweep host</a>, Up: <a href="#ntpsweep-Invocation" accesskey="u" rel="up">ntpsweep Invocation</a> </p> </div> - -<h4 class="subsection">0.1.7 ntpsweep exit status</h4> +<a name="ntpsweep-exit-status-1"></a> +<h4 class="subsection">1.7 ntpsweep exit status</h4> <p>One of the following exit values will be returned: - <dl> -<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. -<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. +</p><dl compact="compact"> +<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> +<dd><p>Successful program execution. +</p></dd> +<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> +<dd><p>The operation failed or the command syntax was not valid. +</p></dd> </dl> +<hr> + -</body></html> +</body> +</html> |