165853c10SCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 265853c10SCy Schubert<html> 365853c10SCy Schubert<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 42b15cb3dSCy Schubert<head> 565853c10SCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 665853c10SCy Schubert<title>Summary User’s Manual</title> 765853c10SCy Schubert 865853c10SCy Schubert<meta name="description" content="Summary User’s Manual"> 965853c10SCy Schubert<meta name="keywords" content="Summary User’s Manual"> 1065853c10SCy Schubert<meta name="resource-type" content="document"> 1165853c10SCy Schubert<meta name="distribution" content="global"> 1265853c10SCy Schubert<meta name="Generator" content="makeinfo"> 1365853c10SCy Schubert<link href="#Top" rel="start" title="Top"> 1465853c10SCy Schubert<link href="dir.html#Top" rel="up" title="(dir)"> 1565853c10SCy Schubert<style type="text/css"> 1665853c10SCy Schubert<!-- 1765853c10SCy Schuberta.summary-letter {text-decoration: none} 1865853c10SCy Schubertblockquote.indentedblock {margin-right: 0em} 1965853c10SCy Schubertblockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 2065853c10SCy Schubertblockquote.smallquotation {font-size: smaller} 2165853c10SCy Schubertdiv.display {margin-left: 3.2em} 2265853c10SCy Schubertdiv.example {margin-left: 3.2em} 2365853c10SCy Schubertdiv.lisp {margin-left: 3.2em} 2465853c10SCy Schubertdiv.smalldisplay {margin-left: 3.2em} 2565853c10SCy Schubertdiv.smallexample {margin-left: 3.2em} 2665853c10SCy Schubertdiv.smalllisp {margin-left: 3.2em} 2765853c10SCy Schubertkbd {font-style: oblique} 282b15cb3dSCy Schubertpre.display {font-family: inherit} 292b15cb3dSCy Schubertpre.format {font-family: inherit} 3065853c10SCy Schubertpre.menu-comment {font-family: serif} 3165853c10SCy Schubertpre.menu-preformatted {font-family: serif} 322b15cb3dSCy Schubertpre.smalldisplay {font-family: inherit; font-size: smaller} 332b15cb3dSCy Schubertpre.smallexample {font-size: smaller} 3465853c10SCy Schubertpre.smallformat {font-family: inherit; font-size: smaller} 352b15cb3dSCy Schubertpre.smalllisp {font-size: smaller} 3665853c10SCy Schubertspan.nolinebreak {white-space: nowrap} 3765853c10SCy Schubertspan.roman {font-family: initial; font-weight: normal} 3865853c10SCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 3965853c10SCy Schubertul.no-bullet {list-style: none} 4065853c10SCy Schubert--> 4165853c10SCy Schubert</style> 4265853c10SCy Schubert 4365853c10SCy Schubert 442b15cb3dSCy Schubert</head> 4565853c10SCy Schubert 4665853c10SCy Schubert<body lang="en"> 4765853c10SCy Schubert<h1 class="settitle" align="center">Summary User’s Manual</h1> 4865853c10SCy Schubert 4965853c10SCy Schubert 5065853c10SCy Schubert 5165853c10SCy Schubert 5265853c10SCy Schubert 5365853c10SCy Schubert<a name="Top"></a> 5465853c10SCy Schubert<div class="header"> 5565853c10SCy Schubert<p> 5665853c10SCy 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> 5865853c10SCy Schubert<a name="Summary-User-Manual"></a> 5965853c10SCy Schubert<h1 class="top">Summary User Manual</h1> 602b15cb3dSCy Schubert 6165853c10SCy Schubert<p>This document describes the use of the NTP Project’s <code>summary</code> program. 62*298b6337SGordon TetlowThis document applies to version 4.2.8p14 of <code>summary</code>. 6365853c10SCy Schubert</p> 6465853c10SCy Schubert<a name="SEC_Overview"></a> 6565853c10SCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 662b15cb3dSCy Schubert 672b15cb3dSCy Schubert<div class="shortcontents"> 6865853c10SCy Schubert<ul class="no-bullet"> 6965853c10SCy 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 7465853c10SCy Schubert<table class="menu" border="0" cellspacing="0"> 7565853c10SCy Schubert<tr><td align="left" valign="top">• summary Description:</td><td> </td><td align="left" valign="top">Description 7665853c10SCy Schubert</td></tr> 7765853c10SCy 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 7865853c10SCy Schubert</td></tr> 7965853c10SCy Schubert</table> 8065853c10SCy Schubert 8165853c10SCy Schubert<hr> 8265853c10SCy Schubert<a name="summary-Invocation"></a> 8365853c10SCy Schubert<div class="header"> 8465853c10SCy Schubert<p> 8565853c10SCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 862b15cb3dSCy Schubert</div> 8765853c10SCy Schubert<a name="Invoking-summary"></a> 8865853c10SCy Schubert<h2 class="chapter">1 Invoking summary</h2> 8965853c10SCy Schubert<a name="index-summary"></a> 9065853c10SCy Schubert<a name="index-compute-various-stastics-from-NTP-stat-files"></a> 912b15cb3dSCy Schubert 922b15cb3dSCy Schubert 9365853c10SCy 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. 9765853c10SCy Schubert</p> 9865853c10SCy Schubert<table class="menu" border="0" cellspacing="0"> 9965853c10SCy 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>) 10065853c10SCy Schubert</td></tr> 10165853c10SCy 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 10265853c10SCy Schubert</td></tr> 10365853c10SCy 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 10465853c10SCy Schubert</td></tr> 10565853c10SCy 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 10665853c10SCy Schubert</td></tr> 10765853c10SCy 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 10865853c10SCy Schubert</td></tr> 10965853c10SCy 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 11065853c10SCy Schubert</td></tr> 11165853c10SCy Schubert</table> 1122b15cb3dSCy Schubert 11365853c10SCy Schubert<hr> 11465853c10SCy Schubert<a name="summary-usage"></a> 11565853c10SCy Schubert<div class="header"> 11665853c10SCy Schubert<p> 11765853c10SCy 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> 11965853c10SCy Schubert<a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a> 12065853c10SCy Schubert<h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> 12165853c10SCy Schubert<a name="index-summary-help"></a> 1222b15cb3dSCy Schubert 12365853c10SCy Schubert<p>This is the automatically generated usage text for summary. 12465853c10SCy Schubert</p> 1252b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 12665853c10SCy 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 13065853c10SCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1312b15cb3dSCy Schubertwith a status code of 0. 13265853c10SCy Schubert</p> 13365853c10SCy Schubert<div class="example"> 134*298b6337SGordon Tetlow<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p14 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. 14865853c10SCy Schubert</pre></div> 14965853c10SCy Schubert 15065853c10SCy Schubert<table class="menu" border="0" cellspacing="0"> 15165853c10SCy Schubert<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td> </td><td align="left" valign="top"> 15265853c10SCy Schubert</td></tr> 15365853c10SCy 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"> 15465853c10SCy Schubert</td></tr> 15565853c10SCy 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"> 15665853c10SCy Schubert</td></tr> 15765853c10SCy 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"> 15865853c10SCy Schubert</td></tr> 15965853c10SCy 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"> 16065853c10SCy Schubert</td></tr> 16165853c10SCy Schubert</table> 16265853c10SCy Schubert 16365853c10SCy Schubert<hr> 16465853c10SCy Schubert<a name="summary-directory"></a> 16565853c10SCy Schubert<div class="header"> 16665853c10SCy Schubert<p> 16765853c10SCy 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> 16965853c10SCy Schubert<a name="directory-option"></a> 17065853c10SCy Schubert<h4 class="subsection">1.1.1 directory option</h4> 17165853c10SCy Schubert<a name="index-summary_002ddirectory"></a> 1722b15cb3dSCy Schubert 17365853c10SCy 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>. 17765853c10SCy Schubert</p><hr> 17865853c10SCy Schubert<a name="summary-end_002ddate"></a> 17965853c10SCy Schubert<div class="header"> 18065853c10SCy Schubert<p> 18165853c10SCy 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> 18365853c10SCy Schubert<a name="end_002ddate-option"></a> 18465853c10SCy Schubert<h4 class="subsection">1.1.2 end-date option</h4> 18565853c10SCy Schubert<a name="index-summary_002dend_002ddate"></a> 1862b15cb3dSCy Schubert 18765853c10SCy 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. 19265853c10SCy Schubert</p><hr> 19365853c10SCy Schubert<a name="summary-output_002ddirectory"></a> 19465853c10SCy Schubert<div class="header"> 19565853c10SCy Schubert<p> 19665853c10SCy 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> 19865853c10SCy Schubert<a name="output_002ddirectory-option"></a> 19965853c10SCy Schubert<h4 class="subsection">1.1.3 output-directory option</h4> 20065853c10SCy Schubert<a name="index-summary_002doutput_002ddirectory"></a> 2012b15cb3dSCy Schubert 20265853c10SCy 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. 20565853c10SCy Schubert</p><hr> 20665853c10SCy Schubert<a name="summary-start_002ddate"></a> 20765853c10SCy Schubert<div class="header"> 20865853c10SCy Schubert<p> 20965853c10SCy 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> 21165853c10SCy Schubert<a name="start_002ddate-option"></a> 21265853c10SCy Schubert<h4 class="subsection">1.1.4 start-date option</h4> 21365853c10SCy Schubert<a name="index-summary_002dstart_002ddate"></a> 2142b15cb3dSCy Schubert 21565853c10SCy 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. 21965853c10SCy Schubert</p><hr> 22065853c10SCy Schubert<a name="summary-exit-status"></a> 22165853c10SCy Schubert<div class="header"> 22265853c10SCy Schubert<p> 22365853c10SCy 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> 22565853c10SCy Schubert<a name="summary-exit-status-1"></a> 22665853c10SCy 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: 22965853c10SCy Schubert</p><dl compact="compact"> 23065853c10SCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 23165853c10SCy Schubert<dd><p>Successful program execution. 23265853c10SCy Schubert</p></dd> 23365853c10SCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 23465853c10SCy Schubert<dd><p>The operation failed or the command syntax was not valid. 23565853c10SCy Schubert</p></dd> 2362b15cb3dSCy Schubert</dl> 23765853c10SCy Schubert<hr> 2382b15cb3dSCy Schubert 2392b15cb3dSCy Schubert 24065853c10SCy Schubert 24165853c10SCy Schubert</body> 24265853c10SCy Schubert</html> 243