1360c0146SCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2360c0146SCy Schubert<html> 326fd3d56SCy Schubert<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 4b5e14a13SCy Schubert<head> 5360c0146SCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6360c0146SCy Schubert<title>Plot_summary User’s Manual</title> 7360c0146SCy Schubert 8360c0146SCy Schubert<meta name="description" content="Plot_summary User’s Manual"> 9360c0146SCy Schubert<meta name="keywords" content="Plot_summary User’s Manual"> 10360c0146SCy Schubert<meta name="resource-type" content="document"> 11360c0146SCy Schubert<meta name="distribution" content="global"> 12360c0146SCy Schubert<meta name="Generator" content="makeinfo"> 13360c0146SCy Schubert<link href="#Top" rel="start" title="Top"> 14360c0146SCy Schubert<link href="dir.html#Top" rel="up" title="(dir)"> 15360c0146SCy Schubert<style type="text/css"> 16360c0146SCy Schubert<!-- 17360c0146SCy Schuberta.summary-letter {text-decoration: none} 18360c0146SCy Schubertblockquote.indentedblock {margin-right: 0em} 19360c0146SCy Schubertdiv.display {margin-left: 3.2em} 20360c0146SCy Schubertdiv.example {margin-left: 3.2em} 21360c0146SCy Schubertdiv.lisp {margin-left: 3.2em} 22360c0146SCy Schubertkbd {font-style: oblique} 23b5e14a13SCy Schubertpre.display {font-family: inherit} 24b5e14a13SCy Schubertpre.format {font-family: inherit} 25360c0146SCy Schubertpre.menu-comment {font-family: serif} 26360c0146SCy Schubertpre.menu-preformatted {font-family: serif} 27360c0146SCy Schubertspan.nolinebreak {white-space: nowrap} 28360c0146SCy Schubertspan.roman {font-family: initial; font-weight: normal} 29360c0146SCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 30360c0146SCy Schubertul.no-bullet {list-style: none} 31360c0146SCy Schubert--> 32360c0146SCy Schubert</style> 33360c0146SCy Schubert 34360c0146SCy Schubert 35b5e14a13SCy Schubert</head> 36360c0146SCy Schubert 37360c0146SCy Schubert<body lang="en"> 38360c0146SCy Schubert<h1 class="settitle" align="center">Plot_summary User’s Manual</h1> 39360c0146SCy Schubert 40360c0146SCy Schubert 41360c0146SCy Schubert 42360c0146SCy Schubert 43360c0146SCy Schubert 4426fd3d56SCy Schubert<span id="Top"></span><div class="header"> 45360c0146SCy Schubert<p> 46360c0146SCy SchubertPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 47b5e14a13SCy Schubert</div> 4826fd3d56SCy Schubert<span id="Plot_005fsummary-User-Manual"></span><h1 class="top">Plot_summary User Manual</h1> 49b5e14a13SCy Schubert 50360c0146SCy Schubert<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program. 511f833b3fSCy SchubertThis document applies to version 4.2.8p18 of <code>plot_summary</code>. 52360c0146SCy Schubert</p> 5326fd3d56SCy Schubert<span id="SEC_Overview"></span> 54360c0146SCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 55b5e14a13SCy Schubert 56b5e14a13SCy Schubert<div class="shortcontents"> 57360c0146SCy Schubert<ul class="no-bullet"> 5826fd3d56SCy Schubert<li><a id="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li> 59b5e14a13SCy Schubert</ul> 60b5e14a13SCy Schubert</div> 61b5e14a13SCy Schubert 62b5e14a13SCy Schubert 63360c0146SCy Schubert<table class="menu" border="0" cellspacing="0"> 6426fd3d56SCy Schubert<tr><td align="left" valign="top">• plot_summary Description</td><td> </td><td align="left" valign="top">Description 65360c0146SCy Schubert</td></tr> 6626fd3d56SCy Schubert<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 67360c0146SCy Schubert</td></tr> 68360c0146SCy Schubert</table> 69360c0146SCy Schubert 70360c0146SCy Schubert<hr> 7126fd3d56SCy Schubert<span id="plot_005fsummary-Invocation"></span><div class="header"> 72360c0146SCy Schubert<p> 73360c0146SCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 74b5e14a13SCy Schubert</div> 7526fd3d56SCy Schubert<span id="Invoking-plot_005fsummary"></span><h2 class="chapter">1 Invoking plot_summary</h2> 7626fd3d56SCy Schubert<span id="index-plot_005fsummary"></span> 7726fd3d56SCy Schubert<span id="index-plot-statistics-generated-by-summary-script"></span> 78b5e14a13SCy Schubert 79b5e14a13SCy Schubert 80b5e14a13SCy Schubert<p>This section was generated by <strong>AutoGen</strong>, 81b5e14a13SCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 82360c0146SCy Schubert</p> 83360c0146SCy Schubert<table class="menu" border="0" cellspacing="0"> 8426fd3d56SCy Schubert<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>) 85360c0146SCy Schubert</td></tr> 8626fd3d56SCy Schubert<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 87360c0146SCy Schubert</td></tr> 8826fd3d56SCy Schubert<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 89360c0146SCy Schubert</td></tr> 9026fd3d56SCy Schubert<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 91360c0146SCy Schubert</td></tr> 9226fd3d56SCy Schubert<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 93360c0146SCy Schubert</td></tr> 9426fd3d56SCy Schubert<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 95360c0146SCy Schubert</td></tr> 9626fd3d56SCy Schubert<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 97360c0146SCy Schubert</td></tr> 98360c0146SCy Schubert</table> 99b5e14a13SCy Schubert 100360c0146SCy Schubert<hr> 10126fd3d56SCy Schubert<span id="plot_005fsummary-usage"></span><div class="header"> 102360c0146SCy Schubert<p> 103360c0146SCy 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> </p> 104b5e14a13SCy Schubert</div> 10526fd3d56SCy Schubert<span id="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3> 10626fd3d56SCy Schubert<span id="index-plot_005fsummary-help"></span> 107b5e14a13SCy Schubert 108360c0146SCy Schubert<p>This is the automatically generated usage text for plot_summary. 109360c0146SCy Schubert</p> 110b5e14a13SCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 111360c0146SCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 112b5e14a13SCy Schubertthe usage text by passing it through a pager program. 113b5e14a13SCy Schubert<code>more-help</code> is disabled on platforms without a working 114b5e14a13SCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115360c0146SCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 116b5e14a13SCy Schubertwith a status code of 0. 117360c0146SCy Schubert</p> 118360c0146SCy Schubert<div class="example"> 1191f833b3fSCy Schubert<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p18 120b5e14a13SCy SchubertUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 121b5e14a13SCy Schubert 122b5e14a13SCy Schubert --directory=str Where the summary files are 123b5e14a13SCy Schubert --identifier=str Origin of the data 124b5e14a13SCy Schubert --offset-limit=float Limit of absolute offset 125b5e14a13SCy Schubert --peer=str Peers to generate plots for 126b5e14a13SCy Schubert - may appear multiple times 127b5e14a13SCy Schubert --plot-term=str Gnuplot terminal 128b5e14a13SCy Schubert --output-file=str Output file 129b5e14a13SCy Schubert --dont-wait Don't wait for keystroke between plots 130b5e14a13SCy Schubert -?, --help Display usage information and exit 131b5e14a13SCy Schubert --more-help Pass the extended usage text through a pager 132b5e14a13SCy Schubert 133b5e14a13SCy SchubertOptions are specified by doubled hyphens and their name or by a single 134b5e14a13SCy Schuberthyphen and the flag character. 135360c0146SCy Schubert</pre></div> 136360c0146SCy Schubert 137360c0146SCy Schubert<table class="menu" border="0" cellspacing="0"> 13826fd3d56SCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> 139360c0146SCy Schubert</td></tr> 14026fd3d56SCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">identifier option</a></td><td> </td><td align="left" valign="top"> 141360c0146SCy Schubert</td></tr> 14226fd3d56SCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">peer option</a></td><td> </td><td align="left" valign="top"> 143360c0146SCy Schubert</td></tr> 14426fd3d56SCy Schubert<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"> 145360c0146SCy Schubert</td></tr> 14626fd3d56SCy Schubert<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"> 147360c0146SCy Schubert</td></tr> 14826fd3d56SCy Schubert<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"> 149360c0146SCy Schubert</td></tr> 150360c0146SCy Schubert</table> 151360c0146SCy Schubert 152360c0146SCy Schubert<hr> 15326fd3d56SCy Schubert<span id="plot_005fsummary-directory"></span><div class="header"> 154360c0146SCy Schubert<p> 155360c0146SCy 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> </p> 156b5e14a13SCy Schubert</div> 15726fd3d56SCy Schubert<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 15826fd3d56SCy Schubert<span id="index-plot_005fsummary_002ddirectory"></span> 159b5e14a13SCy Schubert 160360c0146SCy Schubert<p>This is the “where the summary files are” option. 161b5e14a13SCy SchubertThis option takes a string argument. 162b5e14a13SCy Schubert The directory where the <code>plot_summary</code> will search for the 163b5e14a13SCy Schubert *_summary files generated by <code>summary</code> script. 164360c0146SCy Schubert</p><hr> 16526fd3d56SCy Schubert<span id="plot_005fsummary-identifier"></span><div class="header"> 166360c0146SCy Schubert<p> 167360c0146SCy 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> </p> 168b5e14a13SCy Schubert</div> 16926fd3d56SCy Schubert<span id="identifier-option"></span><h4 class="subsection">1.1.2 identifier option</h4> 17026fd3d56SCy Schubert<span id="index-plot_005fsummary_002didentifier"></span> 171b5e14a13SCy Schubert 172360c0146SCy Schubert<p>This is the “origin of the data” option. 173b5e14a13SCy SchubertThis option takes a string argument. 174360c0146SCy Schubert Where does the plotted data come from, default to string "host" plus 175b5e14a13SCy Schubert current hostname 176360c0146SCy Schubert</p><hr> 17726fd3d56SCy Schubert<span id="plot_005fsummary-peer"></span><div class="header"> 178360c0146SCy Schubert<p> 179360c0146SCy 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> </p> 180b5e14a13SCy Schubert</div> 18126fd3d56SCy Schubert<span id="peer-option"></span><h4 class="subsection">1.1.3 peer option</h4> 18226fd3d56SCy Schubert<span id="index-plot_005fsummary_002dpeer"></span> 183b5e14a13SCy Schubert 184360c0146SCy Schubert<p>This is the “peers to generate plots for” option. 185b5e14a13SCy SchubertThis option takes a string argument. 186360c0146SCy Schubert</p> 187360c0146SCy Schubert<p>This option has some usage constraints. It: 188360c0146SCy Schubert</p><ul> 189b5e14a13SCy Schubert<li> may appear an unlimited number of times. 190360c0146SCy Schubert</li></ul> 191b5e14a13SCy Schubert 192b5e14a13SCy Schubert<p>By default the peer_summary plots are not generated. Use this option to 193b5e14a13SCy Schubert specify list of peers if you want to generate plots for them. 194360c0146SCy Schubert</p><hr> 19526fd3d56SCy Schubert<span id="plot_005fsummary-plot_002dterm"></span><div class="header"> 196360c0146SCy Schubert<p> 197360c0146SCy 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> </p> 198b5e14a13SCy Schubert</div> 19926fd3d56SCy Schubert<span id="plot_002dterm-option"></span><h4 class="subsection">1.1.4 plot-term option</h4> 20026fd3d56SCy Schubert<span id="index-plot_005fsummary_002dplot_002dterm"></span> 201b5e14a13SCy Schubert 202360c0146SCy Schubert<p>This is the “gnuplot terminal” option. 203b5e14a13SCy SchubertThis option takes a string argument. 204b5e14a13SCy Schubert This is string is passed directly to the <code>gnuplot set terminal</code> 205b5e14a13SCy Schubert command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 206360c0146SCy Schubert <code>dumb</code> is it’s not’. See output from (gnuplot -e "set 207360c0146SCy Schubert terminal") for the list of available options. 208360c0146SCy Schubert</p><hr> 20926fd3d56SCy Schubert<span id="plot_005fsummary-output_002dfile"></span><div class="header"> 210360c0146SCy Schubert<p> 211360c0146SCy 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> </p> 212b5e14a13SCy Schubert</div> 21326fd3d56SCy Schubert<span id="output_002dfile-option"></span><h4 class="subsection">1.1.5 output-file option</h4> 21426fd3d56SCy Schubert<span id="index-plot_005fsummary_002doutput_002dfile"></span> 215b5e14a13SCy Schubert 216360c0146SCy Schubert<p>This is the “output file” option. 217b5e14a13SCy SchubertThis option takes a str argument. 218b5e14a13SCy Schubert Output file for <code>gnuplot</code>, default to stdout. 219360c0146SCy Schubert</p><hr> 22026fd3d56SCy Schubert<span id="plot_005fsummary-exit-status"></span><div class="header"> 221360c0146SCy Schubert<p> 222360c0146SCy 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> </p> 223b5e14a13SCy Schubert</div> 22426fd3d56SCy Schubert<span id="plot_005fsummary-exit-status-1"></span><h4 class="subsection">1.1.6 plot_summary exit status</h4> 225b5e14a13SCy Schubert 226b5e14a13SCy Schubert<p>One of the following exit values will be returned: 227360c0146SCy Schubert</p><dl compact="compact"> 228360c0146SCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 229360c0146SCy Schubert<dd><p>Successful program execution. 230360c0146SCy Schubert</p></dd> 231360c0146SCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 232360c0146SCy Schubert<dd><p>The operation failed or the command syntax was not valid. 233360c0146SCy Schubert</p></dd> 234b5e14a13SCy Schubert</dl> 235360c0146SCy Schubert<hr> 236b5e14a13SCy Schubert 237b5e14a13SCy Schubert 238360c0146SCy Schubert 239360c0146SCy Schubert</body> 240360c0146SCy Schubert</html> 241