xref: /freebsd/contrib/ntp/scripts/plot_summary.mdoc.in (revision 2b15cb3d0922bd70ea592f0da9b4a5b167f4d53f)
1*2b15cb3dSCy Schubert.Dd February 4 2015
2*2b15cb3dSCy Schubert.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
3*2b15cb3dSCy Schubert.Os
4*2b15cb3dSCy Schubert.\"  EDIT THIS FILE WITH CAUTION  (plot_summary-opts.mdoc)
5*2b15cb3dSCy Schubert.\"
6*2b15cb3dSCy Schubert.\"  It has been AutoGen-ed  February  4, 2015 at 02:37:57 AM by AutoGen 5.18.5pre4
7*2b15cb3dSCy Schubert.\"  From the definitions    plot_summary-opts.def
8*2b15cb3dSCy Schubert.\"  and the template file   agmdoc-cmd.tpl
9*2b15cb3dSCy Schubert.Sh NAME
10*2b15cb3dSCy Schubert.Nm plot_summary
11*2b15cb3dSCy Schubert.Nd plot statistics generated by summary script
12*2b15cb3dSCy Schubert.Sh SYNOPSIS
13*2b15cb3dSCy Schubert.Nm
14*2b15cb3dSCy Schubert.Op Fl \-option\-name
15*2b15cb3dSCy Schubert.Op Fl \-option\-name Ar value
16*2b15cb3dSCy Schubert.Pp
17*2b15cb3dSCy SchubertAll arguments must be options.
18*2b15cb3dSCy Schubert.Pp
19*2b15cb3dSCy Schubert.Sh "DESCRIPTION"
20*2b15cb3dSCy SchubertThere is no description for this command.
21*2b15cb3dSCy Schubert.Sh "OPTIONS"
22*2b15cb3dSCy Schubert.Bl -tag
23*2b15cb3dSCy Schubert.It  Fl \-directory  Ns = Ns Ar string
24*2b15cb3dSCy SchubertWhere the summary files are.
25*2b15cb3dSCy SchubertThe default
26*2b15cb3dSCy Schubert.Ar string
27*2b15cb3dSCy Schubertfor this option is:
28*2b15cb3dSCy Schubert.ti +4
29*2b15cb3dSCy Schubert /tmp
30*2b15cb3dSCy Schubert.sp
31*2b15cb3dSCy Schubert        The directory where the \fBplot_summary\fP will search for the
32*2b15cb3dSCy Schubert        *_summary files generated by \fBsummary\fP script.
33*2b15cb3dSCy Schubert.It  Fl \-identifier  Ns = Ns Ar string
34*2b15cb3dSCy SchubertOrigin of the data.
35*2b15cb3dSCy Schubert.sp
36*2b15cb3dSCy Schubert        Where does the plotted data come from, default to string "host" plus
37*2b15cb3dSCy Schubert        current hostname
38*2b15cb3dSCy Schubert.It  Fl \-offset\-limit  Ns = Ns Ar float
39*2b15cb3dSCy SchubertLimit of absolute offset.
40*2b15cb3dSCy SchubertThe default
41*2b15cb3dSCy Schubert.Ar float
42*2b15cb3dSCy Schubertfor this option is:
43*2b15cb3dSCy Schubert.ti +4
44*2b15cb3dSCy Schubert 0.128
45*2b15cb3dSCy Schubert.sp
46*2b15cb3dSCy Schubert.It  Fl \-peer  Ns = Ns Ar string
47*2b15cb3dSCy SchubertPeers to generate plots for.
48*2b15cb3dSCy SchubertThis option may appear an unlimited number of times.
49*2b15cb3dSCy Schubert.sp
50*2b15cb3dSCy Schubert        By default the peer_summary plots are not generated. Use this option to
51*2b15cb3dSCy Schubert        specify list of peers if you want to generate plots for them.
52*2b15cb3dSCy Schubert.It  Fl \-plot\-term  Ns = Ns Ar string
53*2b15cb3dSCy SchubertGnuplot terminal.
54*2b15cb3dSCy Schubert.sp
55*2b15cb3dSCy Schubert        This is string is passed directly to the \fBgnuplot set terminal\fP
56*2b15cb3dSCy Schubert        command.  Default is \fBx11\fP if \fBDISPLAY\fP is set and
57*2b15cb3dSCy Schubert        \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set
58*2b15cb3dSCy Schubert        terminal") for the list of avalaible options.
59*2b15cb3dSCy Schubert.It  Fl \-output\-file  Ns = Ns Ar str
60*2b15cb3dSCy SchubertOutput file.
61*2b15cb3dSCy Schubert.sp
62*2b15cb3dSCy Schubert        Output file for \fBgnuplot\fP, default to stdout.
63*2b15cb3dSCy Schubert.It  Fl \-dont\-wait
64*2b15cb3dSCy SchubertDon't wait for keystroke between plots.
65*2b15cb3dSCy Schubert.sp
66*2b15cb3dSCy Schubert.It Fl \-help
67*2b15cb3dSCy SchubertDisplay usage information and exit.
68*2b15cb3dSCy Schubert.It Fl \-more\-help
69*2b15cb3dSCy SchubertPass the extended usage information through a pager.
70*2b15cb3dSCy Schubert.It Fl \-version Op Brq Ar v|c|n
71*2b15cb3dSCy SchubertOutput version of program and exit.  The default mode is `v', a simple
72*2b15cb3dSCy Schubertversion.  The `c' mode will print copyright information and `n' will
73*2b15cb3dSCy Schubertprint the full copyright notice.
74*2b15cb3dSCy Schubert.El
75*2b15cb3dSCy Schubert.Sh "EXIT STATUS"
76*2b15cb3dSCy SchubertOne of the following exit values will be returned:
77*2b15cb3dSCy Schubert.Bl -tag
78*2b15cb3dSCy Schubert.It 0 " (EXIT_SUCCESS)"
79*2b15cb3dSCy SchubertSuccessful program execution.
80*2b15cb3dSCy Schubert.It 1 " (EXIT_FAILURE)"
81*2b15cb3dSCy SchubertThe operation failed or the command syntax was not valid.
82*2b15cb3dSCy Schubert.It 70 " (EX_SOFTWARE)"
83*2b15cb3dSCy Schubertlibopts had an internal operational error.  Please report
84*2b15cb3dSCy Schubertit to autogen\-users@lists.sourceforge.net.  Thank you.
85*2b15cb3dSCy Schubert.El
86*2b15cb3dSCy Schubert.Sh "NOTES"
87*2b15cb3dSCy SchubertThis manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP
88*2b15cb3dSCy Schubertoption definitions.
89