plot_summary.html revision 316722
1353358Sdim<html lang="en"> 2353358Sdim<head> 3353358Sdim<title>Plot_summary User's Manual</title> 4353358Sdim<meta http-equiv="Content-Type" content="text/html"> 5353358Sdim<meta name="description" content="Plot_summary User's Manual"> 6353358Sdim<meta name="generator" content="makeinfo 4.7"> 7353358Sdim<link title="Top" rel="top" href="#Top"> 8353358Sdim<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9353358Sdim<meta http-equiv="Content-Style-Type" content="text/css"> 10353358Sdim<style type="text/css"><!-- 11353358Sdim pre.display { font-family:inherit } 12276789Sdim pre.format { font-family:inherit } 13276789Sdim pre.smalldisplay { font-family:inherit; font-size:smaller } 14276789Sdim pre.smallformat { font-family:inherit; font-size:smaller } 15353358Sdim pre.smallexample { font-size:smaller } 16353358Sdim pre.smalllisp { font-size:smaller } 17276789Sdim span.sc { font-variant:small-caps } 18353358Sdim span.roman { font-family: serif; font-weight: normal; } 19276789Sdim--></style> 20353358Sdim</head> 21353358Sdim<body> 22353358Sdim<h1 class="settitle">Plot_summary User's Manual</h1> 23353358Sdim<div class="node"> 24353358Sdim<p><hr> 25353358Sdim<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 26353358SdimPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27353358SdimUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28353358Sdim<br> 29353358Sdim</div> 30353358Sdim 31353358Sdim<h2 class="unnumbered">Plot_summary User Manual</h2> 32353358Sdim 33353358Sdim<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 34353358SdimThis document applies to version 4.2.8p10 of <code>plot_summary</code>. 35353358Sdim 36353358Sdim <div class="shortcontents"> 37353358Sdim<h2>Short Contents</h2> 38353358Sdim<ul> 39353358Sdim<a href="#Top">Plot_summary User Manual</a> 40353358Sdim</ul> 41353358Sdim</div> 42353358Sdim 43353358Sdim<ul class="menu"> 44353358Sdim<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 45353358Sdim<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 46353358Sdim</ul> 47353358Sdim 48353358Sdim<div class="node"> 49353358Sdim<p><hr> 50353358Sdim<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51353358SdimUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52353358Sdim<br> 53353358Sdim</div> 54353358Sdim 55353358Sdim<h3 class="section">Invoking plot_summary</h3> 56353358Sdim 57353358Sdim<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58353358Sdim 59353358Sdim <p>This section was generated by <strong>AutoGen</strong>, 60353358Sdimusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61353358Sdim 62353358Sdim<ul class="menu"> 63353358Sdim<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64353358Sdim<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65353358Sdim<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66353358Sdim<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67353358Sdim<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68353358Sdim<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69353358Sdim<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 70353358Sdim</ul> 71353358Sdim 72353358Sdim<div class="node"> 73353358Sdim<p><hr> 74353358Sdim<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75353358SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76353358Sdim<br> 77353358Sdim</div> 78353358Sdim 79353358Sdim<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80353358Sdim 81353358Sdim<p><a name="index-plot_005fsummary-help-3"></a> 82353358SdimThis is the automatically generated usage text for plot_summary. 83353358Sdim 84353358Sdim <p>The text printed is the same whether selected with the <code>help</code> option 85353358Sdim(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86353358Sdimthe usage text by passing it through a pager program. 87353358Sdim<code>more-help</code> is disabled on platforms without a working 88353358Sdim<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89353358Sdimused to select the program, defaulting to <span class="file">more</span>. Both will exit 90353358Sdimwith a status code of 0. 91353358Sdim 92353358Sdim<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p10 93353358SdimUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94353358Sdim 95353358Sdim --directory=str Where the summary files are 96353358Sdim --identifier=str Origin of the data 97353358Sdim --offset-limit=float Limit of absolute offset 98353358Sdim --peer=str Peers to generate plots for 99353358Sdim - may appear multiple times 100353358Sdim --plot-term=str Gnuplot terminal 101353358Sdim --output-file=str Output file 102353358Sdim --dont-wait Don't wait for keystroke between plots 103353358Sdim -?, --help Display usage information and exit 104276789Sdim --more-help Pass the extended usage text through a pager 105353358Sdim 106353358SdimOptions are specified by doubled hyphens and their name or by a single 107353358Sdimhyphen and the flag character. 108353358Sdim</pre> 109353358Sdim <div class="node"> 110353358Sdim<p><hr> 111353358Sdim<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112353358SdimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113353358SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114353358Sdim<br> 115353358Sdim</div> 116353358Sdim 117353358Sdim<h4 class="subsection">directory option</h4> 118353358Sdim 119353358Sdim<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 120353358SdimThis is the “where the summary files are” option. 121276789SdimThis option takes a string argument. 122353358Sdim The directory where the <code>plot_summary</code> will search for the 123353358Sdim *_summary files generated by <code>summary</code> script. 124353358Sdim<div class="node"> 125353358Sdim<p><hr> 126353358Sdim<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127276789SdimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128276789SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129276789Sdim<br> 130353358Sdim</div> 131353358Sdim 132353358Sdim<h4 class="subsection">identifier option</h4> 133353358Sdim 134353358Sdim<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135353358SdimThis is the “origin of the data” option. 136353358SdimThis option takes a string argument. 137353358Sdim Where does the plotted data come from, default to string "host" plus 138353358Sdim current hostname 139353358Sdim<div class="node"> 140353358Sdim<p><hr> 141353358Sdim<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142353358SdimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143353358SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144353358Sdim<br> 145353358Sdim</div> 146353358Sdim 147353358Sdim<h4 class="subsection">peer option</h4> 148353358Sdim 149353358Sdim<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150353358SdimThis is the “peers to generate plots for” option. 151353358SdimThis option takes a string argument. 152353358Sdim 153353358Sdim<p class="noindent">This option has some usage constraints. It: 154353358Sdim <ul> 155353358Sdim<li>may appear an unlimited number of times. 156353358Sdim</ul> 157353358Sdim 158353358Sdim <p>By default the peer_summary plots are not generated. Use this option to 159353358Sdim specify list of peers if you want to generate plots for them. 160353358Sdim<div class="node"> 161276789Sdim<p><hr> 162353358Sdim<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163353358SdimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164353358SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165353358Sdim<br> 166353358Sdim</div> 167353358Sdim 168353358Sdim<h4 class="subsection">plot-term option</h4> 169353358Sdim 170353358Sdim<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171353358SdimThis is the “gnuplot terminal” option. 172353358SdimThis option takes a string argument. 173353358Sdim This is string is passed directly to the <code>gnuplot set terminal</code> 174353358Sdim command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175353358Sdim <code>dumb</code> is it's not'. See output from -e "set 176353358Sdim terminal") for the list of available options. 177353358Sdim<div class="node"> 178353358Sdim<p><hr> 179353358Sdim<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180353358SdimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181353358SdimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182353358Sdim<br> 183353358Sdim</div> 184353358Sdim 185353358Sdim<h4 class="subsection">output-file option</h4> 186353358Sdim 187353358Sdim<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188353358SdimThis is the “output file” option. 189276789SdimThis option takes a str argument. 190 Output file for <code>gnuplot</code>, default to stdout. 191<div class="node"> 192<p><hr> 193<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195<br> 196</div> 197 198<h4 class="subsection">plot_summary exit status</h4> 199 200<p>One of the following exit values will be returned: 201 <dl> 202<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204</dl> 205 206</body></html> 207 208