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