plot_summary.html revision 330141
1260659Sjkim<html lang="en"> 2260659Sjkim<head> 3260659Sjkim<title>Plot_summary User's Manual</title> 4260659Sjkim<meta http-equiv="Content-Type" content="text/html"> 5260659Sjkim<meta name="description" content="Plot_summary User's Manual"> 6260659Sjkim<meta name="generator" content="makeinfo 4.7"> 7260659Sjkim<link title="Top" rel="top" href="#Top"> 8306536Sjkim<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9260659Sjkim<meta http-equiv="Content-Style-Type" content="text/css"> 10260659Sjkim<style type="text/css"><!-- 11260659Sjkim pre.display { font-family:inherit } 12260659Sjkim pre.format { font-family:inherit } 13260659Sjkim pre.smalldisplay { font-family:inherit; font-size:smaller } 14260659Sjkim pre.smallformat { font-family:inherit; font-size:smaller } 15260659Sjkim pre.smallexample { font-size:smaller } 16260659Sjkim pre.smalllisp { font-size:smaller } 17260659Sjkim span.sc { font-variant:small-caps } 18260659Sjkim span.roman { font-family: serif; font-weight: normal; } 19260659Sjkim--></style> 20260659Sjkim</head> 21260659Sjkim<body> 22260659Sjkim<h1 class="settitle">Plot_summary User's Manual</h1> 23260659Sjkim<div class="node"> 24260659Sjkim<p><hr> 25260659Sjkim<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 26260659SjkimPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27260659SjkimUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28260659Sjkim<br> 29260659Sjkim</div> 30260659Sjkim 31260659Sjkim<h2 class="unnumbered">Plot_summary User Manual</h2> 32260659Sjkim 33260659Sjkim<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 34260659SjkimThis document applies to version 4.2.8p11 of <code>plot_summary</code>. 35260659Sjkim 36260659Sjkim <div class="shortcontents"> 37260659Sjkim<h2>Short Contents</h2> 38260659Sjkim<ul> 39260659Sjkim<a href="#Top">Plot_summary User Manual</a> 40260659Sjkim</ul> 41260659Sjkim</div> 42260659Sjkim 43260659Sjkim<ul class="menu"> 44272444Sjkim<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 45272444Sjkim<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 46272444Sjkim</ul> 47272444Sjkim 48272444Sjkim<div class="node"> 49260659Sjkim<p><hr> 50260659Sjkim<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51260659SjkimUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52260659Sjkim<br> 53260659Sjkim</div> 54260659Sjkim 55260659Sjkim<h3 class="section">Invoking plot_summary</h3> 56260659Sjkim 57260659Sjkim<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58260659Sjkim 59260659Sjkim <p>This section was generated by <strong>AutoGen</strong>, 60260659Sjkimusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61260659Sjkim 62260659Sjkim<ul class="menu"> 63260659Sjkim<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64260659Sjkim<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65260659Sjkim<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66260659Sjkim<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67260659Sjkim<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68260659Sjkim<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69260659Sjkim<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 70260659Sjkim</ul> 71260659Sjkim 72260659Sjkim<div class="node"> 73260659Sjkim<p><hr> 74260659Sjkim<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76260659Sjkim<br> 77260659Sjkim</div> 78260659Sjkim 79260659Sjkim<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80260659Sjkim 81260659Sjkim<p><a name="index-plot_005fsummary-help-3"></a> 82260659SjkimThis is the automatically generated usage text for plot_summary. 83260659Sjkim 84260659Sjkim <p>The text printed is the same whether selected with the <code>help</code> option 85260659Sjkim(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86260659Sjkimthe usage text by passing it through a pager program. 87260659Sjkim<code>more-help</code> is disabled on platforms without a working 88260659Sjkim<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89260659Sjkimused to select the program, defaulting to <span class="file">more</span>. Both will exit 90260659Sjkimwith a status code of 0. 91260659Sjkim 92260659Sjkim<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p11 93260659SjkimUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94260659Sjkim 95260659Sjkim --directory=str Where the summary files are 96260659Sjkim --identifier=str Origin of the data 97260659Sjkim --offset-limit=float Limit of absolute offset 98260659Sjkim --peer=str Peers to generate plots for 99260659Sjkim - may appear multiple times 100260659Sjkim --plot-term=str Gnuplot terminal 101260659Sjkim --output-file=str Output file 102260659Sjkim --dont-wait Don't wait for keystroke between plots 103260659Sjkim -?, --help Display usage information and exit 104260659Sjkim --more-help Pass the extended usage text through a pager 105260659Sjkim 106260659SjkimOptions are specified by doubled hyphens and their name or by a single 107260659Sjkimhyphen and the flag character. 108260659Sjkim</pre> 109260659Sjkim <div class="node"> 110260659Sjkim<p><hr> 111260659Sjkim<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112260659SjkimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114260659Sjkim<br> 115260659Sjkim</div> 116260659Sjkim 117260659Sjkim<h4 class="subsection">directory option</h4> 118260659Sjkim 119260659Sjkim<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 120260659SjkimThis is the “where the summary files are” option. 121260659SjkimThis option takes a string argument. 122260659Sjkim The directory where the <code>plot_summary</code> will search for the 123260659Sjkim *_summary files generated by <code>summary</code> script. 124260659Sjkim<div class="node"> 125260659Sjkim<p><hr> 126306536Sjkim<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127306536SjkimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129260659Sjkim<br> 130260659Sjkim</div> 131260659Sjkim 132260659Sjkim<h4 class="subsection">identifier option</h4> 133260659Sjkim 134260659Sjkim<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135260659SjkimThis is the “origin of the data” option. 136260659SjkimThis option takes a string argument. 137260659Sjkim Where does the plotted data come from, default to string "host" plus 138260659Sjkim current hostname 139260659Sjkim<div class="node"> 140260659Sjkim<p><hr> 141260659Sjkim<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142260659SjkimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144260659Sjkim<br> 145260659Sjkim</div> 146260659Sjkim 147260659Sjkim<h4 class="subsection">peer option</h4> 148260659Sjkim 149260659Sjkim<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150260659SjkimThis is the “peers to generate plots for” option. 151260659SjkimThis option takes a string argument. 152260659Sjkim 153260659Sjkim<p class="noindent">This option has some usage constraints. It: 154260659Sjkim <ul> 155260659Sjkim<li>may appear an unlimited number of times. 156260659Sjkim</ul> 157260659Sjkim 158260659Sjkim <p>By default the peer_summary plots are not generated. Use this option to 159260659Sjkim specify list of peers if you want to generate plots for them. 160260659Sjkim<div class="node"> 161260659Sjkim<p><hr> 162260659Sjkim<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163260659SjkimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165260659Sjkim<br> 166260659Sjkim</div> 167260659Sjkim 168260659Sjkim<h4 class="subsection">plot-term option</h4> 169260659Sjkim 170260659Sjkim<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171260659SjkimThis is the “gnuplot terminal” option. 172260659SjkimThis option takes a string argument. 173260659Sjkim This is string is passed directly to the <code>gnuplot set terminal</code> 174260659Sjkim command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175260659Sjkim <code>dumb</code> is it's not'. See output from -e "set 176260659Sjkim terminal") for the list of available options. 177260659Sjkim<div class="node"> 178260659Sjkim<p><hr> 179260659Sjkim<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180260659SjkimPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182260659Sjkim<br> 183260659Sjkim</div> 184260659Sjkim 185260659Sjkim<h4 class="subsection">output-file option</h4> 186260659Sjkim 187260659Sjkim<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188260659SjkimThis is the “output file” option. 189260659SjkimThis option takes a str argument. 190260659Sjkim Output file for <code>gnuplot</code>, default to stdout. 191260659Sjkim<div class="node"> 192260659Sjkim<p><hr> 193260659Sjkim<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194260659SjkimUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195260659Sjkim<br> 196260659Sjkim</div> 197260659Sjkim 198260659Sjkim<h4 class="subsection">plot_summary exit status</h4> 199260659Sjkim 200260659Sjkim<p>One of the following exit values will be returned: 201260659Sjkim <dl> 202260659Sjkim<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203260659Sjkim<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204260659Sjkim</dl> 205260659Sjkim 206260659Sjkim</body></html> 207260659Sjkim 208260659Sjkim