1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 4<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6<title>Summary User’s Manual</title> 7 8<meta name="description" content="Summary User’s Manual"> 9<meta name="keywords" content="Summary User’s Manual"> 10<meta name="resource-type" content="document"> 11<meta name="distribution" content="global"> 12<meta name="Generator" content="makeinfo"> 13<link href="#Top" rel="start" title="Top"> 14<link href="dir.html#Top" rel="up" title="(dir)"> 15<style type="text/css"> 16<!-- 17a.summary-letter {text-decoration: none} 18blockquote.indentedblock {margin-right: 0em} 19div.display {margin-left: 3.2em} 20div.example {margin-left: 3.2em} 21div.lisp {margin-left: 3.2em} 22kbd {font-style: oblique} 23pre.display {font-family: inherit} 24pre.format {font-family: inherit} 25pre.menu-comment {font-family: serif} 26pre.menu-preformatted {font-family: serif} 27span.nolinebreak {white-space: nowrap} 28span.roman {font-family: initial; font-weight: normal} 29span.sansserif {font-family: sans-serif; font-weight: normal} 30ul.no-bullet {list-style: none} 31--> 32</style> 33 34 35</head> 36 37<body lang="en"> 38<h1 class="settitle" align="center">Summary User’s Manual</h1> 39 40 41 42 43 44<span id="Top"></span><div class="header"> 45<p> 46Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 47</div> 48<span id="Summary-User-Manual"></span><h1 class="top">Summary User Manual</h1> 49 50<p>This document describes the use of the NTP Project’s <code>summary</code> program. 51This document applies to version 4.2.8p17 of <code>summary</code>. 52</p> 53<span id="SEC_Overview"></span> 54<h2 class="shortcontents-heading">Short Table of Contents</h2> 55 56<div class="shortcontents"> 57<ul class="no-bullet"> 58<li><a id="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li> 59</ul> 60</div> 61 62 63<table class="menu" border="0" cellspacing="0"> 64<tr><td align="left" valign="top">• summary Description</td><td> </td><td align="left" valign="top">Description 65</td></tr> 66<tr><td align="left" valign="top">• <a href="#summary-Invocation" accesskey="2">summary Invocation</a></td><td> </td><td align="left" valign="top">Invoking summary 67</td></tr> 68</table> 69 70<hr> 71<span id="summary-Invocation"></span><div class="header"> 72<p> 73Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 74</div> 75<span id="Invoking-summary"></span><h2 class="chapter">1 Invoking summary</h2> 76<span id="index-summary"></span> 77<span id="index-compute-various-stastics-from-NTP-stat-files"></span> 78 79 80 81 82<p>This section was generated by <strong>AutoGen</strong>, 83using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 84</p> 85<table class="menu" border="0" cellspacing="0"> 86<tr><td align="left" valign="top">• <a href="#summary-usage" accesskey="1">summary usage</a></td><td> </td><td align="left" valign="top">summary help/usage (<samp>--help</samp>) 87</td></tr> 88<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="2">summary directory</a></td><td> </td><td align="left" valign="top">directory option 89</td></tr> 90<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="3">summary end-date</a></td><td> </td><td align="left" valign="top">end-date option 91</td></tr> 92<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a></td><td> </td><td align="left" valign="top">output-directory option 93</td></tr> 94<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="5">summary start-date</a></td><td> </td><td align="left" valign="top">start-date option 95</td></tr> 96<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="6">summary exit status</a></td><td> </td><td align="left" valign="top">exit status 97</td></tr> 98</table> 99 100<hr> 101<span id="summary-usage"></span><div class="header"> 102<p> 103Next: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> </p> 104</div> 105<span id="summary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> 106<span id="index-summary-help"></span> 107 108<p>This is the automatically generated usage text for summary. 109</p> 110<p>The text printed is the same whether selected with the <code>help</code> option 111(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 112the usage text by passing it through a pager program. 113<code>more-help</code> is disabled on platforms without a working 114<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115used to select the program, defaulting to <samp>more</samp>. Both will exit 116with a status code of 0. 117</p> 118<div class="example"> 119<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p17 120USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 121 122 --directory=str Directory containing stat files 123 --end-date=num End date 124 --output-directory=str Output directory 125 --peer-dist-limit=float Peer dist limit 126 --skip-time-steps=float Ignore time offsets larger that this 127 --start-date=num Start date 128 -?, --help Display usage information and exit 129 --more-help Pass the extended usage text through a pager 130 131Options are specified by doubled hyphens and their name or by a single 132hyphen and the flag character. 133</pre></div> 134 135<table class="menu" border="0" cellspacing="0"> 136<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> 137</td></tr> 138<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">end-date option</a></td><td> </td><td align="left" valign="top"> 139</td></tr> 140<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">output-directory option</a></td><td> </td><td align="left" valign="top"> 141</td></tr> 142<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">start-date option</a></td><td> </td><td align="left" valign="top"> 143</td></tr> 144<tr><td align="left" valign="top">• <a href="#summary-exit-status" accesskey="5">summary exit status</a></td><td> </td><td align="left" valign="top"> 145</td></tr> 146</table> 147 148<hr> 149<span id="summary-directory"></span><div class="header"> 150<p> 151Next: <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> </p> 152</div> 153<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 154<span id="index-summary_002ddirectory"></span> 155 156<p>This is the “directory containing stat files” option. 157This option takes a string argument. 158 The directory where <code>ntpd</code> will search for .stat files generated 159 by <code>ntpd</code>. 160</p><hr> 161<span id="summary-end_002ddate"></span><div class="header"> 162<p> 163Next: <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> </p> 164</div> 165<span id="end_002ddate-option"></span><h4 class="subsection">1.1.2 end-date option</h4> 166<span id="index-summary_002dend_002ddate"></span> 167 168<p>This is the “end date” option. 169This option takes a number argument. 170 Process all files with the date suffix less or equal to value of this 171 option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 172 to get the timestamp. 173</p><hr> 174<span id="summary-output_002ddirectory"></span><div class="header"> 175<p> 176Next: <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> </p> 177</div> 178<span id="output_002ddirectory-option"></span><h4 class="subsection">1.1.3 output-directory option</h4> 179<span id="index-summary_002doutput_002ddirectory"></span> 180 181<p>This is the “output directory” option. 182This option takes a str argument. 183 The output directory <code>summary</code> will write all output files to. 184</p><hr> 185<span id="summary-start_002ddate"></span><div class="header"> 186<p> 187Next: <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> </p> 188</div> 189<span id="start_002ddate-option"></span><h4 class="subsection">1.1.4 start-date option</h4> 190<span id="index-summary_002dstart_002ddate"></span> 191 192<p>This is the “start date” option. 193This option takes a num argument. 194 Process all files with the date suffix more or equal to value of 195 this option. Defaults to 197000101. 196</p><hr> 197<span id="summary-exit-status"></span><div class="header"> 198<p> 199Previous: <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> </p> 200</div> 201<span id="summary-exit-status-1"></span><h4 class="subsection">1.1.5 summary exit status</h4> 202 203<p>One of the following exit values will be returned: 204</p><dl compact="compact"> 205<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 206<dd><p>Successful program execution. 207</p></dd> 208<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 209<dd><p>The operation failed or the command syntax was not valid. 210</p></dd> 211</dl> 212<hr> 213 214 215 216</body> 217</html> 218