diff options
Diffstat (limited to 'contrib/ntp/scripts/summary.html')
| -rw-r--r-- | contrib/ntp/scripts/summary.html | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/contrib/ntp/scripts/summary.html b/contrib/ntp/scripts/summary.html new file mode 100644 index 000000000000..7fb8b6fb1d85 --- /dev/null +++ b/contrib/ntp/scripts/summary.html @@ -0,0 +1,217 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Summary User’s Manual</title> + +<meta name="description" content="Summary User’s Manual"> +<meta name="keywords" content="Summary 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} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {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} +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 lang="en"> +<h1 class="settitle" align="center">Summary User’s Manual</h1> + + + + + +<span id="Top"></span><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> +<span id="Summary-User-Manual"></span><h1 class="top">Summary User Manual</h1> + +<p>This document describes the use of the NTP Project’s <code>summary</code> program. +This document applies to version 4.2.8p18 of <code>summary</code>. +</p> +<span id="SEC_Overview"></span> +<h2 class="shortcontents-heading">Short Table of Contents</h2> + +<div class="shortcontents"> +<ul class="no-bullet"> +<li><a id="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li> +</ul> +</div> + + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• summary Description</td><td> </td><td align="left" valign="top">Description +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-Invocation" accesskey="2">summary Invocation</a></td><td> </td><td align="left" valign="top">Invoking summary +</td></tr> +</table> + +<hr> +<span id="summary-Invocation"></span><div class="header"> +<p> +Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> +</div> +<span id="Invoking-summary"></span><h2 class="chapter">1 Invoking summary</h2> +<span id="index-summary"></span> +<span id="index-compute-various-stastics-from-NTP-stat-files"></span> + + + + +<p>This section was generated by <strong>AutoGen</strong>, +using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#summary-usage" accesskey="1">summary usage</a></td><td> </td><td align="left" valign="top">summary help/usage (<samp>--help</samp>) +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="2">summary directory</a></td><td> </td><td align="left" valign="top">directory option +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="3">summary end-date</a></td><td> </td><td align="left" valign="top">end-date option +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a></td><td> </td><td align="left" valign="top">output-directory option +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="5">summary start-date</a></td><td> </td><td align="left" valign="top">start-date option +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="6">summary exit status</a></td><td> </td><td align="left" valign="top">exit status +</td></tr> +</table> + +<hr> +<span id="summary-usage"></span><div class="header"> +<p> +Next: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> </p> +</div> +<span id="summary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> +<span id="index-summary-help"></span> + +<p>This is the automatically generated usage text for summary. +</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 <samp>more</samp>. Both will exit +with a status code of 0. +</p> +<div class="example"> +<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p18 +USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... + + --directory=str Directory containing stat files + --end-date=num End date + --output-directory=str Output directory + --peer-dist-limit=float Peer dist limit + --skip-time-steps=float Ignore time offsets larger that this + --start-date=num Start date + -?, --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> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">end-date option</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">output-directory option</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">start-date option</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="5">summary exit status</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> +<span id="summary-directory"></span><div class="header"> +<p> +Next: <a href="#summary-end_002ddate" accesskey="n" rel="next">summary end-date</a>, Previous: <a href="#summary-usage" accesskey="p" rel="prev">summary usage</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p> +</div> +<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> +<span id="index-summary_002ddirectory"></span> + +<p>This is the “directory containing stat files” option. +This option takes a string argument. + The directory where <code>ntpd</code> will search for .stat files generated + by <code>ntpd</code>. +</p><hr> +<span id="summary-end_002ddate"></span><div class="header"> +<p> +Next: <a href="#summary-output_002ddirectory" accesskey="n" rel="next">summary output-directory</a>, Previous: <a href="#summary-directory" accesskey="p" rel="prev">summary directory</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p> +</div> +<span id="end_002ddate-option"></span><h4 class="subsection">1.1.2 end-date option</h4> +<span id="index-summary_002dend_002ddate"></span> + +<p>This is the “end date” option. +This option takes a number argument. + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) + to get the timestamp. +</p><hr> +<span id="summary-output_002ddirectory"></span><div class="header"> +<p> +Next: <a href="#summary-start_002ddate" accesskey="n" rel="next">summary start-date</a>, Previous: <a href="#summary-end_002ddate" accesskey="p" rel="prev">summary end-date</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p> +</div> +<span id="output_002ddirectory-option"></span><h4 class="subsection">1.1.3 output-directory option</h4> +<span id="index-summary_002doutput_002ddirectory"></span> + +<p>This is the “output directory” option. +This option takes a str argument. + The output directory <code>summary</code> will write all output files to. +</p><hr> +<span id="summary-start_002ddate"></span><div class="header"> +<p> +Next: <a href="#summary-exit-status" accesskey="n" rel="next">summary exit status</a>, Previous: <a href="#summary-output_002ddirectory" accesskey="p" rel="prev">summary output-directory</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p> +</div> +<span id="start_002ddate-option"></span><h4 class="subsection">1.1.4 start-date option</h4> +<span id="index-summary_002dstart_002ddate"></span> + +<p>This is the “start date” option. +This option takes a num argument. + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +</p><hr> +<span id="summary-exit-status"></span><div class="header"> +<p> +Previous: <a href="#summary-start_002ddate" accesskey="p" rel="prev">summary start-date</a>, Up: <a href="#summary-usage" accesskey="u" rel="up">summary usage</a> </p> +</div> +<span id="summary-exit-status-1"></span><h4 class="subsection">1.1.5 summary exit status</h4> + +<p>One of the following exit values will be returned: +</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> |