1052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2052d159aSCy Schubert<html> 3a466cc55SCy Schubert<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 42b15cb3dSCy Schubert<head> 5052d159aSCy Schubert<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6052d159aSCy Schubert<title>Plot_summary User’s Manual</title> 7052d159aSCy Schubert 8052d159aSCy Schubert<meta name="description" content="Plot_summary User’s Manual"> 9052d159aSCy Schubert<meta name="keywords" content="Plot_summary User’s Manual"> 10052d159aSCy Schubert<meta name="resource-type" content="document"> 11052d159aSCy Schubert<meta name="distribution" content="global"> 12052d159aSCy Schubert<meta name="Generator" content="makeinfo"> 13052d159aSCy Schubert<link href="#Top" rel="start" title="Top"> 14052d159aSCy Schubert<link href="dir.html#Top" rel="up" title="(dir)"> 15052d159aSCy Schubert<style type="text/css"> 16052d159aSCy Schubert<!-- 17052d159aSCy Schuberta.summary-letter {text-decoration: none} 18052d159aSCy Schubertblockquote.indentedblock {margin-right: 0em} 19052d159aSCy Schubertdiv.display {margin-left: 3.2em} 20052d159aSCy Schubertdiv.example {margin-left: 3.2em} 21052d159aSCy Schubertdiv.lisp {margin-left: 3.2em} 22052d159aSCy Schubertkbd {font-style: oblique} 232b15cb3dSCy Schubertpre.display {font-family: inherit} 242b15cb3dSCy Schubertpre.format {font-family: inherit} 25052d159aSCy Schubertpre.menu-comment {font-family: serif} 26052d159aSCy Schubertpre.menu-preformatted {font-family: serif} 27052d159aSCy Schubertspan.nolinebreak {white-space: nowrap} 28052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal} 29052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 30052d159aSCy Schubertul.no-bullet {list-style: none} 31052d159aSCy Schubert--> 32052d159aSCy Schubert</style> 33052d159aSCy Schubert 34052d159aSCy Schubert 352b15cb3dSCy Schubert</head> 36052d159aSCy Schubert 37052d159aSCy Schubert<body lang="en"> 38052d159aSCy Schubert<h1 class="settitle" align="center">Plot_summary User’s Manual</h1> 39052d159aSCy Schubert 40052d159aSCy Schubert 41052d159aSCy Schubert 42052d159aSCy Schubert 43052d159aSCy Schubert 44a466cc55SCy Schubert<span id="Top"></span><div class="header"> 45052d159aSCy Schubert<p> 46052d159aSCy 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> 472b15cb3dSCy Schubert</div> 48a466cc55SCy Schubert<span id="Plot_005fsummary-User-Manual"></span><h1 class="top">Plot_summary User Manual</h1> 492b15cb3dSCy Schubert 50052d159aSCy Schubert<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program. 51*f5f40dd6SCy SchubertThis document applies to version 4.2.8p18 of <code>plot_summary</code>. 52052d159aSCy Schubert</p> 53a466cc55SCy Schubert<span id="SEC_Overview"></span> 54052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 552b15cb3dSCy Schubert 562b15cb3dSCy Schubert<div class="shortcontents"> 57052d159aSCy Schubert<ul class="no-bullet"> 58a466cc55SCy Schubert<li><a id="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li> 592b15cb3dSCy Schubert</ul> 602b15cb3dSCy Schubert</div> 612b15cb3dSCy Schubert 622b15cb3dSCy Schubert 63052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 64a466cc55SCy Schubert<tr><td align="left" valign="top">• plot_summary Description</td><td> </td><td align="left" valign="top">Description 65052d159aSCy Schubert</td></tr> 66a466cc55SCy 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 67052d159aSCy Schubert</td></tr> 68052d159aSCy Schubert</table> 69052d159aSCy Schubert 70052d159aSCy Schubert<hr> 71a466cc55SCy Schubert<span id="plot_005fsummary-Invocation"></span><div class="header"> 72052d159aSCy Schubert<p> 73052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 742b15cb3dSCy Schubert</div> 75a466cc55SCy Schubert<span id="Invoking-plot_005fsummary"></span><h2 class="chapter">1 Invoking plot_summary</h2> 76a466cc55SCy Schubert<span id="index-plot_005fsummary"></span> 77a466cc55SCy Schubert<span id="index-plot-statistics-generated-by-summary-script"></span> 782b15cb3dSCy Schubert 792b15cb3dSCy Schubert 802b15cb3dSCy Schubert<p>This section was generated by <strong>AutoGen</strong>, 812b15cb3dSCy Schubertusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 82052d159aSCy Schubert</p> 83052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 84a466cc55SCy 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>) 85052d159aSCy Schubert</td></tr> 86a466cc55SCy 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 87052d159aSCy Schubert</td></tr> 88a466cc55SCy 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 89052d159aSCy Schubert</td></tr> 90a466cc55SCy 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 91052d159aSCy Schubert</td></tr> 92a466cc55SCy 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 93052d159aSCy Schubert</td></tr> 94a466cc55SCy 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 95052d159aSCy Schubert</td></tr> 96a466cc55SCy 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 97052d159aSCy Schubert</td></tr> 98052d159aSCy Schubert</table> 992b15cb3dSCy Schubert 100052d159aSCy Schubert<hr> 101a466cc55SCy Schubert<span id="plot_005fsummary-usage"></span><div class="header"> 102052d159aSCy Schubert<p> 103052d159aSCy 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> 1042b15cb3dSCy Schubert</div> 105a466cc55SCy 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> 106a466cc55SCy Schubert<span id="index-plot_005fsummary-help"></span> 1072b15cb3dSCy Schubert 108052d159aSCy Schubert<p>This is the automatically generated usage text for plot_summary. 109052d159aSCy Schubert</p> 1102b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 111052d159aSCy Schubert(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 1122b15cb3dSCy Schubertthe usage text by passing it through a pager program. 1132b15cb3dSCy Schubert<code>more-help</code> is disabled on platforms without a working 1142b15cb3dSCy Schubert<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1162b15cb3dSCy Schubertwith a status code of 0. 117052d159aSCy Schubert</p> 118052d159aSCy Schubert<div class="example"> 119*f5f40dd6SCy Schubert<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p18 1202b15cb3dSCy SchubertUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 1212b15cb3dSCy Schubert 1222b15cb3dSCy Schubert --directory=str Where the summary files are 1232b15cb3dSCy Schubert --identifier=str Origin of the data 1242b15cb3dSCy Schubert --offset-limit=float Limit of absolute offset 1252b15cb3dSCy Schubert --peer=str Peers to generate plots for 1262b15cb3dSCy Schubert - may appear multiple times 1272b15cb3dSCy Schubert --plot-term=str Gnuplot terminal 1282b15cb3dSCy Schubert --output-file=str Output file 1292b15cb3dSCy Schubert --dont-wait Don't wait for keystroke between plots 1302b15cb3dSCy Schubert -?, --help Display usage information and exit 1312b15cb3dSCy Schubert --more-help Pass the extended usage text through a pager 1322b15cb3dSCy Schubert 1332b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single 1342b15cb3dSCy Schuberthyphen and the flag character. 135052d159aSCy Schubert</pre></div> 136052d159aSCy Schubert 137052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 138a466cc55SCy 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"> 139052d159aSCy Schubert</td></tr> 140a466cc55SCy 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"> 141052d159aSCy Schubert</td></tr> 142a466cc55SCy 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"> 143052d159aSCy Schubert</td></tr> 144a466cc55SCy 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"> 145052d159aSCy Schubert</td></tr> 146a466cc55SCy 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"> 147052d159aSCy Schubert</td></tr> 148a466cc55SCy 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"> 149052d159aSCy Schubert</td></tr> 150052d159aSCy Schubert</table> 151052d159aSCy Schubert 152052d159aSCy Schubert<hr> 153a466cc55SCy Schubert<span id="plot_005fsummary-directory"></span><div class="header"> 154052d159aSCy Schubert<p> 155052d159aSCy 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> 1562b15cb3dSCy Schubert</div> 157a466cc55SCy Schubert<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 158a466cc55SCy Schubert<span id="index-plot_005fsummary_002ddirectory"></span> 1592b15cb3dSCy Schubert 160052d159aSCy Schubert<p>This is the “where the summary files are” option. 1612b15cb3dSCy SchubertThis option takes a string argument. 1622b15cb3dSCy Schubert The directory where the <code>plot_summary</code> will search for the 1632b15cb3dSCy Schubert *_summary files generated by <code>summary</code> script. 164052d159aSCy Schubert</p><hr> 165a466cc55SCy Schubert<span id="plot_005fsummary-identifier"></span><div class="header"> 166052d159aSCy Schubert<p> 167052d159aSCy 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> 1682b15cb3dSCy Schubert</div> 169a466cc55SCy Schubert<span id="identifier-option"></span><h4 class="subsection">1.1.2 identifier option</h4> 170a466cc55SCy Schubert<span id="index-plot_005fsummary_002didentifier"></span> 1712b15cb3dSCy Schubert 172052d159aSCy Schubert<p>This is the “origin of the data” option. 1732b15cb3dSCy SchubertThis option takes a string argument. 174052d159aSCy Schubert Where does the plotted data come from, default to string "host" plus 1752b15cb3dSCy Schubert current hostname 176052d159aSCy Schubert</p><hr> 177a466cc55SCy Schubert<span id="plot_005fsummary-peer"></span><div class="header"> 178052d159aSCy Schubert<p> 179052d159aSCy 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> 1802b15cb3dSCy Schubert</div> 181a466cc55SCy Schubert<span id="peer-option"></span><h4 class="subsection">1.1.3 peer option</h4> 182a466cc55SCy Schubert<span id="index-plot_005fsummary_002dpeer"></span> 1832b15cb3dSCy Schubert 184052d159aSCy Schubert<p>This is the “peers to generate plots for” option. 1852b15cb3dSCy SchubertThis option takes a string argument. 186052d159aSCy Schubert</p> 187052d159aSCy Schubert<p>This option has some usage constraints. It: 188052d159aSCy Schubert</p><ul> 1892b15cb3dSCy Schubert<li> may appear an unlimited number of times. 190052d159aSCy Schubert</li></ul> 1912b15cb3dSCy Schubert 1922b15cb3dSCy Schubert<p>By default the peer_summary plots are not generated. Use this option to 1932b15cb3dSCy Schubert specify list of peers if you want to generate plots for them. 194052d159aSCy Schubert</p><hr> 195a466cc55SCy Schubert<span id="plot_005fsummary-plot_002dterm"></span><div class="header"> 196052d159aSCy Schubert<p> 197052d159aSCy 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> 1982b15cb3dSCy Schubert</div> 199a466cc55SCy Schubert<span id="plot_002dterm-option"></span><h4 class="subsection">1.1.4 plot-term option</h4> 200a466cc55SCy Schubert<span id="index-plot_005fsummary_002dplot_002dterm"></span> 2012b15cb3dSCy Schubert 202052d159aSCy Schubert<p>This is the “gnuplot terminal” option. 2032b15cb3dSCy SchubertThis option takes a string argument. 2042b15cb3dSCy Schubert This is string is passed directly to the <code>gnuplot set terminal</code> 2052b15cb3dSCy Schubert command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 206052d159aSCy Schubert <code>dumb</code> is it’s not’. See output from (gnuplot -e "set 207052d159aSCy Schubert terminal") for the list of available options. 208052d159aSCy Schubert</p><hr> 209a466cc55SCy Schubert<span id="plot_005fsummary-output_002dfile"></span><div class="header"> 210052d159aSCy Schubert<p> 211052d159aSCy 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> 2122b15cb3dSCy Schubert</div> 213a466cc55SCy Schubert<span id="output_002dfile-option"></span><h4 class="subsection">1.1.5 output-file option</h4> 214a466cc55SCy Schubert<span id="index-plot_005fsummary_002doutput_002dfile"></span> 2152b15cb3dSCy Schubert 216052d159aSCy Schubert<p>This is the “output file” option. 2172b15cb3dSCy SchubertThis option takes a str argument. 2182b15cb3dSCy Schubert Output file for <code>gnuplot</code>, default to stdout. 219052d159aSCy Schubert</p><hr> 220a466cc55SCy Schubert<span id="plot_005fsummary-exit-status"></span><div class="header"> 221052d159aSCy Schubert<p> 222052d159aSCy 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> 2232b15cb3dSCy Schubert</div> 224a466cc55SCy Schubert<span id="plot_005fsummary-exit-status-1"></span><h4 class="subsection">1.1.6 plot_summary exit status</h4> 2252b15cb3dSCy Schubert 2262b15cb3dSCy Schubert<p>One of the following exit values will be returned: 227052d159aSCy Schubert</p><dl compact="compact"> 228052d159aSCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 229052d159aSCy Schubert<dd><p>Successful program execution. 230052d159aSCy Schubert</p></dd> 231052d159aSCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 232052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid. 233052d159aSCy Schubert</p></dd> 2342b15cb3dSCy Schubert</dl> 235052d159aSCy Schubert<hr> 2362b15cb3dSCy Schubert 2372b15cb3dSCy Schubert 238052d159aSCy Schubert 239052d159aSCy Schubert</body> 240052d159aSCy Schubert</html> 241