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