12b15cb3dSCy Schubert<html lang="en">
22b15cb3dSCy Schubert<head>
32b15cb3dSCy Schubert<title>Plot_summary User's Manual</title>
42b15cb3dSCy Schubert<meta http-equiv="Content-Type" content="text/html">
52b15cb3dSCy Schubert<meta name="description" content="Plot_summary User's Manual">
62b15cb3dSCy Schubert<meta name="generator" content="makeinfo 4.7">
72b15cb3dSCy Schubert<link title="Top" rel="top" href="#Top">
82b15cb3dSCy Schubert<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
92b15cb3dSCy Schubert<meta http-equiv="Content-Style-Type" content="text/css">
102b15cb3dSCy Schubert<style type="text/css"><!--
112b15cb3dSCy Schubert  pre.display { font-family:inherit }
122b15cb3dSCy Schubert  pre.format  { font-family:inherit }
132b15cb3dSCy Schubert  pre.smalldisplay { font-family:inherit; font-size:smaller }
142b15cb3dSCy Schubert  pre.smallformat  { font-family:inherit; font-size:smaller }
152b15cb3dSCy Schubert  pre.smallexample { font-size:smaller }
162b15cb3dSCy Schubert  pre.smalllisp    { font-size:smaller }
172b15cb3dSCy Schubert  span.sc { font-variant:small-caps }
182b15cb3dSCy Schubert  span.roman { font-family: serif; font-weight: normal; }
192b15cb3dSCy Schubert--></style>
202b15cb3dSCy Schubert</head>
212b15cb3dSCy Schubert<body>
222b15cb3dSCy Schubert<h1 class="settitle">Plot_summary User's Manual</h1>
232b15cb3dSCy Schubert<div class="node">
242b15cb3dSCy Schubert<p><hr>
252b15cb3dSCy Schubert<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>,
262b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
272b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
282b15cb3dSCy Schubert<br>
292b15cb3dSCy Schubert</div>
302b15cb3dSCy Schubert
312b15cb3dSCy Schubert<h2 class="unnumbered">Plot_summary User Manual</h2>
322b15cb3dSCy Schubert
332b15cb3dSCy Schubert<p>This document describes the use of the NTP Project's <code>plot_summary</code> program.
342b15cb3dSCy SchubertThis document applies to version 4.2.8p1 of <code>plot_summary</code>.
352b15cb3dSCy Schubert
362b15cb3dSCy Schubert  <div class="shortcontents">
372b15cb3dSCy Schubert<h2>Short Contents</h2>
382b15cb3dSCy Schubert<ul>
392b15cb3dSCy Schubert<a href="#Top">Plot_summary User Manual</a>
402b15cb3dSCy Schubert</ul>
412b15cb3dSCy Schubert</div>
422b15cb3dSCy Schubert
432b15cb3dSCy Schubert<ul class="menu">
442b15cb3dSCy Schubert<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>:              Description
452b15cb3dSCy Schubert<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: 		    Invoking plot_summary
462b15cb3dSCy Schubert</ul>
472b15cb3dSCy Schubert
482b15cb3dSCy Schubert<div class="node">
492b15cb3dSCy Schubert<p><hr>
502b15cb3dSCy Schubert<a name="plot_005fsummary-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>,
512b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
522b15cb3dSCy Schubert<br>
532b15cb3dSCy Schubert</div>
542b15cb3dSCy Schubert
552b15cb3dSCy Schubert<h3 class="section">Invoking plot_summary</h3>
562b15cb3dSCy Schubert
572b15cb3dSCy Schubert<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a>
582b15cb3dSCy Schubert
592b15cb3dSCy Schubert  <p>This section was generated by <strong>AutoGen</strong>,
602b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
612b15cb3dSCy Schubert
622b15cb3dSCy Schubert<ul class="menu">
632b15cb3dSCy Schubert<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>:                   plot_summary help/usage (<span class="option">--help</span>)
642b15cb3dSCy Schubert<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>:               directory option
652b15cb3dSCy Schubert<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>:              identifier option
662b15cb3dSCy Schubert<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>:                    peer option
672b15cb3dSCy Schubert<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>:               plot-term option
682b15cb3dSCy Schubert<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>:             output-file option
692b15cb3dSCy Schubert<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>:             exit status
702b15cb3dSCy Schubert</ul>
712b15cb3dSCy Schubert
722b15cb3dSCy Schubert<div class="node">
732b15cb3dSCy Schubert<p><hr>
742b15cb3dSCy Schubert<a name="plot_005fsummary-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>,
752b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
762b15cb3dSCy Schubert<br>
772b15cb3dSCy Schubert</div>
782b15cb3dSCy Schubert
792b15cb3dSCy Schubert<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4>
802b15cb3dSCy Schubert
812b15cb3dSCy Schubert<p><a name="index-plot_005fsummary-help-3"></a>
822b15cb3dSCy SchubertThis is the automatically generated usage text for plot_summary.
832b15cb3dSCy Schubert
842b15cb3dSCy Schubert  <p>The text printed is the same whether selected with the <code>help</code> option
852b15cb3dSCy Schubert(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
862b15cb3dSCy Schubertthe usage text by passing it through a pager program.
872b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working
882b15cb3dSCy Schubert<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
892b15cb3dSCy Schubertused to select the program, defaulting to <span class="file">more</span>.  Both will exit
902b15cb3dSCy Schubertwith a status code of 0.
912b15cb3dSCy Schubert
922b15cb3dSCy Schubert<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p1
932b15cb3dSCy SchubertUSAGE: plot_summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
942b15cb3dSCy Schubert
952b15cb3dSCy Schubert        --directory=str          Where the summary files are
962b15cb3dSCy Schubert        --identifier=str         Origin of the data
972b15cb3dSCy Schubert        --offset-limit=float     Limit of absolute offset
982b15cb3dSCy Schubert        --peer=str               Peers to generate plots for
992b15cb3dSCy Schubert                                   - may appear multiple times
1002b15cb3dSCy Schubert        --plot-term=str          Gnuplot terminal
1012b15cb3dSCy Schubert        --output-file=str        Output file
1022b15cb3dSCy Schubert        --dont-wait              Don't wait for keystroke between plots
1032b15cb3dSCy Schubert    -?, --help                   Display usage information and exit
1042b15cb3dSCy Schubert        --more-help              Pass the extended usage text through a pager
1052b15cb3dSCy Schubert
1062b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single
1072b15cb3dSCy Schuberthyphen and the flag character.
1082b15cb3dSCy Schubert</pre>
1092b15cb3dSCy Schubert  <div class="node">
1102b15cb3dSCy Schubert<p><hr>
1112b15cb3dSCy Schubert<a name="plot_005fsummary-directory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
1122b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>,
1132b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1142b15cb3dSCy Schubert<br>
1152b15cb3dSCy Schubert</div>
1162b15cb3dSCy Schubert
1172b15cb3dSCy Schubert<h4 class="subsection">directory option</h4>
1182b15cb3dSCy Schubert
1192b15cb3dSCy Schubert<p><a name="index-plot_005fsummary_002ddirectory-4"></a>
1202b15cb3dSCy SchubertThis is the &ldquo;where the summary files are&rdquo; option.
1212b15cb3dSCy SchubertThis option takes a string argument.
1222b15cb3dSCy Schubert        The directory where the <code>plot_summary</code> will search for the
1232b15cb3dSCy Schubert        *_summary files generated by <code>summary</code> script.
1242b15cb3dSCy Schubert<div class="node">
1252b15cb3dSCy Schubert<p><hr>
1262b15cb3dSCy Schubert<a name="plot_005fsummary-identifier"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>,
1272b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>,
1282b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1292b15cb3dSCy Schubert<br>
1302b15cb3dSCy Schubert</div>
1312b15cb3dSCy Schubert
1322b15cb3dSCy Schubert<h4 class="subsection">identifier option</h4>
1332b15cb3dSCy Schubert
1342b15cb3dSCy Schubert<p><a name="index-plot_005fsummary_002didentifier-5"></a>
1352b15cb3dSCy SchubertThis is the &ldquo;origin of the data&rdquo; option.
1362b15cb3dSCy SchubertThis option takes a string argument.
1372b15cb3dSCy Schubert        Where does the plotted data come from, default to string "host" plus
1382b15cb3dSCy Schubert        current hostname
1392b15cb3dSCy Schubert<div class="node">
1402b15cb3dSCy Schubert<p><hr>
1412b15cb3dSCy Schubert<a name="plot_005fsummary-peer"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
1422b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
1432b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1442b15cb3dSCy Schubert<br>
1452b15cb3dSCy Schubert</div>
1462b15cb3dSCy Schubert
1472b15cb3dSCy Schubert<h4 class="subsection">peer option</h4>
1482b15cb3dSCy Schubert
1492b15cb3dSCy Schubert<p><a name="index-plot_005fsummary_002dpeer-6"></a>
1502b15cb3dSCy SchubertThis is the &ldquo;peers to generate plots for&rdquo; option.
1512b15cb3dSCy SchubertThis option takes a string argument.
1522b15cb3dSCy Schubert
1532b15cb3dSCy Schubert<p class="noindent">This option has some usage constraints.  It:
1542b15cb3dSCy Schubert     <ul>
1552b15cb3dSCy Schubert<li>may appear an unlimited number of times.
1562b15cb3dSCy Schubert</ul>
1572b15cb3dSCy Schubert
1582b15cb3dSCy Schubert  <p>By default the peer_summary plots are not generated. Use this option to
1592b15cb3dSCy Schubert        specify list of peers if you want to generate plots for them.
1602b15cb3dSCy Schubert<div class="node">
1612b15cb3dSCy Schubert<p><hr>
1622b15cb3dSCy Schubert<a name="plot_005fsummary-plot_002dterm"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
1632b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>,
1642b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1652b15cb3dSCy Schubert<br>
1662b15cb3dSCy Schubert</div>
1672b15cb3dSCy Schubert
1682b15cb3dSCy Schubert<h4 class="subsection">plot-term option</h4>
1692b15cb3dSCy Schubert
1702b15cb3dSCy Schubert<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a>
1712b15cb3dSCy SchubertThis is the &ldquo;gnuplot terminal&rdquo; option.
1722b15cb3dSCy SchubertThis option takes a string argument.
1732b15cb3dSCy Schubert        This is string is passed directly to the <code>gnuplot set terminal</code>
1742b15cb3dSCy Schubert        command.  Default is <code>x11</code> if <code>DISPLAY</code> is set and
1752b15cb3dSCy Schubert        <code>dumb</code> is it's not'. See output from  -e "set
1762b15cb3dSCy Schubert        terminal") for the list of avalaible options.
1772b15cb3dSCy Schubert<div class="node">
1782b15cb3dSCy Schubert<p><hr>
1792b15cb3dSCy Schubert<a name="plot_005fsummary-output_002dfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>,
1802b15cb3dSCy SchubertPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
1812b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1822b15cb3dSCy Schubert<br>
1832b15cb3dSCy Schubert</div>
1842b15cb3dSCy Schubert
1852b15cb3dSCy Schubert<h4 class="subsection">output-file option</h4>
1862b15cb3dSCy Schubert
1872b15cb3dSCy Schubert<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a>
1882b15cb3dSCy SchubertThis is the &ldquo;output file&rdquo; option.
1892b15cb3dSCy SchubertThis option takes a str argument.
1902b15cb3dSCy Schubert        Output file for <code>gnuplot</code>, default to stdout.
1912b15cb3dSCy Schubert<div class="node">
1922b15cb3dSCy Schubert<p><hr>
1932b15cb3dSCy Schubert<a name="plot_005fsummary-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
1942b15cb3dSCy SchubertUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
1952b15cb3dSCy Schubert<br>
1962b15cb3dSCy Schubert</div>
1972b15cb3dSCy Schubert
1982b15cb3dSCy Schubert<h4 class="subsection">plot_summary exit status</h4>
1992b15cb3dSCy Schubert
2002b15cb3dSCy Schubert<p>One of the following exit values will be returned:
2012b15cb3dSCy Schubert     <dl>
2022b15cb3dSCy Schubert<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution.
2032b15cb3dSCy Schubert<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid.
2042b15cb3dSCy Schubert</dl>
2052b15cb3dSCy Schubert
2062b15cb3dSCy Schubert</body></html>
2072b15cb3dSCy Schubert
208