freebsd-skq/contrib/ntp/scripts/summary.html
Cy Schubert 276da39af9 MFV ntp-4.2.8p3 (r284990).
Approved by:	roberto, delphij
Security:	VuXML: 0d0f3050-1f69-11e5-9ba9-d050996490d0
Security:	http://bugs.ntp.org/show_bug.cgi?id=2853
Security:	https://www.kb.cert.org/vuls/id/668167
Security:	http://support.ntp.org/bin/view/Main/SecurityNotice#June_2015_NTP_Security_Vulnerabi
2015-07-05 15:42:16 +00:00

183 lines
7.8 KiB
HTML

<html lang="en">
<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>
</head>
<body>
<h1 class="settitle">Summary User's Manual</h1>
<div class="node">
<p><hr>
<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-Description">summary Description</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
<br>
</div>
<h2 class="unnumbered">Summary User Manual</h2>
<p>This document describes the use of the NTP Project's <code>summary</code> program.
This document applies to version 4.2.8p3 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:&nbsp;<a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
<br>
</div>
<h3 class="section">Invoking summary</h3>
<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a>
<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>
<div class="node">
<p><hr>
<a name="summary-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-directory">summary directory</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<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.
<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">summary - compute various stastics from NTP stat files - Ver. 4.2.8p3
USAGE: summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
--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 class="node">
<p><hr>
<a name="summary-directory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<h4 class="subsection">directory option</h4>
<p><a name="index-summary_002ddirectory-4"></a>
This is the &ldquo;directory containing stat files&rdquo; 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:&nbsp;<a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<h4 class="subsection">end-date option</h4>
<p><a name="index-summary_002dend_002ddate-5"></a>
This is the &ldquo;end date&rdquo; 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:&nbsp;<a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<h4 class="subsection">output-directory option</h4>
<p><a name="index-summary_002doutput_002ddirectory-6"></a>
This is the &ldquo;output directory&rdquo; 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:&nbsp;<a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<h4 class="subsection">start-date option</h4>
<p><a name="index-summary_002dstart_002ddate-7"></a>
This is the &ldquo;start date&rdquo; 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:&nbsp;<a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
<br>
</div>
<h4 class="subsection">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.
</dl>
</body></html>