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