plot_summary.html revision 275970 
1230426Skib<html lang="en">
2230426Skib<head>
3230426Skib<title>Plot_summary User's Manual</title>
4230426Skib<meta http-equiv="Content-Type" content="text/html">
5230426Skib<meta name="description" content="Plot_summary User's Manual">
6230426Skib<meta name="generator" content="makeinfo 4.7">
7230426Skib<link title="Top" rel="top" href="#Top">
8230426Skib<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9230426Skib<meta http-equiv="Content-Style-Type" content="text/css">
10230426Skib<style type="text/css"><!--
11230426Skib  pre.display { font-family:inherit }
12230426Skib  pre.format  { font-family:inherit }
13230426Skib  pre.smalldisplay { font-family:inherit; font-size:smaller }
14230426Skib  pre.smallformat  { font-family:inherit; font-size:smaller }
15230426Skib  pre.smallexample { font-size:smaller }
16230426Skib  pre.smalllisp    { font-size:smaller }
17230426Skib  span.sc { font-variant:small-caps }
18230426Skib  span.roman { font-family: serif; font-weight: normal; } 
19230426Skib--></style>
20230426Skib</head>
21230426Skib<body>
22230426Skib<h1 class="settitle">Plot_summary User's Manual</h1>
23230426Skib<div class="node">
24230426Skib<p><hr>
25230426Skib<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>,
26230426SkibPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27230426SkibUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28230426Skib<br>
29230426Skib</div>
30230426Skib
31230426Skib<h2 class="unnumbered">Plot_summary User Manual</h2>
32230426Skib
33230426Skib<p>This document describes the use of the NTP Project's <code>plot_summary</code> program. 
34230426SkibThis document applies to version 4.2.8 of <code>plot_summary</code>.
35230426Skib
36230426Skib  <div class="shortcontents">
37230426Skib<h2>Short Contents</h2>
38230426Skib<ul>
39230426Skib<a href="#Top">Plot_summary User Manual</a>
40230426Skib</ul>
41230426Skib</div>
42230426Skib
43230426Skib<ul class="menu">
44230426Skib<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>:              Description
45230426Skib<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: 		    Invoking plot_summary
46230426Skib</ul>
47230426Skib
48230426Skib<div class="node">
49230426Skib<p><hr>
50230426Skib<a name="plot_005fsummary-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>,
51230426SkibUp:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
52230426Skib<br>
53230426Skib</div>
54230426Skib
55230426Skib<h3 class="section">Invoking plot_summary</h3>
56230426Skib
57230426Skib<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a>
58230426Skib
59230426Skib  <p>This section was generated by <strong>AutoGen</strong>,
60230426Skibusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
61230426Skib
62230426Skib<ul class="menu">
63230426Skib<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>:                   plot_summary help/usage (<span class="option">--help</span>)
64230426Skib<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>:               directory option
65230426Skib<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>:              identifier option
66230426Skib<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>:                    peer option
67230426Skib<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>:               plot-term option
68230426Skib<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>:             output-file option
69230426Skib<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>:             exit status
70230426Skib</ul>
71230426Skib
72230426Skib<div class="node">
73230426Skib<p><hr>
74230426Skib<a name="plot_005fsummary-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>,
75230426SkibUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
76230426Skib<br>
77230426Skib</div>
78230426Skib
79230426Skib<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4>
80230426Skib
81230426Skib<p><a name="index-plot_005fsummary-help-3"></a>
82230426SkibThis is the automatically generated usage text for plot_summary.
83230426Skib
84230426Skib  <p>The text printed is the same whether selected with the <code>help</code> option
85230426Skib(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
86230426Skibthe usage text by passing it through a pager program. 
87230426Skib<code>more-help</code> is disabled on platforms without a working
88230426Skib<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
89230426Skibused to select the program, defaulting to <span class="file">more</span>.  Both will exit
90230426Skibwith a status code of 0.
91230426Skib
92230426Skib<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8
93230426SkibUSAGE: plot_summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
94230426Skib
95230426Skib        --directory=str          Where the summary files are
96230426Skib        --identifier=str         Origin of the data
97230426Skib        --offset-limit=float     Limit of absolute offset
98230426Skib        --peer=str               Peers to generate plots for
99230426Skib                                   - may appear multiple times
100230426Skib        --plot-term=str          Gnuplot terminal
101230426Skib        --output-file=str        Output file
102230426Skib        --dont-wait              Don't wait for keystroke between plots
103230426Skib    -?, --help                   Display usage information and exit
104230426Skib        --more-help              Pass the extended usage text through a pager
105230426Skib
106230426SkibOptions are specified by doubled hyphens and their name or by a single
107230426Skibhyphen and the flag character.
108230426Skib</pre>
109230426Skib  <div class="node">
110230426Skib<p><hr>
111230426Skib<a name="plot_005fsummary-directory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
112230426SkibPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>,
113230426SkibUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
114230426Skib<br>
115230426Skib</div>
116230426Skib
117230426Skib<h4 class="subsection">directory option</h4>
118230426Skib
119230426Skib<p><a name="index-plot_005fsummary_002ddirectory-4"></a>
120230426SkibThis is the &ldquo;where the summary files are&rdquo; option. 
121230426SkibThis option takes a string argument. 
122230426Skib        The directory where the <code>plot_summary</code> will search for the
123230426Skib        *_summary files generated by <code>summary</code> script. 
124230426Skib<div class="node">
125230426Skib<p><hr>
126230426Skib<a name="plot_005fsummary-identifier"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>,
127230426SkibPrevious:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>,
128230426SkibUp:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
129230426Skib<br>
130230426Skib</div>
131230426Skib
132230426Skib<h4 class="subsection">identifier option</h4>
133230426Skib
134230426Skib<p><a name="index-plot_005fsummary_002didentifier-5"></a>
135230426SkibThis is the &ldquo;origin of the data&rdquo; option. 
136230426SkibThis option takes a string argument. 
137230426Skib        Where does the plotted data come from, default to string "host" plus
138230426Skib        current hostname
139230426Skib<div class="node">
140230426Skib<p><hr>
141230426Skib<a name="plot_005fsummary-peer"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
142Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
143Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
144<br>
145</div>
146
147<h4 class="subsection">peer option</h4>
148
149<p><a name="index-plot_005fsummary_002dpeer-6"></a>
150This is the &ldquo;peers to generate plots for&rdquo; option. 
151This option takes a string argument.
152
153<p class="noindent">This option has some usage constraints.  It:
154     <ul>
155<li>may appear an unlimited number of times. 
156</ul>
157
158  <p>By default the peer_summary plots are not generated. Use this option to
159        specify list of peers if you want to generate plots for them. 
160<div class="node">
161<p><hr>
162<a name="plot_005fsummary-plot_002dterm"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
163Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-peer">plot_summary peer</a>,
164Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
165<br>
166</div>
167
168<h4 class="subsection">plot-term option</h4>
169
170<p><a name="index-plot_005fsummary_002dplot_002dterm-7"></a>
171This is the &ldquo;gnuplot terminal&rdquo; option. 
172This option takes a string argument. 
173        This is string is passed directly to the <code>gnuplot set terminal</code>
174        command.  Default is <code>x11</code> if <code>DISPLAY</code> is set and
175        <code>dumb</code> is it's not'. See output from  -e "set
176        terminal") for the list of avalaible options. 
177<div class="node">
178<p><hr>
179<a name="plot_005fsummary-output_002dfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-exit-status">plot_summary exit status</a>,
180Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>,
181Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
182<br>
183</div>
184
185<h4 class="subsection">output-file option</h4>
186
187<p><a name="index-plot_005fsummary_002doutput_002dfile-8"></a>
188This is the &ldquo;output file&rdquo; option. 
189This option takes a str argument. 
190        Output file for <code>gnuplot</code>, default to stdout. 
191<div class="node">
192<p><hr>
193<a name="plot_005fsummary-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>,
194Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
195<br>
196</div>
197
198<h4 class="subsection">plot_summary exit status</h4>
199
200<p>One of the following exit values will be returned:
201     <dl>
202<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
203<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
204</dl>
205
206</body></html>
207
208