1052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2052d159aSCy Schubert<html> 3052d159aSCy Schubert<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 42b15cb3dSCy Schubert<head> 5052d159aSCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6052d159aSCy Schubert<title>Summary User’s Manual</title> 7052d159aSCy Schubert 8052d159aSCy Schubert<meta name="description" content="Summary User’s Manual"> 9052d159aSCy Schubert<meta name="keywords" content="Summary User’s Manual"> 10052d159aSCy Schubert<meta name="resource-type" content="document"> 11052d159aSCy Schubert<meta name="distribution" content="global"> 12052d159aSCy Schubert<meta name="Generator" content="makeinfo"> 13052d159aSCy Schubert<link href="#Top" rel="start" title="Top"> 14052d159aSCy Schubert<link href="dir.html#Top" rel="up" title="(dir)"> 15052d159aSCy Schubert<style type="text/css"> 16052d159aSCy Schubert<!-- 17052d159aSCy Schuberta.summary-letter {text-decoration: none} 18052d159aSCy Schubertblockquote.indentedblock {margin-right: 0em} 19052d159aSCy Schubertblockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 20052d159aSCy Schubertblockquote.smallquotation {font-size: smaller} 21052d159aSCy Schubertdiv.display {margin-left: 3.2em} 22052d159aSCy Schubertdiv.example {margin-left: 3.2em} 23052d159aSCy Schubertdiv.lisp {margin-left: 3.2em} 24052d159aSCy Schubertdiv.smalldisplay {margin-left: 3.2em} 25052d159aSCy Schubertdiv.smallexample {margin-left: 3.2em} 26052d159aSCy Schubertdiv.smalllisp {margin-left: 3.2em} 27052d159aSCy Schubertkbd {font-style: oblique} 282b15cb3dSCy Schubertpre.display {font-family: inherit} 292b15cb3dSCy Schubertpre.format {font-family: inherit} 30052d159aSCy Schubertpre.menu-comment {font-family: serif} 31052d159aSCy Schubertpre.menu-preformatted {font-family: serif} 322b15cb3dSCy Schubertpre.smalldisplay {font-family: inherit; font-size: smaller} 332b15cb3dSCy Schubertpre.smallexample {font-size: smaller} 34052d159aSCy Schubertpre.smallformat {font-family: inherit; font-size: smaller} 352b15cb3dSCy Schubertpre.smalllisp {font-size: smaller} 36052d159aSCy Schubertspan.nolinebreak {white-space: nowrap} 37052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal} 38052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 39052d159aSCy Schubertul.no-bullet {list-style: none} 40052d159aSCy Schubert--> 41052d159aSCy Schubert</style> 42052d159aSCy Schubert 43052d159aSCy Schubert 442b15cb3dSCy Schubert</head> 45052d159aSCy Schubert 46052d159aSCy Schubert<body lang="en"> 47052d159aSCy Schubert<h1 class="settitle" align="center">Summary User’s Manual</h1> 48052d159aSCy Schubert 49052d159aSCy Schubert 50052d159aSCy Schubert 51052d159aSCy Schubert 52052d159aSCy Schubert 53052d159aSCy Schubert<a name="Top"></a> 54052d159aSCy Schubert<div class="header"> 55052d159aSCy Schubert<p> 56052d159aSCy SchubertPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 572b15cb3dSCy Schubert</div> 58052d159aSCy Schubert<a name="Summary-User-Manual"></a> 59052d159aSCy Schubert<h1 class="top">Summary User Manual</h1> 602b15cb3dSCy Schubert 61052d159aSCy Schubert<p>This document describes the use of the NTP Project’s <code>summary</code> program. 62052d159aSCy SchubertThis document applies to version 4.2.8p13 of <code>summary</code>. 63052d159aSCy Schubert</p> 64052d159aSCy Schubert<a name="SEC_Overview"></a> 65052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 662b15cb3dSCy Schubert 672b15cb3dSCy Schubert<div class="shortcontents"> 68052d159aSCy Schubert<ul class="no-bullet"> 69052d159aSCy 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 74052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 75052d159aSCy Schubert<tr><td align="left" valign="top">• summary Description:</td><td> </td><td align="left" valign="top">Description 76052d159aSCy Schubert</td></tr> 77052d159aSCy Schubert<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 78052d159aSCy Schubert</td></tr> 79052d159aSCy Schubert</table> 80052d159aSCy Schubert 81052d159aSCy Schubert<hr> 82052d159aSCy Schubert<a name="summary-Invocation"></a> 83052d159aSCy Schubert<div class="header"> 84052d159aSCy Schubert<p> 85052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 862b15cb3dSCy Schubert</div> 87052d159aSCy Schubert<a name="Invoking-summary"></a> 88052d159aSCy Schubert<h2 class="chapter">1 Invoking summary</h2> 89052d159aSCy Schubert<a name="index-summary"></a> 90052d159aSCy Schubert<a name="index-compute-various-stastics-from-NTP-stat-files"></a> 912b15cb3dSCy Schubert 922b15cb3dSCy Schubert 93052d159aSCy 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. 97052d159aSCy Schubert</p> 98052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 99052d159aSCy Schubert<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>) 100052d159aSCy Schubert</td></tr> 101052d159aSCy Schubert<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 102052d159aSCy Schubert</td></tr> 103052d159aSCy Schubert<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 104052d159aSCy Schubert</td></tr> 105052d159aSCy Schubert<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 106052d159aSCy Schubert</td></tr> 107052d159aSCy Schubert<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 108052d159aSCy Schubert</td></tr> 109052d159aSCy Schubert<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 110052d159aSCy Schubert</td></tr> 111052d159aSCy Schubert</table> 1122b15cb3dSCy Schubert 113052d159aSCy Schubert<hr> 114052d159aSCy Schubert<a name="summary-usage"></a> 115052d159aSCy Schubert<div class="header"> 116052d159aSCy Schubert<p> 117052d159aSCy SchubertNext: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> </p> 1182b15cb3dSCy Schubert</div> 119052d159aSCy Schubert<a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a> 120052d159aSCy Schubert<h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> 121052d159aSCy Schubert<a name="index-summary-help"></a> 1222b15cb3dSCy Schubert 123052d159aSCy Schubert<p>This is the automatically generated usage text for summary. 124052d159aSCy Schubert</p> 1252b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 126052d159aSCy 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 130052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1312b15cb3dSCy Schubertwith a status code of 0. 132052d159aSCy Schubert</p> 133052d159aSCy Schubert<div class="example"> 134052d159aSCy Schubert<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p13 1352b15cb3dSCy SchubertUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 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. 148052d159aSCy Schubert</pre></div> 149052d159aSCy Schubert 150052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 151052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td> </td><td align="left" valign="top"> 152052d159aSCy Schubert</td></tr> 153052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#summary-end_002ddate" accesskey="2">summary end-date</a>:</td><td> </td><td align="left" valign="top"> 154052d159aSCy Schubert</td></tr> 155052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#summary-output_002ddirectory" accesskey="3">summary output-directory</a>:</td><td> </td><td align="left" valign="top"> 156052d159aSCy Schubert</td></tr> 157052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#summary-start_002ddate" accesskey="4">summary start-date</a>:</td><td> </td><td align="left" valign="top"> 158052d159aSCy Schubert</td></tr> 159052d159aSCy Schubert<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"> 160052d159aSCy Schubert</td></tr> 161052d159aSCy Schubert</table> 162052d159aSCy Schubert 163052d159aSCy Schubert<hr> 164052d159aSCy Schubert<a name="summary-directory"></a> 165052d159aSCy Schubert<div class="header"> 166052d159aSCy Schubert<p> 167052d159aSCy 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> </p> 1682b15cb3dSCy Schubert</div> 169052d159aSCy Schubert<a name="directory-option"></a> 170052d159aSCy Schubert<h4 class="subsection">1.1.1 directory option</h4> 171052d159aSCy Schubert<a name="index-summary_002ddirectory"></a> 1722b15cb3dSCy Schubert 173052d159aSCy Schubert<p>This is the “directory containing stat files” 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>. 177052d159aSCy Schubert</p><hr> 178052d159aSCy Schubert<a name="summary-end_002ddate"></a> 179052d159aSCy Schubert<div class="header"> 180052d159aSCy Schubert<p> 181052d159aSCy 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> </p> 1822b15cb3dSCy Schubert</div> 183052d159aSCy Schubert<a name="end_002ddate-option"></a> 184052d159aSCy Schubert<h4 class="subsection">1.1.2 end-date option</h4> 185052d159aSCy Schubert<a name="index-summary_002dend_002ddate"></a> 1862b15cb3dSCy Schubert 187052d159aSCy Schubert<p>This is the “end date” 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. 192052d159aSCy Schubert</p><hr> 193052d159aSCy Schubert<a name="summary-output_002ddirectory"></a> 194052d159aSCy Schubert<div class="header"> 195052d159aSCy Schubert<p> 196052d159aSCy 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> </p> 1972b15cb3dSCy Schubert</div> 198052d159aSCy Schubert<a name="output_002ddirectory-option"></a> 199052d159aSCy Schubert<h4 class="subsection">1.1.3 output-directory option</h4> 200052d159aSCy Schubert<a name="index-summary_002doutput_002ddirectory"></a> 2012b15cb3dSCy Schubert 202052d159aSCy Schubert<p>This is the “output directory” option. 2032b15cb3dSCy SchubertThis option takes a str argument. 2042b15cb3dSCy Schubert The output directory <code>summary</code> will write all output files to. 205052d159aSCy Schubert</p><hr> 206052d159aSCy Schubert<a name="summary-start_002ddate"></a> 207052d159aSCy Schubert<div class="header"> 208052d159aSCy Schubert<p> 209052d159aSCy 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> </p> 2102b15cb3dSCy Schubert</div> 211052d159aSCy Schubert<a name="start_002ddate-option"></a> 212052d159aSCy Schubert<h4 class="subsection">1.1.4 start-date option</h4> 213052d159aSCy Schubert<a name="index-summary_002dstart_002ddate"></a> 2142b15cb3dSCy Schubert 215052d159aSCy Schubert<p>This is the “start date” 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. 219052d159aSCy Schubert</p><hr> 220052d159aSCy Schubert<a name="summary-exit-status"></a> 221052d159aSCy Schubert<div class="header"> 222052d159aSCy Schubert<p> 223052d159aSCy 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> </p> 2242b15cb3dSCy Schubert</div> 225052d159aSCy Schubert<a name="summary-exit-status-1"></a> 226052d159aSCy 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: 229052d159aSCy Schubert</p><dl compact="compact"> 230052d159aSCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 231052d159aSCy Schubert<dd><p>Successful program execution. 232052d159aSCy Schubert</p></dd> 233052d159aSCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 234052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid. 235052d159aSCy Schubert</p></dd> 2362b15cb3dSCy Schubert</dl> 237052d159aSCy Schubert<hr> 2382b15cb3dSCy Schubert 2392b15cb3dSCy Schubert 240052d159aSCy Schubert 241052d159aSCy Schubert</body> 242052d159aSCy Schubert</html> 243