xref: /freebsd/contrib/ntp/scripts/plot_summary.mdoc.in (revision f5f40dd63bc7acbb5312b26ac1ea1103c12352a6)

.Dd May 25 2024
.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
.Os
.\"  EDIT THIS FILE WITH CAUTION  (plot_summary-opts.mdoc)
.\"
.\"  It has been AutoGen-ed  May 25, 2024 at 12:06:00 AM by AutoGen 5.18.16
.\"  From the definitions    plot_summary-opts.def
.\"  and the template file   agmdoc-cmd.tpl
.Sh NAME
.Nm plot_summary
.Nd plot statistics generated by summary script
.Sh SYNOPSIS
.Nm
.Op Fl \-option\-name
.Op Fl \-option\-name Ar value
.Pp
All arguments must be options.
.Pp
.Sh "DESCRIPTION"
There is no description for this command.
.Sh "OPTIONS"
.Bl -tag
.It  Fl \-directory  Ns = Ns Ar string
Where the summary files are.
The default
.Ar string
for this option is:
.ti +4
 /tmp
.sp
        The directory where the \fBplot_summary\fP will search for the
        *_summary files generated by \fBsummary\fP script.
.It  Fl \-identifier  Ns = Ns Ar string
Origin of the data.
.sp
        Where does the plotted data come from, default to string "host" plus
        current hostname
.It  Fl \-offset\-limit  Ns = Ns Ar float
Limit of absolute offset.
The default
.Ar float
for this option is:
.ti +4
 0.128
.sp
.It  Fl \-peer  Ns = Ns Ar string
Peers to generate plots for.
This option may appear an unlimited number of times.
.sp
        By default the peer_summary plots are not generated. Use this option to
        specify list of peers if you want to generate plots for them.
.It  Fl \-plot\-term  Ns = Ns Ar string
Gnuplot terminal.
.sp
        This is string is passed directly to the \fBgnuplot set terminal\fP
        command.  Default is \fBx11\fP if \fBDISPLAY\fP is set and
        \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set
        terminal") for the list of available options.
.It  Fl \-output\-file  Ns = Ns Ar str
Output file.
.sp
        Output file for \fBgnuplot\fP, default to stdout.
.It  Fl \-dont\-wait
Don't wait for keystroke between plots.
.sp
.It Fl \-help
Display usage information and exit.
.It Fl \-more\-help
Pass the extended usage information through a pager.
.It Fl \-version Op Brq Ar v|c|n
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.El
.Sh "EXIT STATUS"
One of the following exit values will be returned:
.Bl -tag
.It 0 " (EXIT_SUCCESS)"
Successful program execution.
.It 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.It 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen\-users@lists.sourceforge.net.  Thank you.
.El
.Sh "NOTES"
This manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP
option definitions.