1067f5680Schristos<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2067f5680Schristos<html> 3*897be3a4Schristos<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 48585484eSchristos<head> 5067f5680Schristos<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6067f5680Schristos<title>Summary User’s Manual</title> 7067f5680Schristos 8067f5680Schristos<meta name="description" content="Summary User’s Manual"> 9067f5680Schristos<meta name="keywords" content="Summary User’s Manual"> 10067f5680Schristos<meta name="resource-type" content="document"> 11067f5680Schristos<meta name="distribution" content="global"> 12067f5680Schristos<meta name="Generator" content="makeinfo"> 13067f5680Schristos<link href="#Top" rel="start" title="Top"> 14067f5680Schristos<link href="dir.html#Top" rel="up" title="(dir)"> 15067f5680Schristos<style type="text/css"> 16067f5680Schristos<!-- 17067f5680Schristosa.summary-letter {text-decoration: none} 18067f5680Schristosblockquote.indentedblock {margin-right: 0em} 19067f5680Schristosdiv.display {margin-left: 3.2em} 20067f5680Schristosdiv.example {margin-left: 3.2em} 21067f5680Schristosdiv.lisp {margin-left: 3.2em} 22067f5680Schristoskbd {font-style: oblique} 238585484eSchristospre.display {font-family: inherit} 248585484eSchristospre.format {font-family: inherit} 25067f5680Schristospre.menu-comment {font-family: serif} 26067f5680Schristospre.menu-preformatted {font-family: serif} 27067f5680Schristosspan.nolinebreak {white-space: nowrap} 28067f5680Schristosspan.roman {font-family: initial; font-weight: normal} 29067f5680Schristosspan.sansserif {font-family: sans-serif; font-weight: normal} 30067f5680Schristosul.no-bullet {list-style: none} 31067f5680Schristos--> 32067f5680Schristos</style> 33067f5680Schristos 34067f5680Schristos 358585484eSchristos</head> 36067f5680Schristos 37067f5680Schristos<body lang="en"> 38067f5680Schristos<h1 class="settitle" align="center">Summary User’s Manual</h1> 39067f5680Schristos 40067f5680Schristos 41067f5680Schristos 42067f5680Schristos 43067f5680Schristos 44*897be3a4Schristos<span id="Top"></span><div class="header"> 45067f5680Schristos<p> 46067f5680SchristosPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 478585484eSchristos</div> 48*897be3a4Schristos<span id="Summary-User-Manual"></span><h1 class="top">Summary User Manual</h1> 498585484eSchristos 50067f5680Schristos<p>This document describes the use of the NTP Project’s <code>summary</code> program. 51*897be3a4SchristosThis document applies to version 4.2.8p18 of <code>summary</code>. 52067f5680Schristos</p> 53*897be3a4Schristos<span id="SEC_Overview"></span> 54067f5680Schristos<h2 class="shortcontents-heading">Short Table of Contents</h2> 558585484eSchristos 568585484eSchristos<div class="shortcontents"> 57067f5680Schristos<ul class="no-bullet"> 58*897be3a4Schristos<li><a id="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li> 598585484eSchristos</ul> 608585484eSchristos</div> 618585484eSchristos 628585484eSchristos 63067f5680Schristos<table class="menu" border="0" cellspacing="0"> 64*897be3a4Schristos<tr><td align="left" valign="top">• summary Description</td><td> </td><td align="left" valign="top">Description 65067f5680Schristos</td></tr> 66*897be3a4Schristos<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 67067f5680Schristos</td></tr> 68067f5680Schristos</table> 69067f5680Schristos 70067f5680Schristos<hr> 71*897be3a4Schristos<span id="summary-Invocation"></span><div class="header"> 72067f5680Schristos<p> 73067f5680SchristosUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 748585484eSchristos</div> 75*897be3a4Schristos<span id="Invoking-summary"></span><h2 class="chapter">1 Invoking summary</h2> 76*897be3a4Schristos<span id="index-summary"></span> 77*897be3a4Schristos<span id="index-compute-various-stastics-from-NTP-stat-files"></span> 788585484eSchristos 798585484eSchristos 80067f5680Schristos 818585484eSchristos 828585484eSchristos<p>This section was generated by <strong>AutoGen</strong>, 838585484eSchristosusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 84067f5680Schristos</p> 85067f5680Schristos<table class="menu" border="0" cellspacing="0"> 86*897be3a4Schristos<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>) 87067f5680Schristos</td></tr> 88*897be3a4Schristos<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 89067f5680Schristos</td></tr> 90*897be3a4Schristos<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 91067f5680Schristos</td></tr> 92*897be3a4Schristos<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 93067f5680Schristos</td></tr> 94*897be3a4Schristos<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 95067f5680Schristos</td></tr> 96*897be3a4Schristos<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 97067f5680Schristos</td></tr> 98067f5680Schristos</table> 998585484eSchristos 100067f5680Schristos<hr> 101*897be3a4Schristos<span id="summary-usage"></span><div class="header"> 102067f5680Schristos<p> 103067f5680SchristosNext: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> </p> 1048585484eSchristos</div> 105*897be3a4Schristos<span id="summary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3> 106*897be3a4Schristos<span id="index-summary-help"></span> 1078585484eSchristos 108067f5680Schristos<p>This is the automatically generated usage text for summary. 109067f5680Schristos</p> 1108585484eSchristos<p>The text printed is the same whether selected with the <code>help</code> option 111067f5680Schristos(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 1128585484eSchristosthe usage text by passing it through a pager program. 1138585484eSchristos<code>more-help</code> is disabled on platforms without a working 1148585484eSchristos<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115067f5680Schristosused to select the program, defaulting to <samp>more</samp>. Both will exit 1168585484eSchristoswith a status code of 0. 117067f5680Schristos</p> 118067f5680Schristos<div class="example"> 119*897be3a4Schristos<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p18 1208585484eSchristosUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 1218585484eSchristos 122b8ecfcfeSchristos --directory=str Directory containing stat files 123b8ecfcfeSchristos --end-date=num End date 124b8ecfcfeSchristos --output-directory=str Output directory 125b8ecfcfeSchristos --peer-dist-limit=float Peer dist limit 126b8ecfcfeSchristos --skip-time-steps=float Ignore time offsets larger that this 127b8ecfcfeSchristos --start-date=num Start date 1288585484eSchristos -?, --help Display usage information and exit 129b8ecfcfeSchristos --more-help Pass the extended usage text through a pager 1308585484eSchristos 1318585484eSchristosOptions are specified by doubled hyphens and their name or by a single 1328585484eSchristoshyphen and the flag character. 133067f5680Schristos</pre></div> 134067f5680Schristos 135067f5680Schristos<table class="menu" border="0" cellspacing="0"> 136*897be3a4Schristos<tr><td align="left" valign="top">• <a href="#summary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> 137067f5680Schristos</td></tr> 138*897be3a4Schristos<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"> 139067f5680Schristos</td></tr> 140*897be3a4Schristos<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"> 141067f5680Schristos</td></tr> 142*897be3a4Schristos<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"> 143067f5680Schristos</td></tr> 144*897be3a4Schristos<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"> 145067f5680Schristos</td></tr> 146067f5680Schristos</table> 147067f5680Schristos 148067f5680Schristos<hr> 149*897be3a4Schristos<span id="summary-directory"></span><div class="header"> 150067f5680Schristos<p> 151067f5680SchristosNext: <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> 1528585484eSchristos</div> 153*897be3a4Schristos<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 154*897be3a4Schristos<span id="index-summary_002ddirectory"></span> 1558585484eSchristos 156067f5680Schristos<p>This is the “directory containing stat files” option. 1578585484eSchristosThis option takes a string argument. 1588585484eSchristos The directory where <code>ntpd</code> will search for .stat files generated 1598585484eSchristos by <code>ntpd</code>. 160067f5680Schristos</p><hr> 161*897be3a4Schristos<span id="summary-end_002ddate"></span><div class="header"> 162067f5680Schristos<p> 163067f5680SchristosNext: <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> 1648585484eSchristos</div> 165*897be3a4Schristos<span id="end_002ddate-option"></span><h4 class="subsection">1.1.2 end-date option</h4> 166*897be3a4Schristos<span id="index-summary_002dend_002ddate"></span> 1678585484eSchristos 168067f5680Schristos<p>This is the “end date” option. 1698585484eSchristosThis option takes a number argument. 1708585484eSchristos Process all files with the date suffix less or equal to value of this 1718585484eSchristos option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 1728585484eSchristos to get the timestamp. 173067f5680Schristos</p><hr> 174*897be3a4Schristos<span id="summary-output_002ddirectory"></span><div class="header"> 175067f5680Schristos<p> 176067f5680SchristosNext: <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> 1778585484eSchristos</div> 178*897be3a4Schristos<span id="output_002ddirectory-option"></span><h4 class="subsection">1.1.3 output-directory option</h4> 179*897be3a4Schristos<span id="index-summary_002doutput_002ddirectory"></span> 1808585484eSchristos 181067f5680Schristos<p>This is the “output directory” option. 1828585484eSchristosThis option takes a str argument. 1838585484eSchristos The output directory <code>summary</code> will write all output files to. 184067f5680Schristos</p><hr> 185*897be3a4Schristos<span id="summary-start_002ddate"></span><div class="header"> 186067f5680Schristos<p> 187067f5680SchristosNext: <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> 1888585484eSchristos</div> 189*897be3a4Schristos<span id="start_002ddate-option"></span><h4 class="subsection">1.1.4 start-date option</h4> 190*897be3a4Schristos<span id="index-summary_002dstart_002ddate"></span> 1918585484eSchristos 192067f5680Schristos<p>This is the “start date” option. 1938585484eSchristosThis option takes a num argument. 1948585484eSchristos Process all files with the date suffix more or equal to value of 1958585484eSchristos this option. Defaults to 197000101. 196067f5680Schristos</p><hr> 197*897be3a4Schristos<span id="summary-exit-status"></span><div class="header"> 198067f5680Schristos<p> 199067f5680SchristosPrevious: <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> 2008585484eSchristos</div> 201*897be3a4Schristos<span id="summary-exit-status-1"></span><h4 class="subsection">1.1.5 summary exit status</h4> 2028585484eSchristos 2038585484eSchristos<p>One of the following exit values will be returned: 204067f5680Schristos</p><dl compact="compact"> 205067f5680Schristos<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 206067f5680Schristos<dd><p>Successful program execution. 207067f5680Schristos</p></dd> 208067f5680Schristos<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 209067f5680Schristos<dd><p>The operation failed or the command syntax was not valid. 210067f5680Schristos</p></dd> 2118585484eSchristos</dl> 212067f5680Schristos<hr> 2138585484eSchristos 2148585484eSchristos 215067f5680Schristos 216067f5680Schristos</body> 217067f5680Schristos</html> 218