1052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2052d159aSCy Schubert<html> 3a466cc55SCy Schubert<!-- Created by GNU Texinfo 6.6, 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 Schubertdiv.display {margin-left: 3.2em} 20052d159aSCy Schubertdiv.example {margin-left: 3.2em} 21052d159aSCy Schubertdiv.lisp {margin-left: 3.2em} 22052d159aSCy Schubertkbd {font-style: oblique} 232b15cb3dSCy Schubertpre.display {font-family: inherit} 242b15cb3dSCy Schubertpre.format {font-family: inherit} 25052d159aSCy Schubertpre.menu-comment {font-family: serif} 26052d159aSCy Schubertpre.menu-preformatted {font-family: serif} 27052d159aSCy Schubertspan.nolinebreak {white-space: nowrap} 28052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal} 29052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 30052d159aSCy Schubertul.no-bullet {list-style: none} 31052d159aSCy Schubert--> 32052d159aSCy Schubert</style> 33052d159aSCy Schubert 34052d159aSCy Schubert 352b15cb3dSCy Schubert</head> 36052d159aSCy Schubert 37052d159aSCy Schubert<body lang="en"> 38052d159aSCy Schubert<h1 class="settitle" align="center">Summary User’s Manual</h1> 39052d159aSCy Schubert 40052d159aSCy Schubert 41052d159aSCy Schubert 42052d159aSCy Schubert 43052d159aSCy Schubert 44a466cc55SCy Schubert<span id="Top"></span><div class="header"> 45052d159aSCy Schubert<p> 46052d159aSCy 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> 472b15cb3dSCy Schubert</div> 48a466cc55SCy Schubert<span id="Summary-User-Manual"></span><h1 class="top">Summary User Manual</h1> 492b15cb3dSCy Schubert 50052d159aSCy Schubert<p>This document describes the use of the NTP Project’s <code>summary</code> program. 51*f5f40dd6SCy SchubertThis document applies to version 4.2.8p18 of <code>summary</code>. 52052d159aSCy Schubert</p> 53a466cc55SCy Schubert<span id="SEC_Overview"></span> 54052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 552b15cb3dSCy Schubert 562b15cb3dSCy Schubert<div class="shortcontents"> 57052d159aSCy Schubert<ul class="no-bullet"> 58a466cc55SCy Schubert<li><a id="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li> 592b15cb3dSCy Schubert</ul> 602b15cb3dSCy Schubert</div> 612b15cb3dSCy Schubert 622b15cb3dSCy Schubert 63052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 64a466cc55SCy Schubert<tr><td align="left" valign="top">• summary Description</td><td> </td><td align="left" valign="top">Description 65052d159aSCy Schubert</td></tr> 66a466cc55SCy 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 67052d159aSCy Schubert</td></tr> 68052d159aSCy Schubert</table> 69052d159aSCy Schubert 70052d159aSCy Schubert<hr> 71a466cc55SCy Schubert<span id="summary-Invocation"></span><div class="header"> 72052d159aSCy Schubert<p> 73052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 742b15cb3dSCy Schubert</div> 75a466cc55SCy Schubert<span id="Invoking-summary"></span><h2 class="chapter">1 Invoking summary</h2> 76a466cc55SCy Schubert<span id="index-summary"></span> 77a466cc55SCy Schubert<span id="index-compute-various-stastics-from-NTP-stat-files"></span> 782b15cb3dSCy Schubert 792b15cb3dSCy Schubert 80052d159aSCy Schubert 812b15cb3dSCy Schubert 822b15cb3dSCy Schubert<p>This section was generated by <strong>AutoGen</strong>, 832b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 84052d159aSCy Schubert</p> 85052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 86a466cc55SCy 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>) 87052d159aSCy Schubert</td></tr> 88a466cc55SCy 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 89052d159aSCy Schubert</td></tr> 90a466cc55SCy 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 91052d159aSCy Schubert</td></tr> 92a466cc55SCy 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 93052d159aSCy Schubert</td></tr> 94a466cc55SCy 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 95052d159aSCy Schubert</td></tr> 96a466cc55SCy 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 97052d159aSCy Schubert</td></tr> 98052d159aSCy Schubert</table> 992b15cb3dSCy Schubert 100052d159aSCy Schubert<hr> 101a466cc55SCy Schubert<span id="summary-usage"></span><div class="header"> 102052d159aSCy Schubert<p> 103052d159aSCy 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> 1042b15cb3dSCy Schubert</div> 105a466cc55SCy Schubert<span id="summary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> 106a466cc55SCy Schubert<span id="index-summary-help"></span> 1072b15cb3dSCy Schubert 108052d159aSCy Schubert<p>This is the automatically generated usage text for summary. 109052d159aSCy Schubert</p> 1102b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 111052d159aSCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 1122b15cb3dSCy Schubertthe usage text by passing it through a pager program. 1132b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working 1142b15cb3dSCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1162b15cb3dSCy Schubertwith a status code of 0. 117052d159aSCy Schubert</p> 118052d159aSCy Schubert<div class="example"> 119*f5f40dd6SCy Schubert<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p18 1202b15cb3dSCy SchubertUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 1212b15cb3dSCy Schubert 1222b15cb3dSCy Schubert --directory=str Directory containing stat files 1232b15cb3dSCy Schubert --end-date=num End date 1242b15cb3dSCy Schubert --output-directory=str Output directory 1252b15cb3dSCy Schubert --peer-dist-limit=float Peer dist limit 1262b15cb3dSCy Schubert --skip-time-steps=float Ignore time offsets larger that this 1272b15cb3dSCy Schubert --start-date=num Start date 1282b15cb3dSCy Schubert -?, --help Display usage information and exit 1292b15cb3dSCy Schubert --more-help Pass the extended usage text through a pager 1302b15cb3dSCy Schubert 1312b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single 1322b15cb3dSCy Schuberthyphen and the flag character. 133052d159aSCy Schubert</pre></div> 134052d159aSCy Schubert 135052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 136a466cc55SCy Schubert<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> 137052d159aSCy Schubert</td></tr> 138a466cc55SCy Schubert<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"> 139052d159aSCy Schubert</td></tr> 140a466cc55SCy Schubert<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"> 141052d159aSCy Schubert</td></tr> 142a466cc55SCy Schubert<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"> 143052d159aSCy Schubert</td></tr> 144a466cc55SCy 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"> 145052d159aSCy Schubert</td></tr> 146052d159aSCy Schubert</table> 147052d159aSCy Schubert 148052d159aSCy Schubert<hr> 149a466cc55SCy Schubert<span id="summary-directory"></span><div class="header"> 150052d159aSCy Schubert<p> 151052d159aSCy 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> 1522b15cb3dSCy Schubert</div> 153a466cc55SCy Schubert<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 154a466cc55SCy Schubert<span id="index-summary_002ddirectory"></span> 1552b15cb3dSCy Schubert 156052d159aSCy Schubert<p>This is the “directory containing stat files” option. 1572b15cb3dSCy SchubertThis option takes a string argument. 1582b15cb3dSCy Schubert The directory where <code>ntpd</code> will search for .stat files generated 1592b15cb3dSCy Schubert by <code>ntpd</code>. 160052d159aSCy Schubert</p><hr> 161a466cc55SCy Schubert<span id="summary-end_002ddate"></span><div class="header"> 162052d159aSCy Schubert<p> 163052d159aSCy 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> 1642b15cb3dSCy Schubert</div> 165a466cc55SCy Schubert<span id="end_002ddate-option"></span><h4 class="subsection">1.1.2 end-date option</h4> 166a466cc55SCy Schubert<span id="index-summary_002dend_002ddate"></span> 1672b15cb3dSCy Schubert 168052d159aSCy Schubert<p>This is the “end date” option. 1692b15cb3dSCy SchubertThis option takes a number argument. 1702b15cb3dSCy Schubert Process all files with the date suffix less or equal to value of this 1712b15cb3dSCy Schubert option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 1722b15cb3dSCy Schubert to get the timestamp. 173052d159aSCy Schubert</p><hr> 174a466cc55SCy Schubert<span id="summary-output_002ddirectory"></span><div class="header"> 175052d159aSCy Schubert<p> 176052d159aSCy 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> 1772b15cb3dSCy Schubert</div> 178a466cc55SCy Schubert<span id="output_002ddirectory-option"></span><h4 class="subsection">1.1.3 output-directory option</h4> 179a466cc55SCy Schubert<span id="index-summary_002doutput_002ddirectory"></span> 1802b15cb3dSCy Schubert 181052d159aSCy Schubert<p>This is the “output directory” option. 1822b15cb3dSCy SchubertThis option takes a str argument. 1832b15cb3dSCy Schubert The output directory <code>summary</code> will write all output files to. 184052d159aSCy Schubert</p><hr> 185a466cc55SCy Schubert<span id="summary-start_002ddate"></span><div class="header"> 186052d159aSCy Schubert<p> 187052d159aSCy 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> 1882b15cb3dSCy Schubert</div> 189a466cc55SCy Schubert<span id="start_002ddate-option"></span><h4 class="subsection">1.1.4 start-date option</h4> 190a466cc55SCy Schubert<span id="index-summary_002dstart_002ddate"></span> 1912b15cb3dSCy Schubert 192052d159aSCy Schubert<p>This is the “start date” option. 1932b15cb3dSCy SchubertThis option takes a num argument. 1942b15cb3dSCy Schubert Process all files with the date suffix more or equal to value of 1952b15cb3dSCy Schubert this option. Defaults to 197000101. 196052d159aSCy Schubert</p><hr> 197a466cc55SCy Schubert<span id="summary-exit-status"></span><div class="header"> 198052d159aSCy Schubert<p> 199052d159aSCy 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> 2002b15cb3dSCy Schubert</div> 201a466cc55SCy Schubert<span id="summary-exit-status-1"></span><h4 class="subsection">1.1.5 summary exit status</h4> 2022b15cb3dSCy Schubert 2032b15cb3dSCy Schubert<p>One of the following exit values will be returned: 204052d159aSCy Schubert</p><dl compact="compact"> 205052d159aSCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 206052d159aSCy Schubert<dd><p>Successful program execution. 207052d159aSCy Schubert</p></dd> 208052d159aSCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 209052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid. 210052d159aSCy Schubert</p></dd> 2112b15cb3dSCy Schubert</dl> 212052d159aSCy Schubert<hr> 2132b15cb3dSCy Schubert 2142b15cb3dSCy Schubert 215052d159aSCy Schubert 216052d159aSCy Schubert</body> 217052d159aSCy Schubert</html> 218