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