contrib/ntp/scripts/summary.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>Summary User&rsquo;s Manual</title>
   7
   8 <meta name="description" content="Summary User&rsquo;s Manual">
   9 <meta name="keywords" content="Summary User&rsquo;s Manual">
  10 <meta name="resource-type" content="document">
  11 <meta name="distribution" content="global">
  12 <meta name="Generator" content="makeinfo">
  13 <link href="#Top" rel="start" title="Top">
  14 <link href="dir.html#Top" rel="up" title="(dir)">
  15 <style type="text/css">
  16 <!--
  17 a.summary-letter {text-decoration: none}
  18 blockquote.indentedblock {margin-right: 0em}
  19 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  20 blockquote.smallquotation {font-size: smaller}
  21 div.display {margin-left: 3.2em}
  22 div.example {margin-left: 3.2em}
  23 div.lisp {margin-left: 3.2em}
  24 div.smalldisplay {margin-left: 3.2em}
  25 div.smallexample {margin-left: 3.2em}
  26 div.smalllisp {margin-left: 3.2em}
  27 kbd {font-style: oblique}
  28 pre.display {font-family: inherit}
  29 pre.format {font-family: inherit}
  30 pre.menu-comment {font-family: serif}
  31 pre.menu-preformatted {font-family: serif}
  32 pre.smalldisplay {font-family: inherit; font-size: smaller}
  33 pre.smallexample {font-size: smaller}
  34 pre.smallformat {font-family: inherit; font-size: smaller}
  35 pre.smalllisp {font-size: smaller}
  36 span.nolinebreak {white-space: nowrap}
  37 span.roman {font-family: initial; font-weight: normal}
  38 span.sansserif {font-family: sans-serif; font-weight: normal}
  39 ul.no-bullet {list-style: none}
  40 -->
  41 </style>
  42
  43
  44 </head>
  45
  46 <body lang="en">
  47 <h1 class="settitle" align="center">Summary User&rsquo;s Manual</h1>
  48
  49
  50
  51
  52
  53 <a name="Top"></a>
  54 <div class="header">
  55 <p>
  56 Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> &nbsp; </p>
  57 </div>
  58 <a name="Summary-User-Manual"></a>
  59 <h1 class="top">Summary User Manual</h1>
  60
  61 <p>This document describes the use of the NTP Project&rsquo;s <code>summary</code> program.
  62 This document applies to version 4.2.8p14 of <code>summary</code>.
  63 </p>
  64 <a name="SEC_Overview"></a>
  65 <h2 class="shortcontents-heading">Short Table of Contents</h2>
  66
  67 <div class="shortcontents">
  68 <ul class="no-bullet">
  69 <li><a name="stoc-Invoking-summary" href="#toc-Invoking-summary">1 Invoking summary</a></li>
  70 </ul>
  71 </div>
  72
  73
  74 <table class="menu" border="0" cellspacing="0">
  75 <tr><td align="left" valign="top">&bull; summary Description:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description
  76 </td></tr>
  77 <tr><td align="left" valign="top">&bull; <a href="#summary-Invocation" accesskey="2">summary Invocation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Invoking summary
  78 </td></tr>
  79 </table>
  80
  81 <hr>
  82 <a name="summary-Invocation"></a>
  83 <div class="header">
  84 <p>
  85 Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; </p>
  86 </div>
  87 <a name="Invoking-summary"></a>
  88 <h2 class="chapter">1 Invoking summary</h2>
  89 <a name="index-summary"></a>
  90 <a name="index-compute-various-stastics-from-NTP-stat-files"></a>
  91
  92
  93
  94
  95 <p>This section was generated by <strong>AutoGen</strong>,
  96 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>summary</code> program.
  97 </p>
  98 <table class="menu" border="0" cellspacing="0">
  99 <tr><td align="left" valign="top">&bull; <a href="#summary-usage" accesskey="1">summary usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">summary help/usage (<samp>--help</samp>)
 100 </td></tr>
 101 <tr><td align="left" valign="top">&bull; <a href="#summary-directory" accesskey="2">summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">directory option
 102 </td></tr>
 103 <tr><td align="left" valign="top">&bull; <a href="#summary-end_002ddate" accesskey="3">summary end-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">end-date option
 104 </td></tr>
 105 <tr><td align="left" valign="top">&bull; <a href="#summary-output_002ddirectory" accesskey="4">summary output-directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">output-directory option
 106 </td></tr>
 107 <tr><td align="left" valign="top">&bull; <a href="#summary-start_002ddate" accesskey="5">summary start-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">start-date option
 108 </td></tr>
 109 <tr><td align="left" valign="top">&bull; <a href="#summary-exit-status" accesskey="6">summary exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">exit status
 110 </td></tr>
 111 </table>
 112
 113 <hr>
 114 <a name="summary-usage"></a>
 115 <div class="header">
 116 <p>
 117 Next: <a href="#summary-directory" accesskey="n" rel="next">summary directory</a>, Up: <a href="#summary-Invocation" accesskey="u" rel="up">summary Invocation</a> &nbsp; </p>
 118 </div>
 119 <a name="summary-help_002fusage-_0028_002d_002dhelp_0029"></a>
 120 <h3 class="section">1.1 summary help/usage (<samp>--help</samp>)</h3>
 121 <a name="index-summary-help"></a>
 122
 123 <p>This is the automatically generated usage text for summary.
 124 </p>
 125 <p>The text printed is the same whether selected with the <code>help</code> option
 126 (<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>).  <code>more-help</code> will print
 127 the usage text by passing it through a pager program.
 128 <code>more-help</code> is disabled on platforms without a working
 129 <code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
 130 used to select the program, defaulting to <samp>more</samp>.  Both will exit
 131 with a status code of 0.
 132 </p>
 133 <div class="example">
 134 <pre class="example">summary - compute various stastics from NTP stat files - Ver. 4.2.8p14
 135 USAGE: summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
 136
 137         --directory=str          Directory containing stat files
 138         --end-date=num           End date
 139         --output-directory=str   Output directory
 140         --peer-dist-limit=float  Peer dist limit
 141         --skip-time-steps=float  Ignore time offsets larger that this
 142         --start-date=num         Start date
 143     -?, --help                   Display usage information and exit
 144         --more-help              Pass the extended usage text through a pager
 145
 146 Options are specified by doubled hyphens and their name or by a single
 147 hyphen and the flag character.
 148 </pre></div>
 149
 150 <table class="menu" border="0" cellspacing="0">
 151 <tr><td align="left" valign="top">&bull; <a href="#summary-directory" accesskey="1">summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 152 </td></tr>
 153 <tr><td align="left" valign="top">&bull; <a href="#summary-end_002ddate" accesskey="2">summary end-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 154 </td></tr>
 155 <tr><td align="left" valign="top">&bull; <a href="#summary-output_002ddirectory" accesskey="3">summary output-directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 156 </td></tr>
 157 <tr><td align="left" valign="top">&bull; <a href="#summary-start_002ddate" accesskey="4">summary start-date</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 158 </td></tr>
 159 <tr><td align="left" valign="top">&bull; <a href="#summary-exit-status" accesskey="5">summary exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 160 </td></tr>
 161 </table>
 162
 163 <hr>
 164 <a name="summary-directory"></a>
 165 <div class="header">
 166 <p>
 167 Next: <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> &nbsp; </p>
 168 </div>
 169 <a name="directory-option"></a>
 170 <h4 class="subsection">1.1.1 directory option</h4>
 171 <a name="index-summary_002ddirectory"></a>
 172
 173 <p>This is the &ldquo;directory containing stat files&rdquo; option.
 174 This option takes a string argument.
 175         The directory where <code>ntpd</code> will search for .stat files generated
 176         by <code>ntpd</code>.
 177 </p><hr>
 178 <a name="summary-end_002ddate"></a>
 179 <div class="header">
 180 <p>
 181 Next: <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> &nbsp; </p>
 182 </div>
 183 <a name="end_002ddate-option"></a>
 184 <h4 class="subsection">1.1.2 end-date option</h4>
 185 <a name="index-summary_002dend_002ddate"></a>
 186
 187 <p>This is the &ldquo;end date&rdquo; option.
 188 This option takes a number argument.
 189         Process all files with the date suffix less or equal to value of this
 190         option.  Defaults to today minus one day (Use <code>date -u +%Y%m%d</code>)
 191         to get the timestamp.
 192 </p><hr>
 193 <a name="summary-output_002ddirectory"></a>
 194 <div class="header">
 195 <p>
 196 Next: <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> &nbsp; </p>
 197 </div>
 198 <a name="output_002ddirectory-option"></a>
 199 <h4 class="subsection">1.1.3 output-directory option</h4>
 200 <a name="index-summary_002doutput_002ddirectory"></a>
 201
 202 <p>This is the &ldquo;output directory&rdquo; option.
 203 This option takes a str argument.
 204         The output directory <code>summary</code> will write all output files to.
 205 </p><hr>
 206 <a name="summary-start_002ddate"></a>
 207 <div class="header">
 208 <p>
 209 Next: <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> &nbsp; </p>
 210 </div>
 211 <a name="start_002ddate-option"></a>
 212 <h4 class="subsection">1.1.4 start-date option</h4>
 213 <a name="index-summary_002dstart_002ddate"></a>
 214
 215 <p>This is the &ldquo;start date&rdquo; option.
 216 This option takes a num argument.
 217         Process all files with the date suffix more or equal to value of
 218         this option.  Defaults to 197000101.
 219 </p><hr>
 220 <a name="summary-exit-status"></a>
 221 <div class="header">
 222 <p>
 223 Previous: <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> &nbsp; </p>
 224 </div>
 225 <a name="summary-exit-status-1"></a>
 226 <h4 class="subsection">1.1.5 summary exit status</h4>
 227
 228 <p>One of the following exit values will be returned:
 229 </p><dl compact="compact">
 230 <dt>&lsquo;<samp>0 (EXIT_SUCCESS)</samp>&rsquo;</dt>
 231 <dd><p>Successful program execution.
 232 </p></dd>
 233 <dt>&lsquo;<samp>1 (EXIT_FAILURE)</samp>&rsquo;</dt>
 234 <dd><p>The operation failed or the command syntax was not valid.
 235 </p></dd>
 236 </dl>
 237 <hr>
 238
 239
 240
 241 </body>
 242 </html>