1*052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2*052d159aSCy Schubert<html>
3*052d159aSCy Schubert<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
42b15cb3dSCy Schubert<head>
5*052d159aSCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6*052d159aSCy Schubert<title>Summary User&rsquo;s Manual</title>
7*052d159aSCy Schubert
8*052d159aSCy Schubert<meta name="description" content="Summary User&rsquo;s Manual">
9*052d159aSCy Schubert<meta name="keywords" content="Summary User&rsquo;s Manual">
10*052d159aSCy Schubert<meta name="resource-type" content="document">
11*052d159aSCy Schubert<meta name="distribution" content="global">
12*052d159aSCy Schubert<meta name="Generator" content="makeinfo">
13*052d159aSCy Schubert<link href="#Top" rel="start" title="Top">
14*052d159aSCy Schubert<link href="dir.html#Top" rel="up" title="(dir)">
15*052d159aSCy Schubert<style type="text/css">
16*052d159aSCy Schubert<!--
17*052d159aSCy Schuberta.summary-letter {text-decoration: none}
18*052d159aSCy Schubertblockquote.indentedblock {margin-right: 0em}
19*052d159aSCy Schubertblockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
20*052d159aSCy Schubertblockquote.smallquotation {font-size: smaller}
21*052d159aSCy Schubertdiv.display {margin-left: 3.2em}
22*052d159aSCy Schubertdiv.example {margin-left: 3.2em}
23*052d159aSCy Schubertdiv.lisp {margin-left: 3.2em}
24*052d159aSCy Schubertdiv.smalldisplay {margin-left: 3.2em}
25*052d159aSCy Schubertdiv.smallexample {margin-left: 3.2em}
26*052d159aSCy Schubertdiv.smalllisp {margin-left: 3.2em}
27*052d159aSCy Schubertkbd {font-style: oblique}
282b15cb3dSCy Schubertpre.display {font-family: inherit}
292b15cb3dSCy Schubertpre.format {font-family: inherit}
30*052d159aSCy Schubertpre.menu-comment {font-family: serif}
31*052d159aSCy Schubertpre.menu-preformatted {font-family: serif}
322b15cb3dSCy Schubertpre.smalldisplay {font-family: inherit; font-size: smaller}
332b15cb3dSCy Schubertpre.smallexample {font-size: smaller}
34*052d159aSCy Schubertpre.smallformat {font-family: inherit; font-size: smaller}
352b15cb3dSCy Schubertpre.smalllisp {font-size: smaller}
36*052d159aSCy Schubertspan.nolinebreak {white-space: nowrap}
37*052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal}
38*052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal}
39*052d159aSCy Schubertul.no-bullet {list-style: none}
40*052d159aSCy Schubert-->
41*052d159aSCy Schubert</style>
42*052d159aSCy Schubert
43*052d159aSCy Schubert
442b15cb3dSCy Schubert</head>
45*052d159aSCy Schubert
46*052d159aSCy Schubert<body lang="en">
47*052d159aSCy Schubert<h1 class="settitle" align="center">Summary User&rsquo;s Manual</h1>
48*052d159aSCy Schubert
49*052d159aSCy Schubert
50*052d159aSCy Schubert
51*052d159aSCy Schubert
52*052d159aSCy Schubert
53*052d159aSCy Schubert<a name="Top"></a>
54*052d159aSCy Schubert<div class="header">
55*052d159aSCy Schubert<p>
56*052d159aSCy SchubertPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> &nbsp; </p>
572b15cb3dSCy Schubert</div>
58*052d159aSCy Schubert<a name="Summary-User-Manual"></a>
59*052d159aSCy Schubert<h1 class="top">Summary User Manual</h1>
602b15cb3dSCy Schubert
61*052d159aSCy Schubert<p>This document describes the use of the NTP Project&rsquo;s <code>summary</code> program.
62*052d159aSCy SchubertThis document applies to version 4.2.8p13 of <code>summary</code>.
63*052d159aSCy Schubert</p>
64*052d159aSCy Schubert<a name="SEC_Overview"></a>
65*052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2>
662b15cb3dSCy Schubert
672b15cb3dSCy Schubert<div class="shortcontents">
68*052d159aSCy Schubert<ul class="no-bullet">
69*052d159aSCy Schubert<li><a name="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li>
702b15cb3dSCy Schubert</ul>
712b15cb3dSCy Schubert</div>
722b15cb3dSCy Schubert
732b15cb3dSCy Schubert
74*052d159aSCy Schubert<table class="menu" border="0" cellspacing="0">
75*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; summary Description:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description
76*052d159aSCy Schubert</td></tr>
77*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-Invocation" accesskey="2">summary Invocation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Invoking summary
78*052d159aSCy Schubert</td></tr>
79*052d159aSCy Schubert</table>
80*052d159aSCy Schubert
81*052d159aSCy Schubert<hr>
82*052d159aSCy Schubert<a name="summary-Invocation"></a>
83*052d159aSCy Schubert<div class="header">
84*052d159aSCy Schubert<p>
85*052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; </p>
862b15cb3dSCy Schubert</div>
87*052d159aSCy Schubert<a name="Invoking-summary"></a>
88*052d159aSCy Schubert<h2 class="chapter">1 Invoking summary</h2>
89*052d159aSCy Schubert<a name="index-summary"></a>
90*052d159aSCy Schubert<a name="index-compute-various-stastics-from-NTP-stat-files"></a>
912b15cb3dSCy Schubert
922b15cb3dSCy Schubert
93*052d159aSCy Schubert
942b15cb3dSCy Schubert
952b15cb3dSCy Schubert<p>This section was generated by <strong>AutoGen</strong>,
962b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program.
97*052d159aSCy Schubert</p>
98*052d159aSCy Schubert<table class="menu" border="0" cellspacing="0">
99*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-usage" accesskey="1">summary usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">summary help/usage (<samp>--help</samp>)
100*052d159aSCy Schubert</td></tr>
101*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-directory" accesskey="2">summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">directory option
102*052d159aSCy Schubert</td></tr>
103*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-end_002ddate" accesskey="3">summary end-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">end-date option
104*052d159aSCy Schubert</td></tr>
105*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">output-directory option
106*052d159aSCy Schubert</td></tr>
107*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-start_002ddate" accesskey="5">summary start-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">start-date option
108*052d159aSCy Schubert</td></tr>
109*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-exit-status" accesskey="6">summary exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">exit status
110*052d159aSCy Schubert</td></tr>
111*052d159aSCy Schubert</table>
1122b15cb3dSCy Schubert
113*052d159aSCy Schubert<hr>
114*052d159aSCy Schubert<a name="summary-usage"></a>
115*052d159aSCy Schubert<div class="header">
116*052d159aSCy Schubert<p>
117*052d159aSCy SchubertNext: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> &nbsp; </p>
1182b15cb3dSCy Schubert</div>
119*052d159aSCy Schubert<a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a>
120*052d159aSCy Schubert<h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3>
121*052d159aSCy Schubert<a name="index-summary-help"></a>
1222b15cb3dSCy Schubert
123*052d159aSCy Schubert<p>This is the automatically generated usage text for summary.
124*052d159aSCy Schubert</p>
1252b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option
126*052d159aSCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>).  <code>more-help</code> will print
1272b15cb3dSCy Schubertthe usage text by passing it through a pager program.
1282b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working
1292b15cb3dSCy Schubert<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
130*052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>.  Both will exit
1312b15cb3dSCy Schubertwith a status code of 0.
132*052d159aSCy Schubert</p>
133*052d159aSCy Schubert<div class="example">
134*052d159aSCy Schubert<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p13
1352b15cb3dSCy SchubertUSAGE: summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
1362b15cb3dSCy Schubert
1372b15cb3dSCy Schubert        --directory=str          Directory containing stat files
1382b15cb3dSCy Schubert        --end-date=num           End date
1392b15cb3dSCy Schubert        --output-directory=str   Output directory
1402b15cb3dSCy Schubert        --peer-dist-limit=float  Peer dist limit
1412b15cb3dSCy Schubert        --skip-time-steps=float  Ignore time offsets larger that this
1422b15cb3dSCy Schubert        --start-date=num         Start date
1432b15cb3dSCy Schubert    -?, --help                   Display usage information and exit
1442b15cb3dSCy Schubert        --more-help              Pass the extended usage text through a pager
1452b15cb3dSCy Schubert
1462b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single
1472b15cb3dSCy Schuberthyphen and the flag character.
148*052d159aSCy Schubert</pre></div>
149*052d159aSCy Schubert
150*052d159aSCy Schubert<table class="menu" border="0" cellspacing="0">
151*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
152*052d159aSCy Schubert</td></tr>
153*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-end_002ddate" accesskey="2">summary end-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
154*052d159aSCy Schubert</td></tr>
155*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-output_002ddirectory" accesskey="3">summary output-directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
156*052d159aSCy Schubert</td></tr>
157*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-start_002ddate" accesskey="4">summary start-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
158*052d159aSCy Schubert</td></tr>
159*052d159aSCy Schubert<tr><td align="left" valign="top">&bull; <a href="#summary-exit-status" accesskey="5">summary exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
160*052d159aSCy Schubert</td></tr>
161*052d159aSCy Schubert</table>
162*052d159aSCy Schubert
163*052d159aSCy Schubert<hr>
164*052d159aSCy Schubert<a name="summary-directory"></a>
165*052d159aSCy Schubert<div class="header">
166*052d159aSCy Schubert<p>
167*052d159aSCy SchubertNext: <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> &nbsp; </p>
1682b15cb3dSCy Schubert</div>
169*052d159aSCy Schubert<a name="directory-option"></a>
170*052d159aSCy Schubert<h4 class="subsection">1.1.1 directory option</h4>
171*052d159aSCy Schubert<a name="index-summary_002ddirectory"></a>
1722b15cb3dSCy Schubert
173*052d159aSCy Schubert<p>This is the &ldquo;directory containing stat files&rdquo; option.
1742b15cb3dSCy SchubertThis option takes a string argument.
1752b15cb3dSCy Schubert        The directory where <code>ntpd</code> will search for .stat files generated
1762b15cb3dSCy Schubert        by <code>ntpd</code>.
177*052d159aSCy Schubert</p><hr>
178*052d159aSCy Schubert<a name="summary-end_002ddate"></a>
179*052d159aSCy Schubert<div class="header">
180*052d159aSCy Schubert<p>
181*052d159aSCy SchubertNext: <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> &nbsp; </p>
1822b15cb3dSCy Schubert</div>
183*052d159aSCy Schubert<a name="end_002ddate-option"></a>
184*052d159aSCy Schubert<h4 class="subsection">1.1.2 end-date option</h4>
185*052d159aSCy Schubert<a name="index-summary_002dend_002ddate"></a>
1862b15cb3dSCy Schubert
187*052d159aSCy Schubert<p>This is the &ldquo;end date&rdquo; option.
1882b15cb3dSCy SchubertThis option takes a number argument.
1892b15cb3dSCy Schubert        Process all files with the date suffix less or equal to value of this
1902b15cb3dSCy Schubert        option.  Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>)
1912b15cb3dSCy Schubert        to get the timestamp.
192*052d159aSCy Schubert</p><hr>
193*052d159aSCy Schubert<a name="summary-output_002ddirectory"></a>
194*052d159aSCy Schubert<div class="header">
195*052d159aSCy Schubert<p>
196*052d159aSCy SchubertNext: <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> &nbsp; </p>
1972b15cb3dSCy Schubert</div>
198*052d159aSCy Schubert<a name="output_002ddirectory-option"></a>
199*052d159aSCy Schubert<h4 class="subsection">1.1.3 output-directory option</h4>
200*052d159aSCy Schubert<a name="index-summary_002doutput_002ddirectory"></a>
2012b15cb3dSCy Schubert
202*052d159aSCy Schubert<p>This is the &ldquo;output directory&rdquo; option.
2032b15cb3dSCy SchubertThis option takes a str argument.
2042b15cb3dSCy Schubert        The output directory <code>summary</code> will write all output files to.
205*052d159aSCy Schubert</p><hr>
206*052d159aSCy Schubert<a name="summary-start_002ddate"></a>
207*052d159aSCy Schubert<div class="header">
208*052d159aSCy Schubert<p>
209*052d159aSCy SchubertNext: <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> &nbsp; </p>
2102b15cb3dSCy Schubert</div>
211*052d159aSCy Schubert<a name="start_002ddate-option"></a>
212*052d159aSCy Schubert<h4 class="subsection">1.1.4 start-date option</h4>
213*052d159aSCy Schubert<a name="index-summary_002dstart_002ddate"></a>
2142b15cb3dSCy Schubert
215*052d159aSCy Schubert<p>This is the &ldquo;start date&rdquo; option.
2162b15cb3dSCy SchubertThis option takes a num argument.
2172b15cb3dSCy Schubert        Process all files with the date suffix more or equal to value of
2182b15cb3dSCy Schubert        this option.  Defaults to 197000101.
219*052d159aSCy Schubert</p><hr>
220*052d159aSCy Schubert<a name="summary-exit-status"></a>
221*052d159aSCy Schubert<div class="header">
222*052d159aSCy Schubert<p>
223*052d159aSCy SchubertPrevious: <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> &nbsp; </p>
2242b15cb3dSCy Schubert</div>
225*052d159aSCy Schubert<a name="summary-exit-status-1"></a>
226*052d159aSCy Schubert<h4 class="subsection">1.1.5 summary exit status</h4>
2272b15cb3dSCy Schubert
2282b15cb3dSCy Schubert<p>One of the following exit values will be returned:
229*052d159aSCy Schubert</p><dl compact="compact">
230*052d159aSCy Schubert<dt>&lsquo;<samp>0 (EXIT_SUCCESS)</samp>&rsquo;</dt>
231*052d159aSCy Schubert<dd><p>Successful program execution.
232*052d159aSCy Schubert</p></dd>
233*052d159aSCy Schubert<dt>&lsquo;<samp>1 (EXIT_FAILURE)</samp>&rsquo;</dt>
234*052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid.
235*052d159aSCy Schubert</p></dd>
2362b15cb3dSCy Schubert</dl>
237*052d159aSCy Schubert<hr>
2382b15cb3dSCy Schubert
2392b15cb3dSCy Schubert
240*052d159aSCy Schubert
241*052d159aSCy Schubert</body>
242*052d159aSCy Schubert</html>
243