e6bfd18d21
Fixes two small bugs including one regression. MFC after: 3 days Merge commit 'ab1f1aa8333369a83ff284848fc3fc2e52d5f29f'
241 lines
12 KiB
HTML
241 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>Plot_summary User’s Manual</title>
|
|
|
|
<meta name="description" content="Plot_summary User’s Manual">
|
|
<meta name="keywords" content="Plot_summary User’s Manual">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content="makeinfo">
|
|
<link href="#Top" rel="start" title="Top">
|
|
<link href="dir.html#Top" rel="up" title="(dir)">
|
|
<style type="text/css">
|
|
<!--
|
|
a.summary-letter {text-decoration: none}
|
|
blockquote.indentedblock {margin-right: 0em}
|
|
div.display {margin-left: 3.2em}
|
|
div.example {margin-left: 3.2em}
|
|
div.lisp {margin-left: 3.2em}
|
|
kbd {font-style: oblique}
|
|
pre.display {font-family: inherit}
|
|
pre.format {font-family: inherit}
|
|
pre.menu-comment {font-family: serif}
|
|
pre.menu-preformatted {font-family: serif}
|
|
span.nolinebreak {white-space: nowrap}
|
|
span.roman {font-family: initial; font-weight: normal}
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
ul.no-bullet {list-style: none}
|
|
-->
|
|
</style>
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<h1 class="settitle" align="center">Plot_summary User’s Manual</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<span id="Top"></span><div class="header">
|
|
<p>
|
|
Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p>
|
|
</div>
|
|
<span id="Plot_005fsummary-User-Manual"></span><h1 class="top">Plot_summary User Manual</h1>
|
|
|
|
<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program.
|
|
This document applies to version 4.2.8p17 of <code>plot_summary</code>.
|
|
</p>
|
|
<span id="SEC_Overview"></span>
|
|
<h2 class="shortcontents-heading">Short Table of Contents</h2>
|
|
|
|
<div class="shortcontents">
|
|
<ul class="no-bullet">
|
|
<li><a id="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<table class="menu" border="0" cellspacing="0">
|
|
<tr><td align="left" valign="top">• plot_summary Description</td><td> </td><td align="left" valign="top">Description
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-Invocation" accesskey="2">plot_summary Invocation</a></td><td> </td><td align="left" valign="top">Invoking plot_summary
|
|
</td></tr>
|
|
</table>
|
|
|
|
<hr>
|
|
<span id="plot_005fsummary-Invocation"></span><div class="header">
|
|
<p>
|
|
Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
|
|
</div>
|
|
<span id="Invoking-plot_005fsummary"></span><h2 class="chapter">1 Invoking plot_summary</h2>
|
|
<span id="index-plot_005fsummary"></span>
|
|
<span id="index-plot-statistics-generated-by-summary-script"></span>
|
|
|
|
|
|
<p>This section was generated by <strong>AutoGen</strong>,
|
|
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
|
|
</p>
|
|
<table class="menu" border="0" cellspacing="0">
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-usage" accesskey="1">plot_summary usage</a></td><td> </td><td align="left" valign="top">plot_summary help/usage (<samp>--help</samp>)
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="2">plot_summary directory</a></td><td> </td><td align="left" valign="top">directory option
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="3">plot_summary identifier</a></td><td> </td><td align="left" valign="top">identifier option
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="4">plot_summary peer</a></td><td> </td><td align="left" valign="top">peer option
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="5">plot_summary plot-term</a></td><td> </td><td align="left" valign="top">plot-term option
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="6">plot_summary output-file</a></td><td> </td><td align="left" valign="top">output-file option
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="7">plot_summary exit status</a></td><td> </td><td align="left" valign="top">exit status
|
|
</td></tr>
|
|
</table>
|
|
|
|
<hr>
|
|
<span id="plot_005fsummary-usage"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3>
|
|
<span id="index-plot_005fsummary-help"></span>
|
|
|
|
<p>This is the automatically generated usage text for plot_summary.
|
|
</p>
|
|
<p>The text printed is the same whether selected with the <code>help</code> option
|
|
(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
|
|
the usage text by passing it through a pager program.
|
|
<code>more-help</code> is disabled on platforms without a working
|
|
<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
|
|
used to select the program, defaulting to <samp>more</samp>. Both will exit
|
|
with a status code of 0.
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p17
|
|
USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
|
|
|
|
--directory=str Where the summary files are
|
|
--identifier=str Origin of the data
|
|
--offset-limit=float Limit of absolute offset
|
|
--peer=str Peers to generate plots for
|
|
- may appear multiple times
|
|
--plot-term=str Gnuplot terminal
|
|
--output-file=str Output file
|
|
--dont-wait Don't wait for keystroke between plots
|
|
-?, --help Display usage information and exit
|
|
--more-help Pass the extended usage text through a pager
|
|
|
|
Options are specified by doubled hyphens and their name or by a single
|
|
hyphen and the flag character.
|
|
</pre></div>
|
|
|
|
<table class="menu" border="0" cellspacing="0">
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">identifier option</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">peer option</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="4">plot-term option</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="5">output-file option</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="#plot_005fsummary-exit-status" accesskey="6">plot_summary exit status</a></td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
</table>
|
|
|
|
<hr>
|
|
<span id="plot_005fsummary-directory"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4>
|
|
<span id="index-plot_005fsummary_002ddirectory"></span>
|
|
|
|
<p>This is the “where the summary files are” option.
|
|
This option takes a string argument.
|
|
The directory where the <code>plot_summary</code> will search for the
|
|
*_summary files generated by <code>summary</code> script.
|
|
</p><hr>
|
|
<span id="plot_005fsummary-identifier"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="identifier-option"></span><h4 class="subsection">1.1.2 identifier option</h4>
|
|
<span id="index-plot_005fsummary_002didentifier"></span>
|
|
|
|
<p>This is the “origin of the data” option.
|
|
This option takes a string argument.
|
|
Where does the plotted data come from, default to string "host" plus
|
|
current hostname
|
|
</p><hr>
|
|
<span id="plot_005fsummary-peer"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="peer-option"></span><h4 class="subsection">1.1.3 peer option</h4>
|
|
<span id="index-plot_005fsummary_002dpeer"></span>
|
|
|
|
<p>This is the “peers to generate plots for” option.
|
|
This option takes a string argument.
|
|
</p>
|
|
<p>This option has some usage constraints. It:
|
|
</p><ul>
|
|
<li> may appear an unlimited number of times.
|
|
</li></ul>
|
|
|
|
<p>By default the peer_summary plots are not generated. Use this option to
|
|
specify list of peers if you want to generate plots for them.
|
|
</p><hr>
|
|
<span id="plot_005fsummary-plot_002dterm"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="plot_002dterm-option"></span><h4 class="subsection">1.1.4 plot-term option</h4>
|
|
<span id="index-plot_005fsummary_002dplot_002dterm"></span>
|
|
|
|
<p>This is the “gnuplot terminal” option.
|
|
This option takes a string argument.
|
|
This is string is passed directly to the <code>gnuplot set terminal</code>
|
|
command. Default is <code>x11</code> if <code>DISPLAY</code> is set and
|
|
<code>dumb</code> is it’s not’. See output from (gnuplot -e "set
|
|
terminal") for the list of available options.
|
|
</p><hr>
|
|
<span id="plot_005fsummary-output_002dfile"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="output_002dfile-option"></span><h4 class="subsection">1.1.5 output-file option</h4>
|
|
<span id="index-plot_005fsummary_002doutput_002dfile"></span>
|
|
|
|
<p>This is the “output file” option.
|
|
This option takes a str argument.
|
|
Output file for <code>gnuplot</code>, default to stdout.
|
|
</p><hr>
|
|
<span id="plot_005fsummary-exit-status"></span><div class="header">
|
|
<p>
|
|
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> </p>
|
|
</div>
|
|
<span id="plot_005fsummary-exit-status-1"></span><h4 class="subsection">1.1.6 plot_summary exit status</h4>
|
|
|
|
<p>One of the following exit values will be returned:
|
|
</p><dl compact="compact">
|
|
<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
|
|
<dd><p>Successful program execution.
|
|
</p></dd>
|
|
<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
|
|
<dd><p>The operation failed or the command syntax was not valid.
|
|
</p></dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|