165853c10SCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
265853c10SCy Schubert<html>
365853c10SCy Schubert<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
42b15cb3dSCy Schubert<head>
565853c10SCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
665853c10SCy Schubert<title>Plot_summary User&rsquo;s Manual</title>
765853c10SCy Schubert
865853c10SCy Schubert<meta name="description" content="Plot_summary User&rsquo;s Manual">
965853c10SCy Schubert<meta name="keywords" content="Plot_summary User&rsquo;s Manual">
1065853c10SCy Schubert<meta name="resource-type" content="document">
1165853c10SCy Schubert<meta name="distribution" content="global">
1265853c10SCy Schubert<meta name="Generator" content="makeinfo">
1365853c10SCy Schubert<link href="#Top" rel="start" title="Top">
1465853c10SCy Schubert<link href="dir.html#Top" rel="up" title="(dir)">
1565853c10SCy Schubert<style type="text/css">
1665853c10SCy Schubert<!--
1765853c10SCy Schuberta.summary-letter {text-decoration: none}
1865853c10SCy Schubertblockquote.indentedblock {margin-right: 0em}
1965853c10SCy Schubertblockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
2065853c10SCy Schubertblockquote.smallquotation {font-size: smaller}
2165853c10SCy Schubertdiv.display {margin-left: 3.2em}
2265853c10SCy Schubertdiv.example {margin-left: 3.2em}
2365853c10SCy Schubertdiv.lisp {margin-left: 3.2em}
2465853c10SCy Schubertdiv.smalldisplay {margin-left: 3.2em}
2565853c10SCy Schubertdiv.smallexample {margin-left: 3.2em}
2665853c10SCy Schubertdiv.smalllisp {margin-left: 3.2em}
2765853c10SCy Schubertkbd {font-style: oblique}
282b15cb3dSCy Schubertpre.display {font-family: inherit}
292b15cb3dSCy Schubertpre.format {font-family: inherit}
3065853c10SCy Schubertpre.menu-comment {font-family: serif}
3165853c10SCy Schubertpre.menu-preformatted {font-family: serif}
322b15cb3dSCy Schubertpre.smalldisplay {font-family: inherit; font-size: smaller}
332b15cb3dSCy Schubertpre.smallexample {font-size: smaller}
3465853c10SCy Schubertpre.smallformat {font-family: inherit; font-size: smaller}
352b15cb3dSCy Schubertpre.smalllisp {font-size: smaller}
3665853c10SCy Schubertspan.nolinebreak {white-space: nowrap}
3765853c10SCy Schubertspan.roman {font-family: initial; font-weight: normal}
3865853c10SCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal}
3965853c10SCy Schubertul.no-bullet {list-style: none}
4065853c10SCy Schubert-->
4165853c10SCy Schubert</style>
4265853c10SCy Schubert
4365853c10SCy Schubert
442b15cb3dSCy Schubert</head>
4565853c10SCy Schubert
4665853c10SCy Schubert<body lang="en">
4765853c10SCy Schubert<h1 class="settitle" align="center">Plot_summary User&rsquo;s Manual</h1>
4865853c10SCy Schubert
4965853c10SCy Schubert
5065853c10SCy Schubert
5165853c10SCy Schubert
5265853c10SCy Schubert
5365853c10SCy Schubert<a name="Top"></a>
5465853c10SCy Schubert<div class="header">
5565853c10SCy Schubert<p>
5665853c10SCy SchubertPrevious: <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>
572b15cb3dSCy Schubert</div>
5865853c10SCy Schubert<a name="Plot_005fsummary-User-Manual"></a>
5965853c10SCy Schubert<h1 class="top">Plot_summary User Manual</h1>
602b15cb3dSCy Schubert
6165853c10SCy Schubert<p>This document describes the use of the NTP Project&rsquo;s <code>plot_summary</code> program.
62*298b6337SGordon TetlowThis document applies to version 4.2.8p14 of <code>plot_summary</code>.
6365853c10SCy Schubert</p>
6465853c10SCy Schubert<a name="SEC_Overview"></a>
6565853c10SCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2>
662b15cb3dSCy Schubert
672b15cb3dSCy Schubert<div class="shortcontents">
6865853c10SCy Schubert<ul class="no-bullet">
6965853c10SCy Schubert<li><a name="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li>
702b15cb3dSCy Schubert</ul>
712b15cb3dSCy Schubert</div>
722b15cb3dSCy Schubert
732b15cb3dSCy Schubert
7465853c10SCy Schubert<table class="menu" border="0" cellspacing="0">
7565853c10SCy Schubert<tr><td align="left" valign="top">&bull; plot_summary Description:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description
7665853c10SCy Schubert</td></tr>
7765853c10SCy Schubert<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
7865853c10SCy Schubert</td></tr>
7965853c10SCy Schubert</table>
8065853c10SCy Schubert
8165853c10SCy Schubert<hr>
8265853c10SCy Schubert<a name="plot_005fsummary-Invocation"></a>
8365853c10SCy Schubert<div class="header">
8465853c10SCy Schubert<p>
8565853c10SCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; </p>
862b15cb3dSCy Schubert</div>
8765853c10SCy Schubert<a name="Invoking-plot_005fsummary"></a>
8865853c10SCy Schubert<h2 class="chapter">1 Invoking plot_summary</h2>
8965853c10SCy Schubert<a name="index-plot_005fsummary"></a>
9065853c10SCy Schubert<a name="index-plot-statistics-generated-by-summary-script"></a>
912b15cb3dSCy Schubert
922b15cb3dSCy Schubert
932b15cb3dSCy Schubert<p>This section was generated by <strong>AutoGen</strong>,
942b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
9565853c10SCy Schubert</p>
9665853c10SCy Schubert<table class="menu" border="0" cellspacing="0">
9765853c10SCy Schubert<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>)
9865853c10SCy Schubert</td></tr>
9965853c10SCy Schubert<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
10065853c10SCy Schubert</td></tr>
10165853c10SCy Schubert<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
10265853c10SCy Schubert</td></tr>
10365853c10SCy Schubert<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
10465853c10SCy Schubert</td></tr>
10565853c10SCy Schubert<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
10665853c10SCy Schubert</td></tr>
10765853c10SCy Schubert<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
10865853c10SCy Schubert</td></tr>
10965853c10SCy Schubert<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
11065853c10SCy Schubert</td></tr>
11165853c10SCy Schubert</table>
1122b15cb3dSCy Schubert
11365853c10SCy Schubert<hr>
11465853c10SCy Schubert<a name="plot_005fsummary-usage"></a>
11565853c10SCy Schubert<div class="header">
11665853c10SCy Schubert<p>
11765853c10SCy SchubertNext: <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>
1182b15cb3dSCy Schubert</div>
11965853c10SCy Schubert<a name="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></a>
12065853c10SCy Schubert<h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3>
12165853c10SCy Schubert<a name="index-plot_005fsummary-help"></a>
1222b15cb3dSCy Schubert
12365853c10SCy Schubert<p>This is the automatically generated usage text for plot_summary.
12465853c10SCy Schubert</p>
1252b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option
12665853c10SCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>).  <code>more-help</code> will print
1272b15cb3dSCy Schubertthe usage text by passing it through a pager program.
1282b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working
1292b15cb3dSCy Schubert<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
13065853c10SCy Schubertused to select the program, defaulting to <samp>more</samp>.  Both will exit
1312b15cb3dSCy Schubertwith a status code of 0.
13265853c10SCy Schubert</p>
13365853c10SCy Schubert<div class="example">
134*298b6337SGordon Tetlow<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p14
1352b15cb3dSCy SchubertUSAGE: plot_summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
1362b15cb3dSCy Schubert
1372b15cb3dSCy Schubert        --directory=str          Where the summary files are
1382b15cb3dSCy Schubert        --identifier=str         Origin of the data
1392b15cb3dSCy Schubert        --offset-limit=float     Limit of absolute offset
1402b15cb3dSCy Schubert        --peer=str               Peers to generate plots for
1412b15cb3dSCy Schubert                                   - may appear multiple times
1422b15cb3dSCy Schubert        --plot-term=str          Gnuplot terminal
1432b15cb3dSCy Schubert        --output-file=str        Output file
1442b15cb3dSCy Schubert        --dont-wait              Don't wait for keystroke between plots
1452b15cb3dSCy Schubert    -?, --help                   Display usage information and exit
1462b15cb3dSCy Schubert        --more-help              Pass the extended usage text through a pager
1472b15cb3dSCy Schubert
1482b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single
1492b15cb3dSCy Schuberthyphen and the flag character.
15065853c10SCy Schubert</pre></div>
15165853c10SCy Schubert
15265853c10SCy Schubert<table class="menu" border="0" cellspacing="0">
15365853c10SCy Schubert<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">
15465853c10SCy Schubert</td></tr>
15565853c10SCy Schubert<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">
15665853c10SCy Schubert</td></tr>
15765853c10SCy Schubert<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">
15865853c10SCy Schubert</td></tr>
15965853c10SCy Schubert<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">
16065853c10SCy Schubert</td></tr>
16165853c10SCy Schubert<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">
16265853c10SCy Schubert</td></tr>
16365853c10SCy Schubert<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">
16465853c10SCy Schubert</td></tr>
16565853c10SCy Schubert</table>
16665853c10SCy Schubert
16765853c10SCy Schubert<hr>
16865853c10SCy Schubert<a name="plot_005fsummary-directory"></a>
16965853c10SCy Schubert<div class="header">
17065853c10SCy Schubert<p>
17165853c10SCy SchubertNext: <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>
1722b15cb3dSCy Schubert</div>
17365853c10SCy Schubert<a name="directory-option"></a>
17465853c10SCy Schubert<h4 class="subsection">1.1.1 directory option</h4>
17565853c10SCy Schubert<a name="index-plot_005fsummary_002ddirectory"></a>
1762b15cb3dSCy Schubert
17765853c10SCy Schubert<p>This is the &ldquo;where the summary files are&rdquo; option.
1782b15cb3dSCy SchubertThis option takes a string argument.
1792b15cb3dSCy Schubert        The directory where the <code>plot_summary</code> will search for the
1802b15cb3dSCy Schubert        *_summary files generated by <code>summary</code> script.
18165853c10SCy Schubert</p><hr>
18265853c10SCy Schubert<a name="plot_005fsummary-identifier"></a>
18365853c10SCy Schubert<div class="header">
18465853c10SCy Schubert<p>
18565853c10SCy SchubertNext: <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>
1862b15cb3dSCy Schubert</div>
18765853c10SCy Schubert<a name="identifier-option"></a>
18865853c10SCy Schubert<h4 class="subsection">1.1.2 identifier option</h4>
18965853c10SCy Schubert<a name="index-plot_005fsummary_002didentifier"></a>
1902b15cb3dSCy Schubert
19165853c10SCy Schubert<p>This is the &ldquo;origin of the data&rdquo; option.
1922b15cb3dSCy SchubertThis option takes a string argument.
19365853c10SCy Schubert        Where does the plotted data come from, default to string &quot;host&quot; plus
1942b15cb3dSCy Schubert        current hostname
19565853c10SCy Schubert</p><hr>
19665853c10SCy Schubert<a name="plot_005fsummary-peer"></a>
19765853c10SCy Schubert<div class="header">
19865853c10SCy Schubert<p>
19965853c10SCy SchubertNext: <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>
2002b15cb3dSCy Schubert</div>
20165853c10SCy Schubert<a name="peer-option"></a>
20265853c10SCy Schubert<h4 class="subsection">1.1.3 peer option</h4>
20365853c10SCy Schubert<a name="index-plot_005fsummary_002dpeer"></a>
2042b15cb3dSCy Schubert
20565853c10SCy Schubert<p>This is the &ldquo;peers to generate plots for&rdquo; option.
2062b15cb3dSCy SchubertThis option takes a string argument.
20765853c10SCy Schubert</p>
20865853c10SCy Schubert<p>This option has some usage constraints.  It:
20965853c10SCy Schubert</p><ul>
2102b15cb3dSCy Schubert<li> may appear an unlimited number of times.
21165853c10SCy Schubert</li></ul>
2122b15cb3dSCy Schubert
2132b15cb3dSCy Schubert<p>By default the peer_summary plots are not generated. Use this option to
2142b15cb3dSCy Schubert        specify list of peers if you want to generate plots for them.
21565853c10SCy Schubert</p><hr>
21665853c10SCy Schubert<a name="plot_005fsummary-plot_002dterm"></a>
21765853c10SCy Schubert<div class="header">
21865853c10SCy Schubert<p>
21965853c10SCy SchubertNext: <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>
2202b15cb3dSCy Schubert</div>
22165853c10SCy Schubert<a name="plot_002dterm-option"></a>
22265853c10SCy Schubert<h4 class="subsection">1.1.4 plot-term option</h4>
22365853c10SCy Schubert<a name="index-plot_005fsummary_002dplot_002dterm"></a>
2242b15cb3dSCy Schubert
22565853c10SCy Schubert<p>This is the &ldquo;gnuplot terminal&rdquo; option.
2262b15cb3dSCy SchubertThis option takes a string argument.
2272b15cb3dSCy Schubert        This is string is passed directly to the <code>gnuplot set terminal</code>
2282b15cb3dSCy Schubert        command.  Default is <code>x11</code> if <code>DISPLAY</code> is set and
22965853c10SCy Schubert        <code>dumb</code> is it&rsquo;s not&rsquo;. See output from (gnuplot -e &quot;set
23065853c10SCy Schubert        terminal&quot;) for the list of available options.
23165853c10SCy Schubert</p><hr>
23265853c10SCy Schubert<a name="plot_005fsummary-output_002dfile"></a>
23365853c10SCy Schubert<div class="header">
23465853c10SCy Schubert<p>
23565853c10SCy SchubertNext: <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>
2362b15cb3dSCy Schubert</div>
23765853c10SCy Schubert<a name="output_002dfile-option"></a>
23865853c10SCy Schubert<h4 class="subsection">1.1.5 output-file option</h4>
23965853c10SCy Schubert<a name="index-plot_005fsummary_002doutput_002dfile"></a>
2402b15cb3dSCy Schubert
24165853c10SCy Schubert<p>This is the &ldquo;output file&rdquo; option.
2422b15cb3dSCy SchubertThis option takes a str argument.
2432b15cb3dSCy Schubert        Output file for <code>gnuplot</code>, default to stdout.
24465853c10SCy Schubert</p><hr>
24565853c10SCy Schubert<a name="plot_005fsummary-exit-status"></a>
24665853c10SCy Schubert<div class="header">
24765853c10SCy Schubert<p>
24865853c10SCy SchubertPrevious: <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>
2492b15cb3dSCy Schubert</div>
25065853c10SCy Schubert<a name="plot_005fsummary-exit-status-1"></a>
25165853c10SCy Schubert<h4 class="subsection">1.1.6 plot_summary exit status</h4>
2522b15cb3dSCy Schubert
2532b15cb3dSCy Schubert<p>One of the following exit values will be returned:
25465853c10SCy Schubert</p><dl compact="compact">
25565853c10SCy Schubert<dt>&lsquo;<samp>0 (EXIT_SUCCESS)</samp>&rsquo;</dt>
25665853c10SCy Schubert<dd><p>Successful program execution.
25765853c10SCy Schubert</p></dd>
25865853c10SCy Schubert<dt>&lsquo;<samp>1 (EXIT_FAILURE)</samp>&rsquo;</dt>
25965853c10SCy Schubert<dd><p>The operation failed or the command syntax was not valid.
26065853c10SCy Schubert</p></dd>
2612b15cb3dSCy Schubert</dl>
26265853c10SCy Schubert<hr>
2632b15cb3dSCy Schubert
2642b15cb3dSCy Schubert
26565853c10SCy Schubert
26665853c10SCy Schubert</body>
26765853c10SCy Schubert</html>
268