xref: /freebsd/contrib/ntp/scripts/plot_summary.html (revision 273c26a3c3bea87a241d6879abd4f991db180bf0)
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.7">
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--></style>
20</head>
21<body>
22<h1 class="settitle">Plot_summary User's Manual</h1>
23<div class="node">
24<p><hr>
25<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-Description">plot_summary Description</a>,
26Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28<br>
29</div>
30
31<h2 class="unnumbered">Plot_summary User Manual</h2>
32
33<p>This document describes the use of the NTP Project's <code>plot_summary</code> program.
34This document applies to version 4.2.8p8 of <code>plot_summary</code>.
35
36  <div class="shortcontents">
37<h2>Short Contents</h2>
38<ul>
39<a href="#Top">Plot_summary User Manual</a>
40</ul>
41</div>
42
43<ul class="menu">
44<li><a accesskey="1" href="#plot_005fsummary-Description">plot_summary Description</a>:              Description
45<li><a accesskey="2" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>: 		    Invoking plot_summary
46</ul>
47
48<div class="node">
49<p><hr>
50<a name="plot_005fsummary-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-Description">plot_summary Description</a>,
51Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
52<br>
53</div>
54
55<h3 class="section">Invoking plot_summary</h3>
56
57<p><a name="index-plot_005fsummary-1"></a><a name="index-plot-statistics-generated-by-summary-script-2"></a>
58
59  <p>This section was generated by <strong>AutoGen</strong>,
60using the <code>agtexi-cmd</code> template and the option descriptions for the <code>plot_summary</code> program.
61
62<ul class="menu">
63<li><a accesskey="1" href="#plot_005fsummary-usage">plot_summary usage</a>:                   plot_summary help/usage (<span class="option">--help</span>)
64<li><a accesskey="2" href="#plot_005fsummary-directory">plot_summary directory</a>:               directory option
65<li><a accesskey="3" href="#plot_005fsummary-identifier">plot_summary identifier</a>:              identifier option
66<li><a accesskey="4" href="#plot_005fsummary-peer">plot_summary peer</a>:                    peer option
67<li><a accesskey="5" href="#plot_005fsummary-plot_002dterm">plot_summary plot-term</a>:               plot-term option
68<li><a accesskey="6" href="#plot_005fsummary-output_002dfile">plot_summary output-file</a>:             output-file option
69<li><a accesskey="7" href="#plot_005fsummary-exit-status">plot_summary exit status</a>:             exit status
70</ul>
71
72<div class="node">
73<p><hr>
74<a name="plot_005fsummary-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-directory">plot_summary directory</a>,
75Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
76<br>
77</div>
78
79<h4 class="subsection">plot_summary help/usage (<span class="option">--help</span>)</h4>
80
81<p><a name="index-plot_005fsummary-help-3"></a>
82This is the automatically generated usage text for plot_summary.
83
84  <p>The text printed is the same whether selected with the <code>help</code> option
85(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
86the usage text by passing it through a pager program.
87<code>more-help</code> is disabled on platforms without a working
88<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
89used to select the program, defaulting to <span class="file">more</span>.  Both will exit
90with a status code of 0.
91
92<pre class="example">plot_summary - plot statistics generated by summary script - Ver. 4.2.8p8
93USAGE: plot_summary [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
94
95        --directory=str          Where the summary files are
96        --identifier=str         Origin of the data
97        --offset-limit=float     Limit of absolute offset
98        --peer=str               Peers to generate plots for
99                                   - may appear multiple times
100        --plot-term=str          Gnuplot terminal
101        --output-file=str        Output file
102        --dont-wait              Don't wait for keystroke between plots
103    -?, --help                   Display usage information and exit
104        --more-help              Pass the extended usage text through a pager
105
106Options are specified by doubled hyphens and their name or by a single
107hyphen and the flag character.
108</pre>
109  <div class="node">
110<p><hr>
111<a name="plot_005fsummary-directory"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-identifier">plot_summary identifier</a>,
112Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-usage">plot_summary usage</a>,
113Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
114<br>
115</div>
116
117<h4 class="subsection">directory option</h4>
118
119<p><a name="index-plot_005fsummary_002ddirectory-4"></a>
120This is the &ldquo;where the summary files are&rdquo; option.
121This option takes a string argument.
122        The directory where the <code>plot_summary</code> will search for the
123        *_summary files generated by <code>summary</code> script.
124<div class="node">
125<p><hr>
126<a name="plot_005fsummary-identifier"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#plot_005fsummary-peer">plot_summary peer</a>,
127Previous:&nbsp;<a rel="previous" accesskey="p" href="#plot_005fsummary-directory">plot_summary directory</a>,
128Up:&nbsp;<a rel="up" accesskey="u" href="#plot_005fsummary-Invocation">plot_summary Invocation</a>
129<br>
130</div>
131
132<h4 class="subsection">identifier option</h4>
133
134<p><a name="index-plot_005fsummary_002didentifier-5"></a>
135This is the &ldquo;origin of the data&rdquo; option.
136This option takes a string argument.
137        Where does the plotted data come from, default to string "host" plus
138        current hostname
139<div class="node">
140<p><hr>
141<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 available 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