1275970Scy<html lang="en"> 2275970Scy<head> 3275970Scy<title>Plot_summary User's Manual</title> 4275970Scy<meta http-equiv="Content-Type" content="text/html"> 5275970Scy<meta name="description" content="Plot_summary User's Manual"> 6275970Scy<meta name="generator" content="makeinfo 4.7"> 7275970Scy<link title="Top" rel="top" href="#Top"> 8275970Scy<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9275970Scy<meta http-equiv="Content-Style-Type" content="text/css"> 10275970Scy<style type="text/css"><!-- 11275970Scy pre.display { font-family:inherit } 12275970Scy pre.format { font-family:inherit } 13275970Scy pre.smalldisplay { font-family:inherit; font-size:smaller } 14275970Scy pre.smallformat { font-family:inherit; font-size:smaller } 15275970Scy pre.smallexample { font-size:smaller } 16275970Scy pre.smalllisp { font-size:smaller } 17275970Scy span.sc { font-variant:small-caps } 18275970Scy span.roman { font-family: serif; font-weight: normal; } 19275970Scy--></style> 20275970Scy</head> 21275970Scy<body> 22275970Scy<h1 class="settitle">Plot_summary User's Manual</h1> 23275970Scy<div class="node"> 24275970Scy<p><hr> 25275970Scy<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 26275970ScyPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 27275970ScyUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 28275970Scy<br> 29275970Scy</div> 30275970Scy 31275970Scy<h2 class="unnumbered">Plot_summary User Manual</h2> 32275970Scy 33275970Scy<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 34330567SgordonThis document applies to version 4.2.8p11 of <code>plot_summary</code>. 35275970Scy 36275970Scy <div class="shortcontents"> 37275970Scy<h2>Short Contents</h2> 38275970Scy<ul> 39275970Scy<a href="#Top">Plot_summary User Manual</a> 40275970Scy</ul> 41275970Scy</div> 42275970Scy 43275970Scy<ul class="menu"> 44275970Scy<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 45275970Scy<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 46275970Scy</ul> 47275970Scy 48275970Scy<div class="node"> 49275970Scy<p><hr> 50275970Scy<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51275970ScyUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52275970Scy<br> 53275970Scy</div> 54275970Scy 55275970Scy<h3 class="section">Invoking plot_summary</h3> 56275970Scy 57275970Scy<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58275970Scy 59275970Scy <p>This section was generated by <strong>AutoGen</strong>, 60275970Scyusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61275970Scy 62275970Scy<ul class="menu"> 63275970Scy<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64275970Scy<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65275970Scy<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66275970Scy<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67275970Scy<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68275970Scy<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69275970Scy<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 70275970Scy</ul> 71275970Scy 72275970Scy<div class="node"> 73275970Scy<p><hr> 74275970Scy<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76275970Scy<br> 77275970Scy</div> 78275970Scy 79275970Scy<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80275970Scy 81275970Scy<p><a name="index-plot_005fsummary-help-3"></a> 82275970ScyThis is the automatically generated usage text for plot_summary. 83275970Scy 84275970Scy <p>The text printed is the same whether selected with the <code>help</code> option 85275970Scy(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86275970Scythe usage text by passing it through a pager program. 87275970Scy<code>more-help</code> is disabled on platforms without a working 88275970Scy<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89275970Scyused to select the program, defaulting to <span class="file">more</span>. Both will exit 90275970Scywith a status code of 0. 91275970Scy 92330567Sgordon<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p11 93275970ScyUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94275970Scy 95275970Scy --directory=str Where the summary files are 96275970Scy --identifier=str Origin of the data 97275970Scy --offset-limit=float Limit of absolute offset 98275970Scy --peer=str Peers to generate plots for 99275970Scy - may appear multiple times 100275970Scy --plot-term=str Gnuplot terminal 101275970Scy --output-file=str Output file 102275970Scy --dont-wait Don't wait for keystroke between plots 103275970Scy -?, --help Display usage information and exit 104275970Scy --more-help Pass the extended usage text through a pager 105275970Scy 106275970ScyOptions are specified by doubled hyphens and their name or by a single 107275970Scyhyphen and the flag character. 108275970Scy</pre> 109275970Scy <div class="node"> 110275970Scy<p><hr> 111275970Scy<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112275970ScyPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114275970Scy<br> 115275970Scy</div> 116275970Scy 117275970Scy<h4 class="subsection">directory option</h4> 118275970Scy 119275970Scy<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 120275970ScyThis is the “where the summary files are” option. 121275970ScyThis option takes a string argument. 122275970Scy The directory where the <code>plot_summary</code> will search for the 123275970Scy *_summary files generated by <code>summary</code> script. 124275970Scy<div class="node"> 125275970Scy<p><hr> 126275970Scy<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127275970ScyPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129275970Scy<br> 130275970Scy</div> 131275970Scy 132275970Scy<h4 class="subsection">identifier option</h4> 133275970Scy 134275970Scy<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135275970ScyThis is the “origin of the data” option. 136275970ScyThis option takes a string argument. 137275970Scy Where does the plotted data come from, default to string "host" plus 138275970Scy current hostname 139275970Scy<div class="node"> 140275970Scy<p><hr> 141275970Scy<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142275970ScyPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144275970Scy<br> 145275970Scy</div> 146275970Scy 147275970Scy<h4 class="subsection">peer option</h4> 148275970Scy 149275970Scy<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150275970ScyThis is the “peers to generate plots for” option. 151275970ScyThis option takes a string argument. 152275970Scy 153275970Scy<p class="noindent">This option has some usage constraints. It: 154275970Scy <ul> 155275970Scy<li>may appear an unlimited number of times. 156275970Scy</ul> 157275970Scy 158275970Scy <p>By default the peer_summary plots are not generated. Use this option to 159275970Scy specify list of peers if you want to generate plots for them. 160275970Scy<div class="node"> 161275970Scy<p><hr> 162275970Scy<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163275970ScyPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165275970Scy<br> 166275970Scy</div> 167275970Scy 168275970Scy<h4 class="subsection">plot-term option</h4> 169275970Scy 170275970Scy<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171275970ScyThis is the “gnuplot terminal” option. 172275970ScyThis option takes a string argument. 173275970Scy This is string is passed directly to the <code>gnuplot set terminal</code> 174275970Scy command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175275970Scy <code>dumb</code> is it's not'. See output from -e "set 176301301Sdelphij terminal") for the list of available options. 177275970Scy<div class="node"> 178275970Scy<p><hr> 179275970Scy<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180275970ScyPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182275970Scy<br> 183275970Scy</div> 184275970Scy 185275970Scy<h4 class="subsection">output-file option</h4> 186275970Scy 187275970Scy<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188275970ScyThis is the “output file” option. 189275970ScyThis option takes a str argument. 190275970Scy Output file for <code>gnuplot</code>, default to stdout. 191275970Scy<div class="node"> 192275970Scy<p><hr> 193275970Scy<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194275970ScyUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195275970Scy<br> 196275970Scy</div> 197275970Scy 198275970Scy<h4 class="subsection">plot_summary exit status</h4> 199275970Scy 200275970Scy<p>One of the following exit values will be returned: 201275970Scy <dl> 202275970Scy<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203275970Scy<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204275970Scy</dl> 205275970Scy 206275970Scy</body></html> 207275970Scy 208