1052d159aSCy Schubert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2052d159aSCy Schubert<html> 3052d159aSCy Schubert<!-- Created by GNU Texinfo 6.5, 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 Schubertblockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 20052d159aSCy Schubertblockquote.smallquotation {font-size: smaller} 21052d159aSCy Schubertdiv.display {margin-left: 3.2em} 22052d159aSCy Schubertdiv.example {margin-left: 3.2em} 23052d159aSCy Schubertdiv.lisp {margin-left: 3.2em} 24052d159aSCy Schubertdiv.smalldisplay {margin-left: 3.2em} 25052d159aSCy Schubertdiv.smallexample {margin-left: 3.2em} 26052d159aSCy Schubertdiv.smalllisp {margin-left: 3.2em} 27052d159aSCy Schubertkbd {font-style: oblique} 282b15cb3dSCy Schubertpre.display {font-family: inherit} 292b15cb3dSCy Schubertpre.format {font-family: inherit} 30052d159aSCy Schubertpre.menu-comment {font-family: serif} 31052d159aSCy Schubertpre.menu-preformatted {font-family: serif} 322b15cb3dSCy Schubertpre.smalldisplay {font-family: inherit; font-size: smaller} 332b15cb3dSCy Schubertpre.smallexample {font-size: smaller} 34052d159aSCy Schubertpre.smallformat {font-family: inherit; font-size: smaller} 352b15cb3dSCy Schubertpre.smalllisp {font-size: smaller} 36052d159aSCy Schubertspan.nolinebreak {white-space: nowrap} 37052d159aSCy Schubertspan.roman {font-family: initial; font-weight: normal} 38052d159aSCy Schubertspan.sansserif {font-family: sans-serif; font-weight: normal} 39052d159aSCy Schubertul.no-bullet {list-style: none} 40052d159aSCy Schubert--> 41052d159aSCy Schubert</style> 42052d159aSCy Schubert 43052d159aSCy Schubert 442b15cb3dSCy Schubert</head> 45052d159aSCy Schubert 46052d159aSCy Schubert<body lang="en"> 47052d159aSCy Schubert<h1 class="settitle" align="center">Plot_summary User’s Manual</h1> 48052d159aSCy Schubert 49052d159aSCy Schubert 50052d159aSCy Schubert 51052d159aSCy Schubert 52052d159aSCy Schubert 53052d159aSCy Schubert<a name="Top"></a> 54052d159aSCy Schubert<div class="header"> 55052d159aSCy Schubert<p> 56052d159aSCy 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> 572b15cb3dSCy Schubert</div> 58052d159aSCy Schubert<a name="Plot_005fsummary-User-Manual"></a> 59052d159aSCy Schubert<h1 class="top">Plot_summary User Manual</h1> 602b15cb3dSCy Schubert 61052d159aSCy Schubert<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program. 62052d159aSCy SchubertThis document applies to version 4.2.8p13 of <code>plot_summary</code>. 63052d159aSCy Schubert</p> 64052d159aSCy Schubert<a name="SEC_Overview"></a> 65052d159aSCy Schubert<h2 class="shortcontents-heading">Short Table of Contents</h2> 662b15cb3dSCy Schubert 672b15cb3dSCy Schubert<div class="shortcontents"> 68052d159aSCy Schubert<ul class="no-bullet"> 69052d159aSCy 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 74052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 75052d159aSCy Schubert<tr><td align="left" valign="top">• plot_summary Description:</td><td> </td><td align="left" valign="top">Description 76052d159aSCy Schubert</td></tr> 77052d159aSCy 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 78052d159aSCy Schubert</td></tr> 79052d159aSCy Schubert</table> 80052d159aSCy Schubert 81052d159aSCy Schubert<hr> 82052d159aSCy Schubert<a name="plot_005fsummary-Invocation"></a> 83052d159aSCy Schubert<div class="header"> 84052d159aSCy Schubert<p> 85052d159aSCy SchubertUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 862b15cb3dSCy Schubert</div> 87052d159aSCy Schubert<a name="Invoking-plot_005fsummary"></a> 88052d159aSCy Schubert<h2 class="chapter">1 Invoking plot_summary</h2> 89052d159aSCy Schubert<a name="index-plot_005fsummary"></a> 90052d159aSCy 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. 95052d159aSCy Schubert</p> 96052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 97052d159aSCy 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>) 98052d159aSCy Schubert</td></tr> 99052d159aSCy 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 100052d159aSCy Schubert</td></tr> 101052d159aSCy 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 102052d159aSCy Schubert</td></tr> 103052d159aSCy 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 104052d159aSCy Schubert</td></tr> 105052d159aSCy 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 106052d159aSCy Schubert</td></tr> 107052d159aSCy 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 108052d159aSCy Schubert</td></tr> 109052d159aSCy 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 110052d159aSCy Schubert</td></tr> 111052d159aSCy Schubert</table> 1122b15cb3dSCy Schubert 113052d159aSCy Schubert<hr> 114052d159aSCy Schubert<a name="plot_005fsummary-usage"></a> 115052d159aSCy Schubert<div class="header"> 116052d159aSCy Schubert<p> 117052d159aSCy 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> 1182b15cb3dSCy Schubert</div> 119052d159aSCy Schubert<a name="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></a> 120052d159aSCy Schubert<h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3> 121052d159aSCy Schubert<a name="index-plot_005fsummary-help"></a> 1222b15cb3dSCy Schubert 123052d159aSCy Schubert<p>This is the automatically generated usage text for plot_summary. 124052d159aSCy Schubert</p> 1252b15cb3dSCy Schubert<p>The text printed is the same whether selected with the <code>help</code> option 126052d159aSCy 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 130052d159aSCy Schubertused to select the program, defaulting to <samp>more</samp>. Both will exit 1312b15cb3dSCy Schubertwith a status code of 0. 132052d159aSCy Schubert</p> 133052d159aSCy Schubert<div class="example"> 134052d159aSCy Schubert<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p13 1352b15cb3dSCy SchubertUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 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. 150052d159aSCy Schubert</pre></div> 151052d159aSCy Schubert 152052d159aSCy Schubert<table class="menu" border="0" cellspacing="0"> 153052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">plot_summary directory</a>:</td><td> </td><td align="left" valign="top"> 154052d159aSCy Schubert</td></tr> 155052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">plot_summary identifier</a>:</td><td> </td><td align="left" valign="top"> 156052d159aSCy Schubert</td></tr> 157052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">plot_summary peer</a>:</td><td> </td><td align="left" valign="top"> 158052d159aSCy Schubert</td></tr> 159052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-plot_002dterm" accesskey="4">plot_summary plot-term</a>:</td><td> </td><td align="left" valign="top"> 160052d159aSCy Schubert</td></tr> 161052d159aSCy Schubert<tr><td align="left" valign="top">• <a href="#plot_005fsummary-output_002dfile" accesskey="5">plot_summary output-file</a>:</td><td> </td><td align="left" valign="top"> 162052d159aSCy Schubert</td></tr> 163052d159aSCy 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"> 164052d159aSCy Schubert</td></tr> 165052d159aSCy Schubert</table> 166052d159aSCy Schubert 167052d159aSCy Schubert<hr> 168052d159aSCy Schubert<a name="plot_005fsummary-directory"></a> 169052d159aSCy Schubert<div class="header"> 170052d159aSCy Schubert<p> 171052d159aSCy 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> 1722b15cb3dSCy Schubert</div> 173052d159aSCy Schubert<a name="directory-option"></a> 174052d159aSCy Schubert<h4 class="subsection">1.1.1 directory option</h4> 175052d159aSCy Schubert<a name="index-plot_005fsummary_002ddirectory"></a> 1762b15cb3dSCy Schubert 177052d159aSCy Schubert<p>This is the “where the summary files are” 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. 181052d159aSCy Schubert</p><hr> 182052d159aSCy Schubert<a name="plot_005fsummary-identifier"></a> 183052d159aSCy Schubert<div class="header"> 184052d159aSCy Schubert<p> 185052d159aSCy 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> 1862b15cb3dSCy Schubert</div> 187052d159aSCy Schubert<a name="identifier-option"></a> 188052d159aSCy Schubert<h4 class="subsection">1.1.2 identifier option</h4> 189052d159aSCy Schubert<a name="index-plot_005fsummary_002didentifier"></a> 1902b15cb3dSCy Schubert 191052d159aSCy Schubert<p>This is the “origin of the data” option. 1922b15cb3dSCy SchubertThis option takes a string argument. 193052d159aSCy Schubert Where does the plotted data come from, default to string "host" plus 1942b15cb3dSCy Schubert current hostname 195052d159aSCy Schubert</p><hr> 196052d159aSCy Schubert<a name="plot_005fsummary-peer"></a> 197052d159aSCy Schubert<div class="header"> 198052d159aSCy Schubert<p> 199052d159aSCy 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> 2002b15cb3dSCy Schubert</div> 201052d159aSCy Schubert<a name="peer-option"></a> 202052d159aSCy Schubert<h4 class="subsection">1.1.3 peer option</h4> 203052d159aSCy Schubert<a name="index-plot_005fsummary_002dpeer"></a> 2042b15cb3dSCy Schubert 205052d159aSCy Schubert<p>This is the “peers to generate plots for” option. 2062b15cb3dSCy SchubertThis option takes a string argument. 207052d159aSCy Schubert</p> 208052d159aSCy Schubert<p>This option has some usage constraints. It: 209052d159aSCy Schubert</p><ul> 2102b15cb3dSCy Schubert<li> may appear an unlimited number of times. 211052d159aSCy 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. 215052d159aSCy Schubert</p><hr> 216052d159aSCy Schubert<a name="plot_005fsummary-plot_002dterm"></a> 217052d159aSCy Schubert<div class="header"> 218052d159aSCy Schubert<p> 219052d159aSCy 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> 2202b15cb3dSCy Schubert</div> 221052d159aSCy Schubert<a name="plot_002dterm-option"></a> 222052d159aSCy Schubert<h4 class="subsection">1.1.4 plot-term option</h4> 223052d159aSCy Schubert<a name="index-plot_005fsummary_002dplot_002dterm"></a> 2242b15cb3dSCy Schubert 225052d159aSCy Schubert<p>This is the “gnuplot terminal” 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 229052d159aSCy Schubert <code>dumb</code> is it’s not’. See output from (gnuplot -e "set 230052d159aSCy Schubert terminal") for the list of available options. 231052d159aSCy Schubert</p><hr> 232052d159aSCy Schubert<a name="plot_005fsummary-output_002dfile"></a> 233052d159aSCy Schubert<div class="header"> 234052d159aSCy Schubert<p> 235052d159aSCy 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> 2362b15cb3dSCy Schubert</div> 237052d159aSCy Schubert<a name="output_002dfile-option"></a> 238052d159aSCy Schubert<h4 class="subsection">1.1.5 output-file option</h4> 239052d159aSCy Schubert<a name="index-plot_005fsummary_002doutput_002dfile"></a> 2402b15cb3dSCy Schubert 241052d159aSCy Schubert<p>This is the “output file” option. 2422b15cb3dSCy SchubertThis option takes a str argument. 2432b15cb3dSCy Schubert Output file for <code>gnuplot</code>, default to stdout. 244052d159aSCy Schubert</p><hr> 245052d159aSCy Schubert<a name="plot_005fsummary-exit-status"></a> 246052d159aSCy Schubert<div class="header"> 247052d159aSCy Schubert<p> 248052d159aSCy 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> 2492b15cb3dSCy Schubert</div> 250052d159aSCy Schubert<a name="plot_005fsummary-exit-status-1"></a> 251052d159aSCy 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: 254052d159aSCy Schubert</p><dl compact="compact"> 255052d159aSCy Schubert<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 256052d159aSCy Schubert<dd><p>Successful program execution. 257052d159aSCy Schubert</p></dd> 258052d159aSCy Schubert<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 259052d159aSCy Schubert<dd><p>The operation failed or the command syntax was not valid. 260052d159aSCy Schubert</p></dd> 2612b15cb3dSCy Schubert</dl> 262052d159aSCy Schubert<hr> 2632b15cb3dSCy Schubert 2642b15cb3dSCy Schubert 265052d159aSCy Schubert 266052d159aSCy Schubert</body> 267052d159aSCy Schubert</html> 268