plot_summary.html revision 1.1.1.6
1<html lang="en"> 2<head> 3<title>Plot_summary User's Manual</title> 4<meta http-equiv="Content-Type" content="text/html"> 5<meta name="description" content="Plot_summary User's Manual"> 6<meta name="generator" content="makeinfo 4.8"> 7<link title="Top" rel="top" href="#Top"> 8<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9<meta http-equiv="Content-Style-Type" content="text/css"> 10<style type="text/css"><!-- 11 pre.display { font-family:inherit } 12 pre.format { font-family:inherit } 13 pre.smalldisplay { font-family:inherit; font-size:smaller } 14 pre.smallformat { font-family:inherit; font-size:smaller } 15 pre.smallexample { font-size:smaller } 16 pre.smalllisp { font-size:smaller } 17 span.sc { font-variant:small-caps } 18 span.roman { font-family:serif; font-weight:normal; } 19 span.sansserif { font-family:sans-serif; font-weight:normal; } 20--></style> 21</head> 22<body> 23<h1 class="settitle">Plot_summary User's Manual</h1> 24<div class="node"> 25<p><hr> 26<a name="Top"></a> 27Next: <a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>, 28Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 29Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 30 31</div> 32 33<h2 class="unnumbered">Plot_summary User Manual</h2> 34 35<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 36This document applies to version 4.2.8p5 of <code>plot_summary</code>. 37 38 <div class="shortcontents"> 39<h2>Short Contents</h2> 40<ul> 41<a href="#Top">Plot_summary User Manual</a> 42</ul> 43</div> 44 45<ul class="menu"> 46<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>: Description 47<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: Invoking plot_summary 48</ul> 49 50<div class="node"> 51<p><hr> 52<a name="plot_summary-Invocation"></a> 53<a name="plot_005fsummary-Invocation"></a> 54Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>, 55Up: <a rel="up" accesskey="u" href="#Top">Top</a> 56 57</div> 58 59<h3 class="section">Invoking plot_summary</h3> 60 61<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a> 62 63 <p>This section was generated by <strong>AutoGen</strong>, 64using the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program. 65 66<ul class="menu"> 67<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>: plot_summary help/usage (<samp><span class="option">--help</span></samp>) 68<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>: directory option 69<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>: identifier option 70<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>: peer option 71<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>: plot-term option 72<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>: output-file option 73<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>: exit status 74</ul> 75 76<div class="node"> 77<p><hr> 78<a name="plot_summary-usage"></a> 79<a name="plot_005fsummary-usage"></a> 80Next: <a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>, 81Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 82 83</div> 84 85<h4 class="subsection">plot_summary help/usage (<samp><span class="option">--help</span></samp>)</h4> 86 87<p><a name="index-plot_005fsummary-help-3"></a> 88This is the automatically generated usage text for plot_summary. 89 90 <p>The text printed is the same whether selected with the <code>help</code> option 91(<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <code>more-help</code> will print 92the usage text by passing it through a pager program. 93<code>more-help</code> is disabled on platforms without a working 94<code>fork(2)</code> function. The <code>PAGER</code> environment variable is 95used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit 96with a status code of 0. 97 98<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p5 99USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 100 101 --directory=str Where the summary files are 102 --identifier=str Origin of the data 103 --offset-limit=float Limit of absolute offset 104 --peer=str Peers to generate plots for 105 - may appear multiple times 106 --plot-term=str Gnuplot terminal 107 --output-file=str Output file 108 --dont-wait Don't wait for keystroke between plots 109 -?, --help Display usage information and exit 110 --more-help Pass the extended usage text through a pager 111 112Options are specified by doubled hyphens and their name or by a single 113hyphen and the flag character. 114</pre> 115 <div class="node"> 116<p><hr> 117<a name="plot_summary-directory"></a> 118<a name="plot_005fsummary-directory"></a> 119Next: <a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 120Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>, 121Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 122 123</div> 124 125<h4 class="subsection">directory option</h4> 126 127<p><a name="index-plot_005fsummary_002ddirectory-4"></a> 128This is the “where the summary files are” option. 129This option takes a string argument. 130 The directory where the <code>plot_summary</code> will search for the 131 *_summary files generated by <code>summary</code> script. 132<div class="node"> 133<p><hr> 134<a name="plot_summary-identifier"></a> 135<a name="plot_005fsummary-identifier"></a> 136Next: <a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>, 137Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>, 138Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 139 140</div> 141 142<h4 class="subsection">identifier option</h4> 143 144<p><a name="index-plot_005fsummary_002didentifier-5"></a> 145This is the “origin of the data” option. 146This option takes a string argument. 147 Where does the plotted data come from, default to string "host" plus 148 current hostname 149<div class="node"> 150<p><hr> 151<a name="plot_summary-peer"></a> 152<a name="plot_005fsummary-peer"></a> 153Next: <a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 154Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>, 155Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 156 157</div> 158 159<h4 class="subsection">peer option</h4> 160 161<p><a name="index-plot_005fsummary_002dpeer-6"></a> 162This is the “peers to generate plots for” option. 163This option takes a string argument. 164 165<p class="noindent">This option has some usage constraints. It: 166 <ul> 167<li>may appear an unlimited number of times. 168</ul> 169 170 <p>By default the peer_summary plots are not generated. Use this option to 171 specify list of peers if you want to generate plots for them. 172<div class="node"> 173<p><hr> 174<a name="plot_summary-plot-term"></a> 175<a name="plot_005fsummary-plot_002dterm"></a> 176Next: <a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 177Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>, 178Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 179 180</div> 181 182<h4 class="subsection">plot-term option</h4> 183 184<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a> 185This is the “gnuplot terminal” option. 186This option takes a string argument. 187 This is string is passed directly to the <code>gnuplot set terminal</code> 188 command. Default is <code>x11</code> if <code>DISPLAY</code> is set and 189 <code>dumb</code> is it's not'. See output from -e "set 190 terminal") for the list of avalaible options. 191<div class="node"> 192<p><hr> 193<a name="plot_summary-output-file"></a> 194<a name="plot_005fsummary-output_002dfile"></a> 195Next: <a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>, 196Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>, 197Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 198 199</div> 200 201<h4 class="subsection">output-file option</h4> 202 203<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a> 204This is the “output file” option. 205This option takes a str argument. 206 Output file for <code>gnuplot</code>, default to stdout. 207<div class="node"> 208<p><hr> 209<a name="plot_summary-exit-status"></a> 210<a name="plot_005fsummary-exit-status"></a> 211Previous: <a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>, 212Up: <a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a> 213 214</div> 215 216<h4 class="subsection">plot_summary exit status</h4> 217 218<p>One of the following exit values will be returned: 219 <dl> 220<dt>`<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>'<dd>Successful program execution. 221<br><dt>`<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>'<dd>The operation failed or the command syntax was not valid. 222</dl> 223 224</body></html> 225 226