contrib/ntp/scripts/plot_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>Plot_summary User&rsquo;s Manual</title>
   7
   8 <meta name="description" content="Plot_summary User&rsquo;s Manual">
   9 <meta name="keywords" content="Plot_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">Plot_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="Plot_005fsummary-User-Manual"></a>
  59 <h1 class="top">Plot_summary User Manual</h1>
  60
  61 <p>This document describes the use of the NTP Project&rsquo;s <code>plot_summary</code> program.
  62 This document applies to version 4.2.8p14 of <code>plot_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-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_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; plot_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="#plot_005fsummary-Invocation" accesskey="2">plot_summary Invocation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Invoking plot_summary
  78 </td></tr>
  79 </table>
  80
  81 <hr>
  82 <a name="plot_005fsummary-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-plot_005fsummary"></a>
  88 <h2 class="chapter">1 Invoking plot_summary</h2>
  89 <a name="index-plot_005fsummary"></a>
  90 <a name="index-plot-statistics-generated-by-summary-script"></a>
  91
  92
  93 <p>This section was generated by <strong>AutoGen</strong>,
  94 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
  95 </p>
  96 <table class="menu" border="0" cellspacing="0">
  97 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-usage" accesskey="1">plot_summary usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">plot_summary help/usage (<samp>--help</samp>)
  98 </td></tr>
  99 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-directory" accesskey="2">plot_summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">directory option
 100 </td></tr>
 101 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-identifier" accesskey="3">plot_summary identifier</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">identifier option
 102 </td></tr>
 103 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-peer" accesskey="4">plot_summary peer</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">peer option
 104 </td></tr>
 105 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-plot_002dterm" accesskey="5">plot_summary plot-term</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">plot-term option
 106 </td></tr>
 107 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-output_002dfile" accesskey="6">plot_summary output-file</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">output-file option
 108 </td></tr>
 109 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-exit-status" accesskey="7">plot_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="plot_005fsummary-usage"></a>
 115 <div class="header">
 116 <p>
 117 Next: <a href="#plot_005fsummary-directory" accesskey="n" rel="next">plot_summary directory</a>, Up: <a href="#plot_005fsummary-Invocation" accesskey="u" rel="up">plot_summary Invocation</a> &nbsp; </p>
 118 </div>
 119 <a name="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></a>
 120 <h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3>
 121 <a name="index-plot_005fsummary-help"></a>
 122
 123 <p>This is the automatically generated usage text for plot_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">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p14
 135 USAGE: plot_summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
 136
 137         --directory=str          Where the summary files are
 138         --identifier=str         Origin of the data
 139         --offset-limit=float     Limit of absolute offset
 140         --peer=str               Peers to generate plots for
 141                                    - may appear multiple times
 142         --plot-term=str          Gnuplot terminal
 143         --output-file=str        Output file
 144         --dont-wait              Don't wait for keystroke between plots
 145     -?, --help                   Display usage information and exit
 146         --more-help              Pass the extended usage text through a pager
 147
 148 Options are specified by doubled hyphens and their name or by a single
 149 hyphen and the flag character.
 150 </pre></div>
 151
 152 <table class="menu" border="0" cellspacing="0">
 153 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-directory" accesskey="1">plot_summary directory</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 154 </td></tr>
 155 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-identifier" accesskey="2">plot_summary identifier</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 156 </td></tr>
 157 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-peer" accesskey="3">plot_summary peer</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 158 </td></tr>
 159 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-plot_002dterm" accesskey="4">plot_summary plot-term</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 160 </td></tr>
 161 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-output_002dfile" accesskey="5">plot_summary output-file</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 162 </td></tr>
 163 <tr><td align="left" valign="top">&bull; <a href="#plot_005fsummary-exit-status" accesskey="6">plot_summary exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 164 </td></tr>
 165 </table>
 166
 167 <hr>
 168 <a name="plot_005fsummary-directory"></a>
 169 <div class="header">
 170 <p>
 171 Next: <a href="#plot_005fsummary-identifier" accesskey="n" rel="next">plot_summary identifier</a>, Previous: <a href="#plot_005fsummary-usage" accesskey="p" rel="prev">plot_summary usage</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 172 </div>
 173 <a name="directory-option"></a>
 174 <h4 class="subsection">1.1.1 directory option</h4>
 175 <a name="index-plot_005fsummary_002ddirectory"></a>
 176
 177 <p>This is the &ldquo;where the summary files are&rdquo; option.
 178 This option takes a string argument.
 179         The directory where the <code>plot_summary</code> will search for the
 180         *_summary files generated by <code>summary</code> script.
 181 </p><hr>
 182 <a name="plot_005fsummary-identifier"></a>
 183 <div class="header">
 184 <p>
 185 Next: <a href="#plot_005fsummary-peer" accesskey="n" rel="next">plot_summary peer</a>, Previous: <a href="#plot_005fsummary-directory" accesskey="p" rel="prev">plot_summary directory</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 186 </div>
 187 <a name="identifier-option"></a>
 188 <h4 class="subsection">1.1.2 identifier option</h4>
 189 <a name="index-plot_005fsummary_002didentifier"></a>
 190
 191 <p>This is the &ldquo;origin of the data&rdquo; option.
 192 This option takes a string argument.
 193         Where does the plotted data come from, default to string &quot;host&quot; plus
 194         current hostname
 195 </p><hr>
 196 <a name="plot_005fsummary-peer"></a>
 197 <div class="header">
 198 <p>
 199 Next: <a href="#plot_005fsummary-plot_002dterm" accesskey="n" rel="next">plot_summary plot-term</a>, Previous: <a href="#plot_005fsummary-identifier" accesskey="p" rel="prev">plot_summary identifier</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 200 </div>
 201 <a name="peer-option"></a>
 202 <h4 class="subsection">1.1.3 peer option</h4>
 203 <a name="index-plot_005fsummary_002dpeer"></a>
 204
 205 <p>This is the &ldquo;peers to generate plots for&rdquo; option.
 206 This option takes a string argument.
 207 </p>
 208 <p>This option has some usage constraints.  It:
 209 </p><ul>
 210 <li> may appear an unlimited number of times.
 211 </li></ul>
 212
 213 <p>By default the peer_summary plots are not generated. Use this option to
 214         specify list of peers if you want to generate plots for them.
 215 </p><hr>
 216 <a name="plot_005fsummary-plot_002dterm"></a>
 217 <div class="header">
 218 <p>
 219 Next: <a href="#plot_005fsummary-output_002dfile" accesskey="n" rel="next">plot_summary output-file</a>, Previous: <a href="#plot_005fsummary-peer" accesskey="p" rel="prev">plot_summary peer</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 220 </div>
 221 <a name="plot_002dterm-option"></a>
 222 <h4 class="subsection">1.1.4 plot-term option</h4>
 223 <a name="index-plot_005fsummary_002dplot_002dterm"></a>
 224
 225 <p>This is the &ldquo;gnuplot terminal&rdquo; option.
 226 This option takes a string argument.
 227         This is string is passed directly to the <code>gnuplot set terminal</code>
 228         command.  Default is <code>x11</code> if <code>DISPLAY</code> is set and
 229         <code>dumb</code> is it&rsquo;s not&rsquo;. See output from (gnuplot -e &quot;set
 230         terminal&quot;) for the list of available options.
 231 </p><hr>
 232 <a name="plot_005fsummary-output_002dfile"></a>
 233 <div class="header">
 234 <p>
 235 Next: <a href="#plot_005fsummary-exit-status" accesskey="n" rel="next">plot_summary exit status</a>, Previous: <a href="#plot_005fsummary-plot_002dterm" accesskey="p" rel="prev">plot_summary plot-term</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 236 </div>
 237 <a name="output_002dfile-option"></a>
 238 <h4 class="subsection">1.1.5 output-file option</h4>
 239 <a name="index-plot_005fsummary_002doutput_002dfile"></a>
 240
 241 <p>This is the &ldquo;output file&rdquo; option.
 242 This option takes a str argument.
 243         Output file for <code>gnuplot</code>, default to stdout.
 244 </p><hr>
 245 <a name="plot_005fsummary-exit-status"></a>
 246 <div class="header">
 247 <p>
 248 Previous: <a href="#plot_005fsummary-output_002dfile" accesskey="p" rel="prev">plot_summary output-file</a>, Up: <a href="#plot_005fsummary-usage" accesskey="u" rel="up">plot_summary usage</a> &nbsp; </p>
 249 </div>
 250 <a name="plot_005fsummary-exit-status-1"></a>
 251 <h4 class="subsection">1.1.6 plot_summary exit status</h4>
 252
 253 <p>One of the following exit values will be returned:
 254 </p><dl compact="compact">
 255 <dt>&lsquo;<samp>0 (EXIT_SUCCESS)</samp>&rsquo;</dt>
 256 <dd><p>Successful program execution.
 257 </p></dd>
 258 <dt>&lsquo;<samp>1 (EXIT_FAILURE)</samp>&rsquo;</dt>
 259 <dd><p>The operation failed or the command syntax was not valid.
 260 </p></dd>
 261 </dl>
 262 <hr>
 263
 264
 265
 266 </body>
 267 </html>