plot_summary.html revision 338531
1139823Simp<html lang="en"> 21541Srgrimes<head> 31541Srgrimes<title>Plot_summary User's Manual</title> 41541Srgrimes<meta http-equiv="Content-Type" content="text/html"> 51541Srgrimes<meta name="description" content="Plot_summary User's Manual"> 61541Srgrimes<meta name="generator" content="makeinfo 4.7"> 71541Srgrimes<link title="Top" rel="top" href="#Top"> 81541Srgrimes<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 91541Srgrimes<meta http-equiv="Content-Style-Type" content="text/css"> 101541Srgrimes<style type="text/css"><!-- 111541Srgrimes pre.display { font-family:inherit } 121541Srgrimes pre.format { font-family:inherit } 131541Srgrimes pre.smalldisplay { font-family:inherit; font-size:smaller } 141541Srgrimes pre.smallformat { font-family:inherit; font-size:smaller } 151541Srgrimes pre.smallexample { font-size:smaller } 161541Srgrimes pre.smalllisp { font-size:smaller } 171541Srgrimes span.sc { font-variant:small-caps } 181541Srgrimes span.roman { font-family: serif; font-weight: normal; } 191541Srgrimes--></style> 201541Srgrimes</head> 211541Srgrimes<body> 221541Srgrimes<h1 class="settitle">Plot_summary User's Manual</h1> 231541Srgrimes<div class="node"> 241541Srgrimes<p><hr> 251541Srgrimes<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 261541SrgrimesPrevious: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 271541SrgrimesUp: <a rel="up" accesskey="u" href="#dir">(dir)</a> 281541Srgrimes<br> 291541Srgrimes</div> 301541Srgrimes 311541Srgrimes<h2 class="unnumbered">Plot_summary User Manual</h2> 321541Srgrimes 3344511Swollman<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 3450477SpeterThis document applies to version 4.2.8p12 of <code>plot_summary</code>. 351541Srgrimes 361541Srgrimes <div class="shortcontents"> 372169Spaul<h2>Short Contents</h2> 382169Spaul<ul> 392169Spaul<a href="#Top">Plot_summary User Manual</a> 401541Srgrimes</ul> 411541Srgrimes</div> 421541Srgrimes 431541Srgrimes<ul class="menu"> 441541Srgrimes<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 451541Srgrimes<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 4614622Sfenner</ul> 471541Srgrimes 481541Srgrimes<div class="node"> 49189592Sbms<p><hr> 50189592Sbms<a name="plot_005fsummary-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 51189592SbmsUp: <a rel="up" accesskey="u" href="#Top">Top</a> 52189592Sbms<br> 53189592Sbms</div> 54189592Sbms 55189592Sbms<h3 class="section">Invoking plot_summary</h3> 56189592Sbms 57189592Sbms<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 58189592Sbms 59189592Sbms <p>This section was generated by <strong>AutoGen</strong>, 60189592Sbmsusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 61189592Sbms 62189592Sbms<ul class="menu"> 63189592Sbms<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<span class="option">--help</span>) 64189592Sbms<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 65189592Sbms<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 66189592Sbms<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 67189592Sbms<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 68189592Sbms<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 69189592Sbms<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 701541Srgrimes</ul> 71189592Sbms 72189592Sbms<div class="node"> 73189592Sbms<p><hr> 74189592Sbms<a name="plot_005fsummary-usage"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 75189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 76189592Sbms<br> 77189592Sbms</div> 78189592Sbms 79189592Sbms<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4> 80189592Sbms 81189592Sbms<p><a name="index-plot_005fsummary-help-3"></a> 82189592SbmsThis is the automatically generated usage text for plot_summary. 83189592Sbms 84189592Sbms <p>The text printed is the same whether selected with the <code>help</code> option 85189592Sbms(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print 86189592Sbmsthe usage text by passing it through a pager program. 87189592Sbms<code>more-help</code> is disabled on platforms without a working 88189592Sbms<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 89189592Sbmsused to select the program, defaulting to <span class="file">more</span>. Both will exit 90189592Sbmswith a status code of 0. 91189592Sbms 92189592Sbms<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p12 93189592SbmsUSAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 94189592Sbms 95189592Sbms --directory=str Where the summary files are 96189592Sbms --identifier=str Origin of the data 97189592Sbms --offset-limit=float Limit of absolute offset 98189592Sbms --peer=str Peers to generate plots for 99189592Sbms - may appear multiple times 100189592Sbms --plot-term=str Gnuplot terminal 101189592Sbms --output-file=str Output file 102189592Sbms --dont-wait Don't wait for keystroke between plots 103189592Sbms -?, --help Display usage information and exit 104189592Sbms --more-help Pass the extended usage text through a pager 1051541Srgrimes 106189592SbmsOptions are specified by doubled hyphens and their name or by a single 107189592Sbmshyphen and the flag character. 1081541Srgrimes</pre> 109190965Srwatson <div class="node"> 110190965Srwatson<p><hr> 111190965Srwatson<a name="plot_005fsummary-directory"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 112190965SrwatsonPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 113190965SrwatsonUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 114189592Sbms<br> 115189592Sbms</div> 116189592Sbms 117189592Sbms<h4 class="subsection">directory option</h4> 11855205Speter 1192531Swollman<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 1201541SrgrimesThis is the “where the summary files are” option. 121189592SbmsThis option takes a string argument. 12214622Sfenner The directory where the <code>plot_summary</code> will search for the 12314622Sfenner *_summary files generated by <code>summary</code> script. 124189592Sbms<div class="node"> 125170613Sbms<p><hr> 126189592Sbms<a name="plot_005fsummary-identifier"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 127189592SbmsPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 128189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 129189592Sbms<br> 130189592Sbms</div> 131189592Sbms 132189592Sbms<h4 class="subsection">identifier option</h4> 133189592Sbms 134189592Sbms<p><a name="index-plot_005fsummary_002didentifier-5"></a> 135189592SbmsThis is the “origin of the data” option. 136189592SbmsThis option takes a string argument. 137170613Sbms Where does the plotted data come from, default to string "host" plus 138170613Sbms current hostname 139189592Sbms<div class="node"> 14014622Sfenner<p><hr> 141189592Sbms<a name="plot_005fsummary-peer"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 142189592SbmsPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 143189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 144189592Sbms<br> 14514622Sfenner</div> 14614622Sfenner 147189592Sbms<h4 class="subsection">peer option</h4> 14814622Sfenner 149189592Sbms<p><a name="index-plot_005fsummary_002dpeer-6"></a> 150189592SbmsThis is the “peers to generate plots for” option. 151189592SbmsThis option takes a string argument. 15214622Sfenner 153189592Sbms<p class="noindent">This option has some usage constraints. It: 154189592Sbms <ul> 155189592Sbms<li>may appear an unlimited number of times. 156189592Sbms</ul> 157189592Sbms 158189592Sbms <p>By default the peer_summary plots are not generated. Use this option to 159189592Sbms specify list of peers if you want to generate plots for them. 160189592Sbms<div class="node"> 161189592Sbms<p><hr> 162189592Sbms<a name="plot_005fsummary-plot_002dterm"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 163189592SbmsPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 164189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 165189592Sbms<br> 166189592Sbms</div> 167189592Sbms 168189592Sbms<h4 class="subsection">plot-term option</h4> 169189592Sbms 170189592Sbms<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 171170613SbmsThis is the “gnuplot terminal” option. 172189592SbmsThis option takes a string argument. 173170613Sbms This is string is passed directly to the <code>gnuplot set terminal</code> 174189592Sbms command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 175189592Sbms <code>dumb</code> is it's not'. See output from -e "set 176189592Sbms terminal") for the list of available options. 177189592Sbms<div class="node"> 178170613Sbms<p><hr> 179170613Sbms<a name="plot_005fsummary-output_002dfile"></a>Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 180189592SbmsPrevious: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 181189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 182189592Sbms<br> 183170613Sbms</div> 184189592Sbms 185189592Sbms<h4 class="subsection">output-file option</h4> 186189592Sbms 187170613Sbms<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 188170613SbmsThis is the “output file” option. 189189592SbmsThis option takes a str argument. 190189592Sbms Output file for <code>gnuplot</code>, default to stdout. 191189592Sbms<div class="node"> 192170613Sbms<p><hr> 193189592Sbms<a name="plot_005fsummary-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 194189592SbmsUp: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 195189592Sbms<br> 196189592Sbms</div> 197189592Sbms 198189592Sbms<h4 class="subsection">plot_summary exit status</h4> 199170613Sbms 200189592Sbms<p>One of the following exit values will be returned: 201170613Sbms <dl> 202189592Sbms<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 203189592Sbms<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 204189592Sbms</dl> 205189592Sbms 206189592Sbms</body></html> 207189592Sbms 20892723Salfred