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