1290001Sglebius<html lang="en"> 2290001Sglebius<head> 3290001Sglebius<title>Plot_summary User's Manual</title> 4290001Sglebius<meta http-equiv="Content-Type" content="text/html"> 5290001Sglebius<meta name="description" content="Plot_summary User's Manual"> 6290001Sglebius<meta name="generator" content="makeinfo 4.7"> 7290001Sglebius<link title="Top" rel="top" href="#Top"> 8290001Sglebius<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9290001Sglebius<meta http-equiv="Content-Style-Type" content="text/css"> 10290001Sglebius<style type="text/css"><!-- 11290001Sglebius pre.display { font-family:inherit } 12290001Sglebius pre.format { font-family:inherit } 13290001Sglebius pre.smalldisplay { font-family:inherit; font-size:smaller } 14290001Sglebius pre.smallformat { font-family:inherit; font-size:smaller } 15290001Sglebius pre.smallexample { font-size:smaller } 16290001Sglebius pre.smalllisp { font-size:smaller } 17290001Sglebius span.sc { font-variant:small-caps } 18290001Sglebius span.roman { font-family: serif; font-weight: normal; } 19290001Sglebius--></style> 20290001Sglebius</head> 21290001Sglebius<body> 22290001Sglebius<h1 class="settitle">Plot_summary User's Manual</h1> 23290001Sglebius<div class="node"> 24290001Sglebius<p><hr> 25290001Sglebius<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 26290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27290001SglebiusUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28290001Sglebius<br> 29290001Sglebius</div> 30290001Sglebius 31290001Sglebius<h2 class="unnumbered">Plot_summary User Manual</h2> 32290001Sglebius 33290001Sglebius<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 34310419SdelphijThis document applies to version 4.2.8p9 of <code>plot_summary</code>. 35290001Sglebius 36290001Sglebius <div class="shortcontents"> 37290001Sglebius<h2>Short Contents</h2> 38290001Sglebius<ul> 39290001Sglebius<a href="#Top">Plot_summary User Manual</a> 40290001Sglebius</ul> 41290001Sglebius</div> 42290001Sglebius 43290001Sglebius<ul class="menu"> 44290001Sglebius<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 45290001Sglebius<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 46290001Sglebius</ul> 47290001Sglebius 48290001Sglebius<div class="node"> 49290001Sglebius<p><hr> 50290001Sglebius<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51290001SglebiusUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52290001Sglebius<br> 53290001Sglebius</div> 54290001Sglebius 55290001Sglebius<h3 class="section">Invoking plot_summary</h3> 56290001Sglebius 57290001Sglebius<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58290001Sglebius 59290001Sglebius <p>This section was generated by <strong>AutoGen</strong>, 60290001Sglebiususing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61290001Sglebius 62290001Sglebius<ul class="menu"> 63290001Sglebius<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64290001Sglebius<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65290001Sglebius<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66290001Sglebius<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67290001Sglebius<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68290001Sglebius<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69290001Sglebius<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 70290001Sglebius</ul> 71290001Sglebius 72290001Sglebius<div class="node"> 73290001Sglebius<p><hr> 74290001Sglebius<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76290001Sglebius<br> 77290001Sglebius</div> 78290001Sglebius 79290001Sglebius<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80290001Sglebius 81290001Sglebius<p><a name="index-plot_005fsummary-help-3"></a> 82290001SglebiusThis is the automatically generated usage text for plot_summary. 83290001Sglebius 84290001Sglebius <p>The text printed is the same whether selected with the <code>help</code> option 85290001Sglebius(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86290001Sglebiusthe usage text by passing it through a pager program. 87290001Sglebius<code>more-help</code> is disabled on platforms without a working 88290001Sglebius<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89290001Sglebiusused to select the program, defaulting to <span class="file">more</span>. Both will exit 90290001Sglebiuswith a status code of 0. 91290001Sglebius 92310419Sdelphij<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p9 93290001SglebiusUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94290001Sglebius 95290001Sglebius --directory=str Where the summary files are 96290001Sglebius --identifier=str Origin of the data 97290001Sglebius --offset-limit=float Limit of absolute offset 98290001Sglebius --peer=str Peers to generate plots for 99290001Sglebius - may appear multiple times 100290001Sglebius --plot-term=str Gnuplot terminal 101290001Sglebius --output-file=str Output file 102290001Sglebius --dont-wait Don't wait for keystroke between plots 103290001Sglebius -?, --help Display usage information and exit 104290001Sglebius --more-help Pass the extended usage text through a pager 105290001Sglebius 106290001SglebiusOptions are specified by doubled hyphens and their name or by a single 107290001Sglebiushyphen and the flag character. 108290001Sglebius</pre> 109290001Sglebius <div class="node"> 110290001Sglebius<p><hr> 111290001Sglebius<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114290001Sglebius<br> 115290001Sglebius</div> 116290001Sglebius 117290001Sglebius<h4 class="subsection">directory option</h4> 118290001Sglebius 119290001Sglebius<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 120290001SglebiusThis is the “where the summary files are” option. 121290001SglebiusThis option takes a string argument. 122290001Sglebius The directory where the <code>plot_summary</code> will search for the 123290001Sglebius *_summary files generated by <code>summary</code> script. 124290001Sglebius<div class="node"> 125290001Sglebius<p><hr> 126290001Sglebius<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129290001Sglebius<br> 130290001Sglebius</div> 131290001Sglebius 132290001Sglebius<h4 class="subsection">identifier option</h4> 133290001Sglebius 134290001Sglebius<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135290001SglebiusThis is the “origin of the data” option. 136290001SglebiusThis option takes a string argument. 137290001Sglebius Where does the plotted data come from, default to string "host" plus 138290001Sglebius current hostname 139290001Sglebius<div class="node"> 140290001Sglebius<p><hr> 141290001Sglebius<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144290001Sglebius<br> 145290001Sglebius</div> 146290001Sglebius 147290001Sglebius<h4 class="subsection">peer option</h4> 148290001Sglebius 149290001Sglebius<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150290001SglebiusThis is the “peers to generate plots for” option. 151290001SglebiusThis option takes a string argument. 152290001Sglebius 153290001Sglebius<p class="noindent">This option has some usage constraints. It: 154290001Sglebius <ul> 155290001Sglebius<li>may appear an unlimited number of times. 156290001Sglebius</ul> 157290001Sglebius 158290001Sglebius <p>By default the peer_summary plots are not generated. Use this option to 159290001Sglebius specify list of peers if you want to generate plots for them. 160290001Sglebius<div class="node"> 161290001Sglebius<p><hr> 162290001Sglebius<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165290001Sglebius<br> 166290001Sglebius</div> 167290001Sglebius 168290001Sglebius<h4 class="subsection">plot-term option</h4> 169290001Sglebius 170290001Sglebius<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171290001SglebiusThis is the “gnuplot terminal” option. 172290001SglebiusThis option takes a string argument. 173290001Sglebius This is string is passed directly to the <code>gnuplot set terminal</code> 174290001Sglebius command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175290001Sglebius <code>dumb</code> is it's not'. See output from -e "set 176301301Sdelphij terminal") for the list of available options. 177290001Sglebius<div class="node"> 178290001Sglebius<p><hr> 179290001Sglebius<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180290001SglebiusPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182290001Sglebius<br> 183290001Sglebius</div> 184290001Sglebius 185290001Sglebius<h4 class="subsection">output-file option</h4> 186290001Sglebius 187290001Sglebius<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188290001SglebiusThis is the “output file” option. 189290001SglebiusThis option takes a str argument. 190290001Sglebius Output file for <code>gnuplot</code>, default to stdout. 191290001Sglebius<div class="node"> 192290001Sglebius<p><hr> 193290001Sglebius<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194290001SglebiusUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195290001Sglebius<br> 196290001Sglebius</div> 197290001Sglebius 198290001Sglebius<h4 class="subsection">plot_summary exit status</h4> 199290001Sglebius 200290001Sglebius<p>One of the following exit values will be returned: 201290001Sglebius <dl> 202290001Sglebius<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203290001Sglebius<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204290001Sglebius</dl> 205290001Sglebius 206290001Sglebius</body></html> 207290001Sglebius 208