plot_summary.html revision 298770
1135042Srwatson<html lang="en"> 2135042Srwatson<head> 3135042Srwatson<title>Plot_summary User's Manual</title> 4135042Srwatson<meta http-equiv="Content-Type" content="text/html"> 5135042Srwatson<meta name="description" content="Plot_summary User's Manual"> 6135042Srwatson<meta name="generator" content="makeinfo 4.7"> 7135042Srwatson<link title="Top" rel="top" href="#Top"> 8135042Srwatson<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9135042Srwatson<meta http-equiv="Content-Style-Type" content="text/css"> 10135042Srwatson<style type="text/css"><!-- 11135042Srwatson pre.display { font-family:inherit } 12135042Srwatson pre.format { font-family:inherit } 13135042Srwatson pre.smalldisplay { font-family:inherit; font-size:smaller } 14135042Srwatson pre.smallformat { font-family:inherit; font-size:smaller } 15135042Srwatson pre.smallexample { font-size:smaller } 16135042Srwatson pre.smalllisp { font-size:smaller } 17135042Srwatson span.sc { font-variant:small-caps } 18135042Srwatson span.roman { font-family: serif; font-weight: normal; } 19135042Srwatson--></style> 20135042Srwatson</head> 21135042Srwatson<body> 22135042Srwatson<h1 class="settitle">Plot_summary User's Manual</h1> 23135042Srwatson<div class="node"> 24135042Srwatson<p><hr> 25135042Srwatson<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 26135042SrwatsonPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27135042SrwatsonUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28135042Srwatson<br> 29135042Srwatson</div> 30135042Srwatson 31135042Srwatson<h2 class="unnumbered">Plot_summary User Manual</h2> 32227345Scognet 33135042Srwatson<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 34135042SrwatsonThis document applies to version 4.2.8p7 of <code>plot_summary</code>. 35227345Scognet 36135042Srwatson <div class="shortcontents"> 37135042Srwatson<h2>Short Contents</h2> 38135042Srwatson<ul> 39135042Srwatson<a href="#Top">Plot_summary User Manual</a> 40135042Srwatson</ul> 41135042Srwatson</div> 42227345Scognet 43135042Srwatson<ul class="menu"> 44227345Scognet<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 45227345Scognet<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 46244644Sluigi</ul> 47244644Sluigi 48244644Sluigi<div class="node"> 49244644Sluigi<p><hr> 50244644Sluigi<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51244644SluigiUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52244644Sluigi<br> 53244644Sluigi</div> 54244644Sluigi 55244644Sluigi<h3 class="section">Invoking plot_summary</h3> 56244644Sluigi 57244644Sluigi<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58244644Sluigi 59244644Sluigi <p>This section was generated by <strong>AutoGen</strong>, 60244644Sluigiusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61244644Sluigi 62244672Sluigi<ul class="menu"> 63244644Sluigi<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64244644Sluigi<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65244644Sluigi<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66244644Sluigi<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67244644Sluigi<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68135042Srwatson<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69135042Srwatson<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 70135042Srwatson</ul> 71135042Srwatson 72244644Sluigi<div class="node"> 73135042Srwatson<p><hr> 74135042Srwatson<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75135042SrwatsonUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76244644Sluigi<br> 77244644Sluigi</div> 78244644Sluigi 79244644Sluigi<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80244644Sluigi 81244644Sluigi<p><a name="index-plot_005fsummary-help-3"></a> 82244644SluigiThis is the automatically generated usage text for plot_summary. 83244644Sluigi 84244644Sluigi <p>The text printed is the same whether selected with the <code>help</code> option 85244644Sluigi(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86244644Sluigithe usage text by passing it through a pager program. 87244644Sluigi<code>more-help</code> is disabled on platforms without a working 88244644Sluigi<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89244644Sluigiused to select the program, defaulting to <span class="file">more</span>. Both will exit 90244644Sluigiwith a status code of 0. 91244644Sluigi 92244644Sluigi<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p7 93244644SluigiUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94244644Sluigi 95244644Sluigi --directory=str Where the summary files are 96244644Sluigi --identifier=str Origin of the data 97244644Sluigi --offset-limit=float Limit of absolute offset 98244644Sluigi --peer=str Peers to generate plots for 99244644Sluigi - may appear multiple times 100244644Sluigi --plot-term=str Gnuplot terminal 101244644Sluigi --output-file=str Output file 102244644Sluigi --dont-wait Don't wait for keystroke between plots 103244644Sluigi -?, --help Display usage information and exit 104244644Sluigi --more-help Pass the extended usage text through a pager 105244644Sluigi 106244644SluigiOptions are specified by doubled hyphens and their name or by a single 107244644Sluigihyphen and the flag character. 108244644Sluigi</pre> 109244644Sluigi <div class="node"> 110244644Sluigi<p><hr> 111244644Sluigi<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112244644SluigiPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113244644SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114244644Sluigi<br> 115244644Sluigi</div> 116244644Sluigi 117244644Sluigi<h4 class="subsection">directory option</h4> 118244644Sluigi 119244644Sluigi<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 120244672SluigiThis is the “where the summary files are” option. 121244644SluigiThis option takes a string argument. 122244644Sluigi The directory where the <code>plot_summary</code> will search for the 123244644Sluigi *_summary files generated by <code>summary</code> script. 124244644Sluigi<div class="node"> 125244644Sluigi<p><hr> 126244672Sluigi<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127244672SluigiPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128244644SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129244644Sluigi<br> 130244644Sluigi</div> 131244644Sluigi 132244644Sluigi<h4 class="subsection">identifier option</h4> 133244672Sluigi 134244644Sluigi<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135244644SluigiThis is the “origin of the data” option. 136244644SluigiThis option takes a string argument. 137244644Sluigi Where does the plotted data come from, default to string "host" plus 138244644Sluigi current hostname 139244644Sluigi<div class="node"> 140244644Sluigi<p><hr> 141244644Sluigi<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142244644SluigiPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143244644SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144244644Sluigi<br> 145244644Sluigi</div> 146244672Sluigi 147244672Sluigi<h4 class="subsection">peer option</h4> 148244644Sluigi 149244644Sluigi<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150244644SluigiThis is the “peers to generate plots for” option. 151244644SluigiThis option takes a string argument. 152244644Sluigi 153244644Sluigi<p class="noindent">This option has some usage constraints. It: 154244644Sluigi <ul> 155244672Sluigi<li>may appear an unlimited number of times. 156244644Sluigi</ul> 157244644Sluigi 158244672Sluigi <p>By default the peer_summary plots are not generated. Use this option to 159244644Sluigi specify list of peers if you want to generate plots for them. 160244644Sluigi<div class="node"> 161244672Sluigi<p><hr> 162244644Sluigi<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163244644SluigiPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164244672SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165244644Sluigi<br> 166244644Sluigi</div> 167244644Sluigi 168244644Sluigi<h4 class="subsection">plot-term option</h4> 169244644Sluigi 170244672Sluigi<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171244644SluigiThis is the “gnuplot terminal” option. 172244644SluigiThis option takes a string argument. 173244644Sluigi This is string is passed directly to the <code>gnuplot set terminal</code> 174244672Sluigi command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175244644Sluigi <code>dumb</code> is it's not'. See output from -e "set 176244644Sluigi terminal") for the list of avalaible options. 177244672Sluigi<div class="node"> 178244644Sluigi<p><hr> 179244644Sluigi<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180244644SluigiPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181244644SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182244644Sluigi<br> 183244644Sluigi</div> 184244644Sluigi 185244644Sluigi<h4 class="subsection">output-file option</h4> 186244672Sluigi 187244672Sluigi<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188244672SluigiThis is the “output file” option. 189244672SluigiThis option takes a str argument. 190244644Sluigi Output file for <code>gnuplot</code>, default to stdout. 191244672Sluigi<div class="node"> 192244644Sluigi<p><hr> 193244644Sluigi<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194244644SluigiUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195244644Sluigi<br> 196135042Srwatson</div> 197135042Srwatson 198227345Scognet<h4 class="subsection">plot_summary exit status</h4> 199135042Srwatson 200227345Scognet<p>One of the following exit values will be returned: 201244644Sluigi <dl> 202244644Sluigi<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203227345Scognet<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204227345Scognet</dl> 205227345Scognet 206135042Srwatson</body></html> 207244644Sluigi 208135042Srwatson