diff options
Diffstat (limited to 'scripts/ntpsweep/ntpsweep.html')
| -rw-r--r-- | scripts/ntpsweep/ntpsweep.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/scripts/ntpsweep/ntpsweep.html b/scripts/ntpsweep/ntpsweep.html new file mode 100644 index 0000000..291f434 --- /dev/null +++ b/scripts/ntpsweep/ntpsweep.html @@ -0,0 +1,201 @@ +<html lang="en"> +<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> +</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> +</div> + + <p>This document describes the use of the NTP Project's <code>ntpsweep</code> program. + + <p>This document applies to version 4.2.7p482 of <code>ntpsweep</code>. + + <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> +<a name="ntpsweep-Invocation"></a> +<br> +</div> + +<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> +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>, +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> +</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. +<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 +with a status code of 0. + +<pre class="example">ntpsweep - Print various informations about given ntp servers - Ver. 4.2.7p482 +USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] + + -l, --host-list=str Host to execute actions on + - may appear multiple times + -p, --peers Recursively list all peers a host synchronizes to + -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) + -s, --strip=str Strip this string from hostnames + -?, --help Display usage information and exit + --more-help Pass the extended usage text through a pager + +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> + +<h4 class="subsection">0.1.2 host-list option (-l)</h4> + +<p><a name="index-ntpsweep_002dhost_002dlist-4"></a> +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> +</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> +</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> +</div> + +<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> +</div> + +<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> +</div> + +<h4 class="subsection">0.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. +</dl> + +</body></html> + |