summary.html revision 301256
139214Sgibbs<html lang="en"> 2172093Sken<head> 339214Sgibbs<title>Summary User's Manual</title> 439214Sgibbs<meta http-equiv="Content-Type" content="text/html"> 539214Sgibbs<meta name="description" content="Summary User's Manual"> 639214Sgibbs<meta name="generator" content="makeinfo 4.7"> 739214Sgibbs<link title="Top" rel="top" href="#Top"> 839214Sgibbs<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 939214Sgibbs<meta http-equiv="Content-Style-Type" content="text/css"> 1039214Sgibbs<style type="text/css"><!-- 1139214Sgibbs pre.display { font-family:inherit } 1239214Sgibbs pre.format { font-family:inherit } 1339214Sgibbs pre.smalldisplay { font-family:inherit; font-size:smaller } 1439214Sgibbs pre.smallformat { font-family:inherit; font-size:smaller } 1539214Sgibbs pre.smallexample { font-size:smaller } 1639214Sgibbs pre.smalllisp { font-size:smaller } 1739214Sgibbs span.sc { font-variant:small-caps } 1839214Sgibbs span.roman { font-family: serif; font-weight: normal; } 1939214Sgibbs--></style> 2039214Sgibbs</head> 2139214Sgibbs<body> 2239214Sgibbs<h1 class="settitle">Summary User's Manual</h1> 2339214Sgibbs<div class="node"> 2439214Sgibbs<p><hr> 2539214Sgibbs<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>, 2639214SgibbsPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 2739214SgibbsUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 2850476Speter<br> 2939214Sgibbs</div> 30314221Sken 3139214Sgibbs<h2 class="unnumbered">Summary User Manual</h2> 3261229Sken 3339214Sgibbs<p>This document describes the use of the NTP Project's <code>summary</code> program. 3439214SgibbsThis document applies to version 4.2.8p8 of <code>summary</code>. 3539214Sgibbs 3639214Sgibbs <div class="shortcontents"> 3768960Sru<h2>Short Contents</h2> 3861229Sken<ul> 3946938Sken<a href="#Top">Summary User Manual</a> 4039214Sgibbs</ul> 4139214Sgibbs</div> 4268960Sru 4361229Sken<ul class="menu"> 44260177Sscottl<li><a accesskey="1" href="#summary-Description">summary Description</a>: Description 4539214Sgibbs<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: Invoking summary 4668960Sru</ul> 4761229Sken 4846938Sken<div class="node"> 4939214Sgibbs<p><hr> 5039214Sgibbs<a name="summary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>, 5168960SruUp: <a rel="up" accesskey="u" href="#Top">Top</a> 5261229Sken<br> 5346938Sken</div> 5439214Sgibbs 5568960Sru<h3 class="section">Invoking summary</h3> 5679754Sdd 5746938Sken<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a> 5839214Sgibbs 5939214Sgibbs <p>This section was generated by <strong>AutoGen</strong>, 6039214Sgibbsusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 6139214Sgibbs 6268960Sru<ul class="menu"> 63195534Sscottl<li><a accesskey="1" href="#summary-usage">summary usage</a>: summary help/usage (<span class="option">--help</span>) 64195534Sscottl<li><a accesskey="2" href="#summary-directory">summary directory</a>: directory option 65195534Sscottl<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>: end-date option 66202694Smav<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>: output-directory option 67195534Sscottl<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>: start-date option 68161506Sken<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>: exit status 69161506Sken</ul> 70161506Sken 71161506Sken<div class="node"> 72161506Sken<p><hr> 73161506Sken<a name="summary-usage"></a>Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>, 74161506SkenUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 75172093Sken<br> 76172093Sken</div> 77172093Sken 78172093Sken<h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4> 79172093Sken 80172093Sken<p><a name="index-summary-help-3"></a> 81172093SkenThis is the automatically generated usage text for summary. 82172093Sken 83172093Sken <p>The text printed is the same whether selected with the <code>help</code> option 84172093Sken(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 8561229Skenthe usage text by passing it through a pager program. 8646938Sken<code>more-help</code> is disabled on platforms without a working 8739214Sgibbs<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 8868960Sruused to select the program, defaulting to <span class="file">more</span>. Both will exit 8961229Skenwith a status code of 0. 9046938Sken 9139214Sgibbs<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p8 9268960SruUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 93103033Smdodd 94103033Smdodd --directory=str Directory containing stat files 95103033Smdodd --end-date=num End date 96103033Smdodd --output-directory=str Output directory 9761229Sken --peer-dist-limit=float Peer dist limit 9846938Sken --skip-time-steps=float Ignore time offsets larger that this 9939214Sgibbs --start-date=num Start date 10068960Sru -?, --help Display usage information and exit 101302376Struckman --more-help Pass the extended usage text through a pager 102302376Struckman 103302376StruckmanOptions are specified by doubled hyphens and their name or by a single 10461229Skenhyphen and the flag character. 105317947Sken</pre> 10668960Sru <div class="node"> 10761229Sken<p><hr> 108317947Sken<a name="summary-directory"></a>Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>, 10968960SruPrevious: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>, 11061229SkenUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 11146938Sken<br> 11239214Sgibbs</div> 11339214Sgibbs 11439214Sgibbs<h4 class="subsection">directory option</h4> 11539214Sgibbs 116278170Sken<p><a name="index-summary_002ddirectory-4"></a> 117278170SkenThis is the “directory containing stat files” option. 118278170SkenThis option takes a string argument. 119278170Sken The directory where <code>ntpd</code> will search for .stat files generated 12068960Sru by <code>ntpd</code>. 12161229Sken<div class="node"> 12246938Sken<p><hr> 12339214Sgibbs<a name="summary-end_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>, 124312567SmavPrevious: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>, 12541466SbillfUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 12664382Skbyanc<br> 12739214Sgibbs</div> 12868960Sru 12961229Sken<h4 class="subsection">end-date option</h4> 13046938Sken 13139214Sgibbs<p><a name="index-summary_002dend_002ddate-5"></a> 132196831SmavThis is the “end date” option. 13339214SgibbsThis option takes a number argument. 134207498Smav Process all files with the date suffix less or equal to value of this 135207498Smav option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 13639214Sgibbs to get the timestamp. 13739214Sgibbs<div class="node"> 13839214Sgibbs<p><hr> 139196831Smav<a name="summary-output_002ddirectory"></a>Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>, 14039214SgibbsPrevious: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>, 14168960SruUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 142216088Sken<br> 143216088Sken</div> 144216088Sken 145216088Sken<h4 class="subsection">output-directory option</h4> 146216088Sken 147216088Sken<p><a name="index-summary_002doutput_002ddirectory-6"></a> 148216088SkenThis is the “output directory” option. 149216088SkenThis option takes a str argument. 150216088Sken The output directory <code>summary</code> will write all output files to. 151216088Sken<div class="node"> 152216088Sken<p><hr> 153216088Sken<a name="summary-start_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>, 154216088SkenPrevious: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>, 155216088SkenUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 156216088Sken<br> 157216088Sken</div> 158216088Sken 159216088Sken<h4 class="subsection">start-date option</h4> 160216088Sken 161216088Sken<p><a name="index-summary_002dstart_002ddate-7"></a> 162216088SkenThis is the “start date” option. 163216088SkenThis option takes a num argument. 164216088Sken Process all files with the date suffix more or equal to value of 165216088Sken this option. Defaults to 197000101. 166216088Sken<div class="node"> 167216088Sken<p><hr> 168216088Sken<a name="summary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>, 169216088SkenUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 170216088Sken<br> 171216088Sken</div> 172216088Sken 173216088Sken<h4 class="subsection">summary exit status</h4> 174216088Sken 175216088Sken<p>One of the following exit values will be returned: 176216088Sken <dl> 177216088Sken<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 178216088Sken<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 17961229Sken</dl> 18039214Sgibbs 181107966Snjl</body></html> 18239214Sgibbs 18339214Sgibbs