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; }
22 <h1 class="settitle">Summary User's Manual</h1>
25 <a name="Top"></a>Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>,
26 Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27 Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
31 <h2 class="unnumbered">Summary User Manual</h2>
33 <p>This document describes the use of the NTP Project's <code>summary</code> program.
34 This document applies to version 4.2.8p11 of <code>summary</code>.
36 <div class="shortcontents">
37 <h2>Short Contents</h2>
39 <a href="#Top">Summary User Manual</a>
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
50 <a name="summary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>,
51 Up: <a rel="up" accesskey="u" href="#Top">Top</a>
55 <h3 class="section">Invoking summary</h3>
57 <p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a>
59 <p>This section was generated by <strong>AutoGen</strong>,
60 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program.
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
73 <a name="summary-usage"></a>Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>,
74 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
78 <h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4>
80 <p><a name="index-summary-help-3"></a>
81 This is the automatically generated usage text for summary.
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
85 the 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
88 used to select the program, defaulting to <span class="file">more</span>. Both will exit
89 with a status code of 0.
91 <pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p11
92 USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
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
103 Options are specified by doubled hyphens and their name or by a single
104 hyphen and the flag character.
108 <a name="summary-directory"></a>Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>,
109 Previous: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>,
110 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
114 <h4 class="subsection">directory option</h4>
116 <p><a name="index-summary_002ddirectory-4"></a>
117 This is the “directory containing stat files” option.
118 This option takes a string argument.
119 The directory where <code>ntpd</code> will search for .stat files generated
120 by <code>ntpd</code>.
123 <a name="summary-end_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>,
124 Previous: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>,
125 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
129 <h4 class="subsection">end-date option</h4>
131 <p><a name="index-summary_002dend_002ddate-5"></a>
132 This is the “end date” option.
133 This 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.
139 <a name="summary-output_002ddirectory"></a>Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>,
140 Previous: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>,
141 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
145 <h4 class="subsection">output-directory option</h4>
147 <p><a name="index-summary_002doutput_002ddirectory-6"></a>
148 This is the “output directory” option.
149 This option takes a str argument.
150 The output directory <code>summary</code> will write all output files to.
153 <a name="summary-start_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>,
154 Previous: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>,
155 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
159 <h4 class="subsection">start-date option</h4>
161 <p><a name="index-summary_002dstart_002ddate-7"></a>
162 This is the “start date” option.
163 This 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.
168 <a name="summary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>,
169 Up: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a>
173 <h4 class="subsection">summary exit status</h4>
175 <p>One of the following exit values will be returned:
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.