summary.html revision 309007
1353358Sdim<html lang="en"> 2317019Sdim<head> 3353358Sdim<title>Summary User's Manual</title> 4353358Sdim<meta http-equiv="Content-Type" content="text/html"> 5353358Sdim<meta name="description" content="Summary User's Manual"> 6317019Sdim<meta name="generator" content="makeinfo 4.7"> 7317019Sdim<link title="Top" rel="top" href="#Top"> 8317019Sdim<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9317019Sdim<meta http-equiv="Content-Style-Type" content="text/css"> 10317019Sdim<style type="text/css"><!-- 11317019Sdim pre.display { font-family:inherit } 12317019Sdim pre.format { font-family:inherit } 13317019Sdim pre.smalldisplay { font-family:inherit; font-size:smaller } 14317019Sdim pre.smallformat { font-family:inherit; font-size:smaller } 15317019Sdim pre.smallexample { font-size:smaller } 16317019Sdim pre.smalllisp { font-size:smaller } 17317019Sdim span.sc { font-variant:small-caps } 18317019Sdim span.roman { font-family: serif; font-weight: normal; } 19317019Sdim--></style> 20317019Sdim</head> 21317019Sdim<body> 22317019Sdim<h1 class="settitle">Summary User's Manual</h1> 23317019Sdim<div class="node"> 24317019Sdim<p><hr> 25317019Sdim<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#summary-Description">summary Description</a>, 26317019SdimPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27317019SdimUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28317019Sdim<br> 29317019Sdim</div> 30317019Sdim 31317019Sdim<h2 class="unnumbered">Summary User Manual</h2> 32341825Sdim 33317019Sdim<p>This document describes the use of the NTP Project's <code>summary</code> program. 34317019SdimThis document applies to version 4.2.8p9 of <code>summary</code>. 35317019Sdim 36317019Sdim <div class="shortcontents"> 37317019Sdim<h2>Short Contents</h2> 38317019Sdim<ul> 39317019Sdim<a href="#Top">Summary User Manual</a> 40317019Sdim</ul> 41317019Sdim</div> 42317019Sdim 43317019Sdim<ul class="menu"> 44317019Sdim<li><a accesskey="1" href="#summary-Description">summary Description</a>: Description 45317019Sdim<li><a accesskey="2" href="#summary-Invocation">summary Invocation</a>: Invoking summary 46317019Sdim</ul> 47317019Sdim 48317019Sdim<div class="node"> 49317019Sdim<p><hr> 50317019Sdim<a name="summary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#summary-Description">summary Description</a>, 51317019SdimUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52317019Sdim<br> 53317019Sdim</div> 54317019Sdim 55317019Sdim<h3 class="section">Invoking summary</h3> 56317019Sdim 57317019Sdim<p><a name="index-summary-1"></a><a name="index-compute-various-stastics-from-NTP-stat-files-2"></a> 58317019Sdim 59317019Sdim <p>This section was generated by <strong>AutoGen</strong>, 60317019Sdimusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program. 61317019Sdim 62317019Sdim<ul class="menu"> 63317019Sdim<li><a accesskey="1" href="#summary-usage">summary usage</a>: summary help/usage (<span class="option">--help</span>) 64317019Sdim<li><a accesskey="2" href="#summary-directory">summary directory</a>: directory option 65317019Sdim<li><a accesskey="3" href="#summary-end_002ddate">summary end-date</a>: end-date option 66317019Sdim<li><a accesskey="4" href="#summary-output_002ddirectory">summary output-directory</a>: output-directory option 67317019Sdim<li><a accesskey="5" href="#summary-start_002ddate">summary start-date</a>: start-date option 68317019Sdim<li><a accesskey="6" href="#summary-exit-status">summary exit status</a>: exit status 69317019Sdim</ul> 70317019Sdim 71322855Sdim<div class="node"> 72317019Sdim<p><hr> 73317019Sdim<a name="summary-usage"></a>Next: <a rel="next" accesskey="n" href="#summary-directory">summary directory</a>, 74317019SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 75317019Sdim<br> 76317019Sdim</div> 77317019Sdim 78317019Sdim<h4 class="subsection">summary help/usage (<span class="option">--help</span>)</h4> 79322855Sdim 80317019Sdim<p><a name="index-summary-help-3"></a> 81317019SdimThis is the automatically generated usage text for summary. 82317019Sdim 83317019Sdim <p>The text printed is the same whether selected with the <code>help</code> option 84317019Sdim(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 85317019Sdimthe usage text by passing it through a pager program. 86317019Sdim<code>more-help</code> is disabled on platforms without a working 87317019Sdim<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 88317019Sdimused to select the program, defaulting to <span class="file">more</span>. Both will exit 89322855Sdimwith a status code of 0. 90317019Sdim 91317019Sdim<pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p9 92317019SdimUSAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 93317019Sdim 94317019Sdim --directory=str Directory containing stat files 95317019Sdim --end-date=num End date 96317019Sdim --output-directory=str Output directory 97317019Sdim --peer-dist-limit=float Peer dist limit 98317019Sdim --skip-time-steps=float Ignore time offsets larger that this 99317019Sdim --start-date=num Start date 100317019Sdim -?, --help Display usage information and exit 101317019Sdim --more-help Pass the extended usage text through a pager 102317019Sdim 103317019SdimOptions are specified by doubled hyphens and their name or by a single 104317019Sdimhyphen and the flag character. 105317019Sdim</pre> 106317019Sdim <div class="node"> 107317019Sdim<p><hr> 108317019Sdim<a name="summary-directory"></a>Next: <a rel="next" accesskey="n" href="#summary-end_002ddate">summary end-date</a>, 109317019SdimPrevious: <a rel="previous" accesskey="p" href="#summary-usage">summary usage</a>, 110317019SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 111317019Sdim<br> 112317019Sdim</div> 113317019Sdim 114317019Sdim<h4 class="subsection">directory option</h4> 115317019Sdim 116317019Sdim<p><a name="index-summary_002ddirectory-4"></a> 117317019SdimThis is the “directory containing stat files” option. 118317019SdimThis option takes a string argument. 119317019Sdim The directory where <code>ntpd</code> will search for .stat files generated 120318477Sdim by <code>ntpd</code>. 121318477Sdim<div class="node"> 122318477Sdim<p><hr> 123318477Sdim<a name="summary-end_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-output_002ddirectory">summary output-directory</a>, 124318477SdimPrevious: <a rel="previous" accesskey="p" href="#summary-directory">summary directory</a>, 125318477SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 126318477Sdim<br> 127318477Sdim</div> 128318477Sdim 129322855Sdim<h4 class="subsection">end-date option</h4> 130322855Sdim 131317019Sdim<p><a name="index-summary_002dend_002ddate-5"></a> 132322855SdimThis is the “end date” option. 133317019SdimThis option takes a number argument. 134317019Sdim Process all files with the date suffix less or equal to value of this 135322855Sdim option. Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>) 136322855Sdim to get the timestamp. 137322855Sdim<div class="node"> 138322855Sdim<p><hr> 139322855Sdim<a name="summary-output_002ddirectory"></a>Next: <a rel="next" accesskey="n" href="#summary-start_002ddate">summary start-date</a>, 140322855SdimPrevious: <a rel="previous" accesskey="p" href="#summary-end_002ddate">summary end-date</a>, 141317019SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 142317019Sdim<br> 143317019Sdim</div> 144317019Sdim 145317019Sdim<h4 class="subsection">output-directory option</h4> 146317019Sdim 147317019Sdim<p><a name="index-summary_002doutput_002ddirectory-6"></a> 148317019SdimThis is the “output directory” option. 149317019SdimThis option takes a str argument. 150317019Sdim The output directory <code>summary</code> will write all output files to. 151317019Sdim<div class="node"> 152317019Sdim<p><hr> 153317019Sdim<a name="summary-start_002ddate"></a>Next: <a rel="next" accesskey="n" href="#summary-exit-status">summary exit status</a>, 154317019SdimPrevious: <a rel="previous" accesskey="p" href="#summary-output_002ddirectory">summary output-directory</a>, 155317019SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 156317019Sdim<br> 157317019Sdim</div> 158317019Sdim 159317019Sdim<h4 class="subsection">start-date option</h4> 160317019Sdim 161317019Sdim<p><a name="index-summary_002dstart_002ddate-7"></a> 162317019SdimThis is the “start date” option. 163317019SdimThis option takes a num argument. 164317019Sdim Process all files with the date suffix more or equal to value of 165317019Sdim this option. Defaults to 197000101. 166317019Sdim<div class="node"> 167322855Sdim<p><hr> 168317019Sdim<a name="summary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#summary-start_002ddate">summary start-date</a>, 169317019SdimUp: <a rel="up" accesskey="u" href="#summary-Invocation">summary Invocation</a> 170317019Sdim<br> 171317019Sdim</div> 172317019Sdim 173317019Sdim<h4 class="subsection">summary exit status</h4> 174317019Sdim 175317019Sdim<p>One of the following exit values will be returned: 176317019Sdim <dl> 177317019Sdim<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 178317019Sdim<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 179317019Sdim</dl> 180317019Sdim 181317019Sdim</body></html> 182317019Sdim 183322855Sdim