xref: /freebsd/contrib/ntp/scripts/summary.html (revision cc426dd31990b8b50b210efc450e404596548ca1)
1<html lang="en">
2<head>
3<title>Summary User's Manual</title>
4<meta http-equiv="Content-Type" content="text/html">
5<meta name="description" content="Summary User's Manual">
6<meta name="generator" content="makeinfo 4.7">
7<link title="Top" rel="top" href="#Top">
8<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9<meta http-equiv="Content-Style-Type" content="text/css">
10<style type="text/css"><!--
11  pre.display { font-family:inherit }
12  pre.format  { font-family:inherit }
13  pre.smalldisplay { font-family:inherit; font-size:smaller }
14  pre.smallformat  { font-family:inherit; font-size:smaller }
15  pre.smallexample { font-size:smaller }
16  pre.smalllisp    { font-size:smaller }
17  span.sc { font-variant:small-caps }
18  span.roman { font-family: serif; font-weight: normal; }
19--></style>
20</head>
21<body>
22<h1 class="settitle">Summary User's Manual</h1>
23<div class="node">
24<p><hr>
25<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-Description">summary Description</a>,
26Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28<br>
29</div>
30
31<h2 class="unnumbered">Summary User Manual</h2>
32
33<p>This document describes the use of the NTP Project's <code>summary</code> program.
34This document applies to version 4.2.8p12 of <code>summary</code>.
35
36  <div class="shortcontents">
37<h2>Short Contents</h2>
38<ul>
39<a href="#Top">Summary User Manual</a>
40</ul>
41</div>
42
43<ul class="menu">
44<li><a accesskey="1" href="#summary-Description">summary Description</a>:              Description
45<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: 		    Invoking summary
46</ul>
47
48<div class="node">
49<p><hr>
50<a name="summary-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>,
51Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
52<br>
53</div>
54
55<h3 class="section">Invoking summary</h3>
56
57<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a>
58
59  <p>This section was generated by <strong>AutoGen</strong>,
60using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program.
61
62<ul class="menu">
63<li><a accesskey="1" href="#summary-usage">summary usage</a>:                   summary help/usage (<span class="option">--help</span>)
64<li><a accesskey="2" href="#summary-directory">summary directory</a>:               directory option
65<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>:                end-date option
66<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>:        output-directory option
67<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>:              start-date option
68<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>:             exit status
69</ul>
70
71<div class="node">
72<p><hr>
73<a name="summary-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-directory">summary directory</a>,
74Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
75<br>
76</div>
77
78<h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4>
79
80<p><a name="index-summary-help-3"></a>
81This is the automatically generated usage text for summary.
82
83  <p>The text printed is the same whether selected with the <code>help</code> option
84(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
85the usage text by passing it through a pager program.
86<code>more-help</code> is disabled on platforms without a working
87<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
88used to select the program, defaulting to <span class="file">more</span>.  Both will exit
89with a status code of 0.
90
91<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p12
92USAGE: summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
93
94        --directory=str          Directory containing stat files
95        --end-date=num           End date
96        --output-directory=str   Output directory
97        --peer-dist-limit=float  Peer dist limit
98        --skip-time-steps=float  Ignore time offsets larger that this
99        --start-date=num         Start date
100    -?, --help                   Display usage information and exit
101        --more-help              Pass the extended usage text through a pager
102
103Options are specified by doubled hyphens and their name or by a single
104hyphen and the flag character.
105</pre>
106  <div class="node">
107<p><hr>
108<a name="summary-directory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>,
109Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>,
110Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
111<br>
112</div>
113
114<h4 class="subsection">directory option</h4>
115
116<p><a name="index-summary_002ddirectory-4"></a>
117This is the &ldquo;directory containing stat files&rdquo; option.
118This option takes a string argument.
119        The directory where <code>ntpd</code> will search for .stat files generated
120        by <code>ntpd</code>.
121<div class="node">
122<p><hr>
123<a name="summary-end_002ddate"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>,
124Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>,
125Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
126<br>
127</div>
128
129<h4 class="subsection">end-date option</h4>
130
131<p><a name="index-summary_002dend_002ddate-5"></a>
132This is the &ldquo;end date&rdquo; option.
133This option takes a number argument.
134        Process all files with the date suffix less or equal to value of this
135        option.  Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>)
136        to get the timestamp.
137<div class="node">
138<p><hr>
139<a name="summary-output_002ddirectory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>,
140Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>,
141Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
142<br>
143</div>
144
145<h4 class="subsection">output-directory option</h4>
146
147<p><a name="index-summary_002doutput_002ddirectory-6"></a>
148This is the &ldquo;output directory&rdquo; option.
149This option takes a str argument.
150        The output directory <code>summary</code> will write all output files to.
151<div class="node">
152<p><hr>
153<a name="summary-start_002ddate"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>,
154Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>,
155Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
156<br>
157</div>
158
159<h4 class="subsection">start-date option</h4>
160
161<p><a name="index-summary_002dstart_002ddate-7"></a>
162This is the &ldquo;start date&rdquo; option.
163This option takes a num argument.
164        Process all files with the date suffix more or equal to value of
165        this option.  Defaults to 197000101.
166<div class="node">
167<p><hr>
168<a name="summary-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>,
169Up:&nbsp;<a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
170<br>
171</div>
172
173<h4 class="subsection">summary exit status</h4>
174
175<p>One of the following exit values will be returned:
176     <dl>
177<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution.
178<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid.
179</dl>
180
181</body></html>
182
183