xref: /freebsd/contrib/ntp/scripts/plot_summary.man.in (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
plot_summary 1plot_summaryman "06 Jun 2023" "ntp (4.2.8p17)" "User Commands"

EDIT THIS FILE WITH CAUTION (in-mem file)

It has been AutoGen-ed June 6, 2023 at 04:39:37 AM by AutoGen 5.18.16
From the definitions plot_summary-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]plot_summary - plot statistics generated by summary script
SYNOPSIS
\f\*[B-Font]plot_summary [\f\*[B-Font]--option-name\f[]] [\f\*[B-Font]--option-name\f[] \f\*[I-Font]value\f[]] All arguments must be options.
"DESCRIPTION"
There is no description for this command.
"OPTIONS"

.NOP \f\*[B-Font]--directory\f[]=\f\*[I-Font]string\f[] Where the summary files are. The default \f\*[I-Font]string\f[] for this option is: /tmp The directory where the plot_summary will search for the *_summary files generated by summary script.

.NOP \f\*[B-Font]--identifier\f[]=\f\*[I-Font]string\f[] Origin of the data. Where does the plotted data come from, default to string "host" plus current hostname

.NOP \f\*[B-Font]--offset-limit\f[]=\f\*[I-Font]float\f[] Limit of absolute offset. The default \f\*[I-Font]float\f[] for this option is: 0.128

.NOP \f\*[B-Font]--peer\f[]=\f\*[I-Font]string\f[] Peers to generate plots for. This option may appear an unlimited number of times. 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.

.NOP \f\*[B-Font]--plot-term\f[]=\f\*[I-Font]string\f[] Gnuplot terminal. This is string is passed directly to the gnuplot set terminal command. Default is x11 if DISPLAY is set and dumb is it's not'. See output from @code(gnuplot -e "set terminal") for the list of available options.

.NOP \f\*[B-Font]--output-file\f[]=\f\*[I-Font]str\f[] Output file. Output file for gnuplot, default to stdout.

.NOP \f\*[B-Font]--dont-wait\f[] Don't wait for keystroke between plots.

.NOP \f\*[B-Font]--help\f[] Display usage information and exit.

.NOP \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.

.NOP \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}] 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.

"EXIT STATUS"
One of the following exit values will be returned:

.NOP 0 " (EXIT_SUCCESS)" Successful program execution.

.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.

.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

"NOTES"
This manual page was AutoGen-erated from the plot_summary option definitions.