1067f5680Schristos<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2067f5680Schristos<html> 3*897be3a4Schristos<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ --> 48585484eSchristos<head> 5067f5680Schristos<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6067f5680Schristos<title>Plot_summary User’s Manual</title> 7067f5680Schristos 8067f5680Schristos<meta name="description" content="Plot_summary User’s Manual"> 9067f5680Schristos<meta name="keywords" content="Plot_summary User’s Manual"> 10067f5680Schristos<meta name="resource-type" content="document"> 11067f5680Schristos<meta name="distribution" content="global"> 12067f5680Schristos<meta name="Generator" content="makeinfo"> 13067f5680Schristos<link href="#Top" rel="start" title="Top"> 14067f5680Schristos<link href="dir.html#Top" rel="up" title="(dir)"> 15067f5680Schristos<style type="text/css"> 16067f5680Schristos<!-- 17067f5680Schristosa.summary-letter {text-decoration: none} 18067f5680Schristosblockquote.indentedblock {margin-right: 0em} 19067f5680Schristosdiv.display {margin-left: 3.2em} 20067f5680Schristosdiv.example {margin-left: 3.2em} 21067f5680Schristosdiv.lisp {margin-left: 3.2em} 22067f5680Schristoskbd {font-style: oblique} 238585484eSchristospre.display {font-family: inherit} 248585484eSchristospre.format {font-family: inherit} 25067f5680Schristospre.menu-comment {font-family: serif} 26067f5680Schristospre.menu-preformatted {font-family: serif} 27067f5680Schristosspan.nolinebreak {white-space: nowrap} 28067f5680Schristosspan.roman {font-family: initial; font-weight: normal} 29067f5680Schristosspan.sansserif {font-family: sans-serif; font-weight: normal} 30067f5680Schristosul.no-bullet {list-style: none} 31067f5680Schristos--> 32067f5680Schristos</style> 33067f5680Schristos 34067f5680Schristos 358585484eSchristos</head> 36067f5680Schristos 37067f5680Schristos<body lang="en"> 38067f5680Schristos<h1 class="settitle" align="center">Plot_summary User’s Manual</h1> 39067f5680Schristos 40067f5680Schristos 41067f5680Schristos 42067f5680Schristos 43067f5680Schristos 44*897be3a4Schristos<span id="Top"></span><div class="header"> 45067f5680Schristos<p> 46067f5680SchristosPrevious: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> 478585484eSchristos</div> 48*897be3a4Schristos<span id="Plot_005fsummary-User-Manual"></span><h1 class="top">Plot_summary User Manual</h1> 498585484eSchristos 50067f5680Schristos<p>This document describes the use of the NTP Project’s <code>plot_summary</code> program. 51*897be3a4SchristosThis document applies to version 4.2.8p18 of <code>plot_summary</code>. 52067f5680Schristos</p> 53*897be3a4Schristos<span id="SEC_Overview"></span> 54067f5680Schristos<h2 class="shortcontents-heading">Short Table of Contents</h2> 558585484eSchristos 568585484eSchristos<div class="shortcontents"> 57067f5680Schristos<ul class="no-bullet"> 58*897be3a4Schristos<li><a id="stoc-Invoking-plot_005fsummary" href="#toc-Invoking-plot_005fsummary">1 Invoking plot_summary</a></li> 598585484eSchristos</ul> 608585484eSchristos</div> 618585484eSchristos 628585484eSchristos 63067f5680Schristos<table class="menu" border="0" cellspacing="0"> 64*897be3a4Schristos<tr><td align="left" valign="top">• plot_summary Description</td><td> </td><td align="left" valign="top">Description 65067f5680Schristos</td></tr> 66*897be3a4Schristos<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 67067f5680Schristos</td></tr> 68067f5680Schristos</table> 69067f5680Schristos 70067f5680Schristos<hr> 71*897be3a4Schristos<span id="plot_005fsummary-Invocation"></span><div class="header"> 72067f5680Schristos<p> 73067f5680SchristosUp: <a href="#Top" accesskey="u" rel="up">Top</a> </p> 748585484eSchristos</div> 75*897be3a4Schristos<span id="Invoking-plot_005fsummary"></span><h2 class="chapter">1 Invoking plot_summary</h2> 76*897be3a4Schristos<span id="index-plot_005fsummary"></span> 77*897be3a4Schristos<span id="index-plot-statistics-generated-by-summary-script"></span> 788585484eSchristos 798585484eSchristos 808585484eSchristos<p>This section was generated by <strong>AutoGen</strong>, 818585484eSchristosusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 82067f5680Schristos</p> 83067f5680Schristos<table class="menu" border="0" cellspacing="0"> 84*897be3a4Schristos<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>) 85067f5680Schristos</td></tr> 86*897be3a4Schristos<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 87067f5680Schristos</td></tr> 88*897be3a4Schristos<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 89067f5680Schristos</td></tr> 90*897be3a4Schristos<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 91067f5680Schristos</td></tr> 92*897be3a4Schristos<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 93067f5680Schristos</td></tr> 94*897be3a4Schristos<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 95067f5680Schristos</td></tr> 96*897be3a4Schristos<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 97067f5680Schristos</td></tr> 98067f5680Schristos</table> 998585484eSchristos 100067f5680Schristos<hr> 101*897be3a4Schristos<span id="plot_005fsummary-usage"></span><div class="header"> 102067f5680Schristos<p> 103067f5680SchristosNext: <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> 1048585484eSchristos</div> 105*897be3a4Schristos<span id="plot_005fsummary-help_002fusage-_0028_002d_002dhelp_0029"></span><h3 class="section">1.1 plot_summary help/usage (<samp>--help</samp>)</h3> 106*897be3a4Schristos<span id="index-plot_005fsummary-help"></span> 1078585484eSchristos 108067f5680Schristos<p>This is the automatically generated usage text for plot_summary. 109067f5680Schristos</p> 1108585484eSchristos<p>The text printed is the same whether selected with the <code>help</code> option 111067f5680Schristos(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print 1128585484eSchristosthe usage text by passing it through a pager program. 1138585484eSchristos<code>more-help</code> is disabled on platforms without a working 1148585484eSchristos<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 115067f5680Schristosused to select the program, defaulting to <samp>more</samp>. Both will exit 1168585484eSchristoswith a status code of 0. 117067f5680Schristos</p> 118067f5680Schristos<div class="example"> 119*897be3a4Schristos<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p18 1208585484eSchristosUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 1218585484eSchristos 122b8ecfcfeSchristos --directory=str Where the summary files are 123b8ecfcfeSchristos --identifier=str Origin of the data 124b8ecfcfeSchristos --offset-limit=float Limit of absolute offset 125b8ecfcfeSchristos --peer=str Peers to generate plots for 1268585484eSchristos - may appear multiple times 127b8ecfcfeSchristos --plot-term=str Gnuplot terminal 128b8ecfcfeSchristos --output-file=str Output file 129b8ecfcfeSchristos --dont-wait Don't wait for keystroke between plots 1308585484eSchristos -?, --help Display usage information and exit 131b8ecfcfeSchristos --more-help Pass the extended usage text through a pager 1328585484eSchristos 1338585484eSchristosOptions are specified by doubled hyphens and their name or by a single 1348585484eSchristoshyphen and the flag character. 135067f5680Schristos</pre></div> 136067f5680Schristos 137067f5680Schristos<table class="menu" border="0" cellspacing="0"> 138*897be3a4Schristos<tr><td align="left" valign="top">• <a href="#plot_005fsummary-directory" accesskey="1">directory option</a></td><td> </td><td align="left" valign="top"> 139067f5680Schristos</td></tr> 140*897be3a4Schristos<tr><td align="left" valign="top">• <a href="#plot_005fsummary-identifier" accesskey="2">identifier option</a></td><td> </td><td align="left" valign="top"> 141067f5680Schristos</td></tr> 142*897be3a4Schristos<tr><td align="left" valign="top">• <a href="#plot_005fsummary-peer" accesskey="3">peer option</a></td><td> </td><td align="left" valign="top"> 143067f5680Schristos</td></tr> 144*897be3a4Schristos<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"> 145067f5680Schristos</td></tr> 146*897be3a4Schristos<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"> 147067f5680Schristos</td></tr> 148*897be3a4Schristos<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"> 149067f5680Schristos</td></tr> 150067f5680Schristos</table> 151067f5680Schristos 152067f5680Schristos<hr> 153*897be3a4Schristos<span id="plot_005fsummary-directory"></span><div class="header"> 154067f5680Schristos<p> 155067f5680SchristosNext: <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> 1568585484eSchristos</div> 157*897be3a4Schristos<span id="directory-option"></span><h4 class="subsection">1.1.1 directory option</h4> 158*897be3a4Schristos<span id="index-plot_005fsummary_002ddirectory"></span> 1598585484eSchristos 160067f5680Schristos<p>This is the “where the summary files are” option. 1618585484eSchristosThis option takes a string argument. 1628585484eSchristos The directory where the <code>plot_summary</code> will search for the 1638585484eSchristos *_summary files generated by <code>summary</code> script. 164067f5680Schristos</p><hr> 165*897be3a4Schristos<span id="plot_005fsummary-identifier"></span><div class="header"> 166067f5680Schristos<p> 167067f5680SchristosNext: <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> 1688585484eSchristos</div> 169*897be3a4Schristos<span id="identifier-option"></span><h4 class="subsection">1.1.2 identifier option</h4> 170*897be3a4Schristos<span id="index-plot_005fsummary_002didentifier"></span> 1718585484eSchristos 172067f5680Schristos<p>This is the “origin of the data” option. 1738585484eSchristosThis option takes a string argument. 174067f5680Schristos Where does the plotted data come from, default to string "host" plus 1758585484eSchristos current hostname 176067f5680Schristos</p><hr> 177*897be3a4Schristos<span id="plot_005fsummary-peer"></span><div class="header"> 178067f5680Schristos<p> 179067f5680SchristosNext: <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> 1808585484eSchristos</div> 181*897be3a4Schristos<span id="peer-option"></span><h4 class="subsection">1.1.3 peer option</h4> 182*897be3a4Schristos<span id="index-plot_005fsummary_002dpeer"></span> 1838585484eSchristos 184067f5680Schristos<p>This is the “peers to generate plots for” option. 1858585484eSchristosThis option takes a string argument. 186067f5680Schristos</p> 187067f5680Schristos<p>This option has some usage constraints. It: 188067f5680Schristos</p><ul> 1898585484eSchristos<li> may appear an unlimited number of times. 190067f5680Schristos</li></ul> 1918585484eSchristos 1928585484eSchristos<p>By default the peer_summary plots are not generated. Use this option to 1938585484eSchristos specify list of peers if you want to generate plots for them. 194067f5680Schristos</p><hr> 195*897be3a4Schristos<span id="plot_005fsummary-plot_002dterm"></span><div class="header"> 196067f5680Schristos<p> 197067f5680SchristosNext: <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> 1988585484eSchristos</div> 199*897be3a4Schristos<span id="plot_002dterm-option"></span><h4 class="subsection">1.1.4 plot-term option</h4> 200*897be3a4Schristos<span id="index-plot_005fsummary_002dplot_002dterm"></span> 2018585484eSchristos 202067f5680Schristos<p>This is the “gnuplot terminal” option. 2038585484eSchristosThis option takes a string argument. 2048585484eSchristos This is string is passed directly to the <code>gnuplot set terminal</code> 2058585484eSchristos command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 206067f5680Schristos <code>dumb</code> is it’s not’. See output from (gnuplot -e "set 207067f5680Schristos terminal") for the list of available options. 208067f5680Schristos</p><hr> 209*897be3a4Schristos<span id="plot_005fsummary-output_002dfile"></span><div class="header"> 210067f5680Schristos<p> 211067f5680SchristosNext: <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> 2128585484eSchristos</div> 213*897be3a4Schristos<span id="output_002dfile-option"></span><h4 class="subsection">1.1.5 output-file option</h4> 214*897be3a4Schristos<span id="index-plot_005fsummary_002doutput_002dfile"></span> 2158585484eSchristos 216067f5680Schristos<p>This is the “output file” option. 2178585484eSchristosThis option takes a str argument. 2188585484eSchristos Output file for <code>gnuplot</code>, default to stdout. 219067f5680Schristos</p><hr> 220*897be3a4Schristos<span id="plot_005fsummary-exit-status"></span><div class="header"> 221067f5680Schristos<p> 222067f5680SchristosPrevious: <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> 2238585484eSchristos</div> 224*897be3a4Schristos<span id="plot_005fsummary-exit-status-1"></span><h4 class="subsection">1.1.6 plot_summary exit status</h4> 2258585484eSchristos 2268585484eSchristos<p>One of the following exit values will be returned: 227067f5680Schristos</p><dl compact="compact"> 228067f5680Schristos<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> 229067f5680Schristos<dd><p>Successful program execution. 230067f5680Schristos</p></dd> 231067f5680Schristos<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> 232067f5680Schristos<dd><p>The operation failed or the command syntax was not valid. 233067f5680Schristos</p></dd> 2348585484eSchristos</dl> 235067f5680Schristos<hr> 2368585484eSchristos 2378585484eSchristos 238067f5680Schristos 239067f5680Schristos</body> 240067f5680Schristos</html> 241