1*2b15cb3dSCy Schubert<html lang="en"> 2*2b15cb3dSCy Schubert<head> 3*2b15cb3dSCy Schubert<title>Summary User's Manual</title> 4*2b15cb3dSCy Schubert<meta http-equiv="Content-Type" content="text/html"> 5*2b15cb3dSCy Schubert<meta name="description" content="Summary User's Manual"> 6*2b15cb3dSCy Schubert<meta name="generator" content="makeinfo 4.7"> 7*2b15cb3dSCy Schubert<link title="Top" rel="top" href="#Top"> 8*2b15cb3dSCy Schubert<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9*2b15cb3dSCy Schubert<meta http-equiv="Content-Style-Type" content="text/css"> 10*2b15cb3dSCy Schubert<style type="text/css"><!-- 11*2b15cb3dSCy Schubert pre.display { font-family:inherit } 12*2b15cb3dSCy Schubert pre.format { font-family:inherit } 13*2b15cb3dSCy Schubert pre.smalldisplay { font-family:inherit; font-size:smaller } 14*2b15cb3dSCy Schubert pre.smallformat { font-family:inherit; font-size:smaller } 15*2b15cb3dSCy Schubert pre.smallexample { font-size:smaller } 16*2b15cb3dSCy Schubert pre.smalllisp { font-size:smaller } 17*2b15cb3dSCy Schubert span.sc { font-variant:small-caps } 18*2b15cb3dSCy Schubert span.roman { font-family: serif; font-weight: normal; } 19*2b15cb3dSCy Schubert--></style> 20*2b15cb3dSCy Schubert</head> 21*2b15cb3dSCy Schubert<body> 22*2b15cb3dSCy Schubert<h1 class="settitle">Summary User's Manual</h1> 23*2b15cb3dSCy Schubert<div class="node"> 24*2b15cb3dSCy Schubert<p><hr> 25*2b15cb3dSCy Schubert<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>, 26*2b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28*2b15cb3dSCy Schubert<br> 29*2b15cb3dSCy Schubert</div> 30*2b15cb3dSCy Schubert 31*2b15cb3dSCy Schubert<h2 class="unnumbered">Summary User Manual</h2> 32*2b15cb3dSCy Schubert 33*2b15cb3dSCy Schubert<p>This document describes the use of the NTP Project's <code>summary</code> program. 34*2b15cb3dSCy SchubertThis document applies to version 4.2.8p1 of <code>summary</code>. 35*2b15cb3dSCy Schubert 36*2b15cb3dSCy Schubert <div class="shortcontents"> 37*2b15cb3dSCy Schubert<h2>Short Contents</h2> 38*2b15cb3dSCy Schubert<ul> 39*2b15cb3dSCy Schubert<a href="#Top">Summary User Manual</a> 40*2b15cb3dSCy Schubert</ul> 41*2b15cb3dSCy Schubert</div> 42*2b15cb3dSCy Schubert 43*2b15cb3dSCy Schubert<ul class="menu"> 44*2b15cb3dSCy Schubert<li><a accesskey="1" href="#summary-Description">summary Description</a>: Description 45*2b15cb3dSCy Schubert<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: Invoking summary 46*2b15cb3dSCy Schubert</ul> 47*2b15cb3dSCy Schubert 48*2b15cb3dSCy Schubert<div class="node"> 49*2b15cb3dSCy Schubert<p><hr> 50*2b15cb3dSCy Schubert<a name="summary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>, 51*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52*2b15cb3dSCy Schubert<br> 53*2b15cb3dSCy Schubert</div> 54*2b15cb3dSCy Schubert 55*2b15cb3dSCy Schubert<h3 class="section">Invoking summary</h3> 56*2b15cb3dSCy Schubert 57*2b15cb3dSCy Schubert<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a> 58*2b15cb3dSCy Schubert 59*2b15cb3dSCy Schubert <p>This section was generated by <strong>AutoGen</strong>, 60*2b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 61*2b15cb3dSCy Schubert 62*2b15cb3dSCy Schubert<ul class="menu"> 63*2b15cb3dSCy Schubert<li><a accesskey="1" href="#summary-usage">summary usage</a>: summary help/usage (<span class="option">--help</span>) 64*2b15cb3dSCy Schubert<li><a accesskey="2" href="#summary-directory">summary directory</a>: directory option 65*2b15cb3dSCy Schubert<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>: end-date option 66*2b15cb3dSCy Schubert<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>: output-directory option 67*2b15cb3dSCy Schubert<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>: start-date option 68*2b15cb3dSCy Schubert<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>: exit status 69*2b15cb3dSCy Schubert</ul> 70*2b15cb3dSCy Schubert 71*2b15cb3dSCy Schubert<div class="node"> 72*2b15cb3dSCy Schubert<p><hr> 73*2b15cb3dSCy Schubert<a name="summary-usage"></a>Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>, 74*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 75*2b15cb3dSCy Schubert<br> 76*2b15cb3dSCy Schubert</div> 77*2b15cb3dSCy Schubert 78*2b15cb3dSCy Schubert<h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4> 79*2b15cb3dSCy Schubert 80*2b15cb3dSCy Schubert<p><a name="index-summary-help-3"></a> 81*2b15cb3dSCy SchubertThis is the automatically generated usage text for summary. 82*2b15cb3dSCy Schubert 83*2b15cb3dSCy Schubert <p>The text printed is the same whether selected with the <code>help</code> option 84*2b15cb3dSCy Schubert(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 85*2b15cb3dSCy Schubertthe usage text by passing it through a pager program. 86*2b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working 87*2b15cb3dSCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 88*2b15cb3dSCy Schubertused to select the program, defaulting to <span class="file">more</span>. Both will exit 89*2b15cb3dSCy Schubertwith a status code of 0. 90*2b15cb3dSCy Schubert 91*2b15cb3dSCy Schubert<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p1 92*2b15cb3dSCy SchubertUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 93*2b15cb3dSCy Schubert 94*2b15cb3dSCy Schubert --directory=str Directory containing stat files 95*2b15cb3dSCy Schubert --end-date=num End date 96*2b15cb3dSCy Schubert --output-directory=str Output directory 97*2b15cb3dSCy Schubert --peer-dist-limit=float Peer dist limit 98*2b15cb3dSCy Schubert --skip-time-steps=float Ignore time offsets larger that this 99*2b15cb3dSCy Schubert --start-date=num Start date 100*2b15cb3dSCy Schubert -?, --help Display usage information and exit 101*2b15cb3dSCy Schubert --more-help Pass the extended usage text through a pager 102*2b15cb3dSCy Schubert 103*2b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single 104*2b15cb3dSCy Schuberthyphen and the flag character. 105*2b15cb3dSCy Schubert</pre> 106*2b15cb3dSCy Schubert <div class="node"> 107*2b15cb3dSCy Schubert<p><hr> 108*2b15cb3dSCy Schubert<a name="summary-directory"></a>Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>, 109*2b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>, 110*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 111*2b15cb3dSCy Schubert<br> 112*2b15cb3dSCy Schubert</div> 113*2b15cb3dSCy Schubert 114*2b15cb3dSCy Schubert<h4 class="subsection">directory option</h4> 115*2b15cb3dSCy Schubert 116*2b15cb3dSCy Schubert<p><a name="index-summary_002ddirectory-4"></a> 117*2b15cb3dSCy SchubertThis is the “directory containing stat files” option. 118*2b15cb3dSCy SchubertThis option takes a string argument. 119*2b15cb3dSCy Schubert The directory where <code>ntpd</code> will search for .stat files generated 120*2b15cb3dSCy Schubert by <code>ntpd</code>. 121*2b15cb3dSCy Schubert<div class="node"> 122*2b15cb3dSCy Schubert<p><hr> 123*2b15cb3dSCy Schubert<a name="summary-end_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>, 124*2b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>, 125*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 126*2b15cb3dSCy Schubert<br> 127*2b15cb3dSCy Schubert</div> 128*2b15cb3dSCy Schubert 129*2b15cb3dSCy Schubert<h4 class="subsection">end-date option</h4> 130*2b15cb3dSCy Schubert 131*2b15cb3dSCy Schubert<p><a name="index-summary_002dend_002ddate-5"></a> 132*2b15cb3dSCy SchubertThis is the “end date” option. 133*2b15cb3dSCy SchubertThis option takes a number argument. 134*2b15cb3dSCy Schubert Process all files with the date suffix less or equal to value of this 135*2b15cb3dSCy Schubert option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 136*2b15cb3dSCy Schubert to get the timestamp. 137*2b15cb3dSCy Schubert<div class="node"> 138*2b15cb3dSCy Schubert<p><hr> 139*2b15cb3dSCy Schubert<a name="summary-output_002ddirectory"></a>Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>, 140*2b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>, 141*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 142*2b15cb3dSCy Schubert<br> 143*2b15cb3dSCy Schubert</div> 144*2b15cb3dSCy Schubert 145*2b15cb3dSCy Schubert<h4 class="subsection">output-directory option</h4> 146*2b15cb3dSCy Schubert 147*2b15cb3dSCy Schubert<p><a name="index-summary_002doutput_002ddirectory-6"></a> 148*2b15cb3dSCy SchubertThis is the “output directory” option. 149*2b15cb3dSCy SchubertThis option takes a str argument. 150*2b15cb3dSCy Schubert The output directory <code>summary</code> will write all output files to. 151*2b15cb3dSCy Schubert<div class="node"> 152*2b15cb3dSCy Schubert<p><hr> 153*2b15cb3dSCy Schubert<a name="summary-start_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>, 154*2b15cb3dSCy SchubertPrevious: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>, 155*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 156*2b15cb3dSCy Schubert<br> 157*2b15cb3dSCy Schubert</div> 158*2b15cb3dSCy Schubert 159*2b15cb3dSCy Schubert<h4 class="subsection">start-date option</h4> 160*2b15cb3dSCy Schubert 161*2b15cb3dSCy Schubert<p><a name="index-summary_002dstart_002ddate-7"></a> 162*2b15cb3dSCy SchubertThis is the “start date” option. 163*2b15cb3dSCy SchubertThis option takes a num argument. 164*2b15cb3dSCy Schubert Process all files with the date suffix more or equal to value of 165*2b15cb3dSCy Schubert this option. Defaults to 197000101. 166*2b15cb3dSCy Schubert<div class="node"> 167*2b15cb3dSCy Schubert<p><hr> 168*2b15cb3dSCy Schubert<a name="summary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>, 169*2b15cb3dSCy SchubertUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 170*2b15cb3dSCy Schubert<br> 171*2b15cb3dSCy Schubert</div> 172*2b15cb3dSCy Schubert 173*2b15cb3dSCy Schubert<h4 class="subsection">summary exit status</h4> 174*2b15cb3dSCy Schubert 175*2b15cb3dSCy Schubert<p>One of the following exit values will be returned: 176*2b15cb3dSCy Schubert <dl> 177*2b15cb3dSCy Schubert<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 178*2b15cb3dSCy Schubert<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 179*2b15cb3dSCy Schubert</dl> 180*2b15cb3dSCy Schubert 181*2b15cb3dSCy Schubert</body></html> 182*2b15cb3dSCy Schubert 183