diff options
Diffstat (limited to 'scripts/summary.html')
| -rw-r--r-- | scripts/summary.html | 324 |
1 files changed, 192 insertions, 132 deletions
diff --git a/scripts/summary.html b/scripts/summary.html index 55e0ca90c58f..b6e47e19d762 100644 --- a/scripts/summary.html +++ b/scripts/summary.html @@ -1,95 +1,138 @@ -<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>Summary User's Manual</title> -<meta http-equiv="Content-Type" content="text/html"> -<meta name="description" content="Summary 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>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} +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">Summary User's Manual</h1> -<div class="node"> -<p><hr> -<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -<br> -</div> -<h2 class="unnumbered">Summary User Manual</h2> +<body lang="en"> +<h1 class="settitle" align="center">Summary User’s Manual</h1> -<p>This document describes the use of the NTP Project's <code>summary</code> program. -This document applies to version 4.2.8p12 of <code>summary</code>. - <div class="shortcontents"> -<h2>Short Contents</h2> -<ul> -<a href="#Top">Summary User Manual</a> -</ul> -</div> -<ul class="menu"> -<li><a accesskey="1" href="#summary-Description">summary Description</a>: Description -<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: Invoking summary -</ul> -<div class="node"> -<p><hr> -<a name="summary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> -<br> + +<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> +<a name="Summary-User-Manual"></a> +<h1 class="top">Summary User Manual</h1> -<h3 class="section">Invoking summary</h3> +<p>This document describes the use of the NTP Project’s <code>summary</code> program. +This document applies to version 4.2.8p13 of <code>summary</code>. +</p> +<a name="SEC_Overview"></a> +<h2 class="shortcontents-heading">Short Table of Contents</h2> -<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a> +<div class="shortcontents"> +<ul class="no-bullet"> +<li><a name="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li> +</ul> +</div> - <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. -<ul class="menu"> -<li><a accesskey="1" href="#summary-usage">summary usage</a>: summary help/usage (<span class="option">--help</span>) -<li><a accesskey="2" href="#summary-directory">summary directory</a>: directory option -<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>: end-date option -<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>: output-directory option -<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>: start-date option -<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>: exit status -</ul> +<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> -<div class="node"> -<p><hr> -<a name="summary-usage"></a>Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> +<hr> +<a name="summary-Invocation"></a> +<div class="header"> +<p> +Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> </div> +<a name="Invoking-summary"></a> +<h2 class="chapter">1 Invoking summary</h2> +<a name="index-summary"></a> +<a name="index-compute-various-stastics-from-NTP-stat-files"></a> + -<h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4> -<p><a name="index-summary-help-3"></a> -This is the automatically generated usage text for summary. - <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. +<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> +<a name="summary-usage"></a> +<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> +<a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a> +<h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> +<a name="index-summary-help"></a> + +<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 <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">summary - compute various stastics from NTP stat files - Ver. 4.2.8p12 -USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... +</p> +<div class="example"> +<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p13 +USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... --directory=str Directory containing stat files --end-date=num End date @@ -102,81 +145,98 @@ USAGE: summary [ -<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="summary-directory"></a>Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>, -Previous: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> -</div> +</pre></div> -<h4 class="subsection">directory option</h4> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">summary end-date</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">summary output-directory</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">summary start-date</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> -<p><a name="index-summary_002ddirectory-4"></a> -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>. -<div class="node"> -<p><hr> -<a name="summary-end_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>, -Previous: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> +<hr> +<a name="summary-directory"></a> +<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> +<a name="directory-option"></a> +<h4 class="subsection">1.1.1 directory option</h4> +<a name="index-summary_002ddirectory"></a> -<h4 class="subsection">end-date option</h4> +<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> +<a name="summary-end_002ddate"></a> +<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> +<a name="end_002ddate-option"></a> +<h4 class="subsection">1.1.2 end-date option</h4> +<a name="index-summary_002dend_002ddate"></a> -<p><a name="index-summary_002dend_002ddate-5"></a> -This is the “end date” option. -This option takes a number argument. +<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. -<div class="node"> -<p><hr> -<a name="summary-output_002ddirectory"></a>Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>, -Previous: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> + to get the timestamp. +</p><hr> +<a name="summary-output_002ddirectory"></a> +<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> +<a name="output_002ddirectory-option"></a> +<h4 class="subsection">1.1.3 output-directory option</h4> +<a name="index-summary_002doutput_002ddirectory"></a> -<h4 class="subsection">output-directory option</h4> - -<p><a name="index-summary_002doutput_002ddirectory-6"></a> -This is the “output directory” option. -This option takes a str argument. - The output directory <code>summary</code> will write all output files to. -<div class="node"> -<p><hr> -<a name="summary-start_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>, -Previous: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> +<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> +<a name="summary-start_002ddate"></a> +<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> +<a name="start_002ddate-option"></a> +<h4 class="subsection">1.1.4 start-date option</h4> +<a name="index-summary_002dstart_002ddate"></a> -<h4 class="subsection">start-date option</h4> - -<p><a name="index-summary_002dstart_002ddate-7"></a> -This is the “start date” option. -This option takes a num argument. +<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. -<div class="node"> -<p><hr> -<a name="summary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>, -Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> -<br> + this option. Defaults to 197000101. +</p><hr> +<a name="summary-exit-status"></a> +<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> - -<h4 class="subsection">summary exit status</h4> +<a name="summary-exit-status-1"></a> +<h4 class="subsection">1.1.5 summary 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> |