plot_summary.man.in revision 293896 
1.de1 NOP
2.  it 1 an-trap
3.  if \\n[.$] \,\\$*\/
4..
5.ie t \
6.ds B-Font [CB]
7.ds I-Font [CI]
8.ds R-Font [CR]
9.el \
10.ds B-Font B
11.ds I-Font I
12.ds R-Font R
13.TH plot_summary 1plot_summaryman "07 Jan 2016" "ntp (4.2.8p5)" "User Commands"
14.\"
15.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-xiaqKm/ag-KiayJm)
16.\"
17.\" It has been AutoGen-ed January 7, 2016 at 11:27:18 PM by AutoGen 5.18.5
18.\" From the definitions plot_summary-opts.def
19.\" and the template file agman-cmd.tpl
20.SH NAME
21\f\*[B-Font]plot_summary\fP
22\- plot statistics generated by summary script
23.SH SYNOPSIS
24\f\*[B-Font]plot_summary\fP
25[\f\*[B-Font]\-\-option-name\f[]]
26[\f\*[B-Font]\-\-option-name\f[] \f\*[I-Font]value\f[]]
27.sp \n(Ppu
28.ne 2
29
30All arguments must be options.
31.sp \n(Ppu
32.ne 2
33
34.SH "DESCRIPTION"
35There is no description for this command.
36.SH "OPTIONS"
37.TP
38.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[]
39Where the summary files are.
40The default
41\f\*[I-Font]string\f[]
42for this option is:
43.ti +4
44 /tmp
45.sp
46        The directory where the \fBplot_summary\fP will search for the
47        *_summary files generated by \fBsummary\fP script.
48.TP
49.NOP \f\*[B-Font]\-\-identifier\f[]=\f\*[I-Font]string\f[]
50Origin of the data.
51.sp
52        Where does the plotted data come from, default to string "host" plus
53        current hostname
54.TP
55.NOP \f\*[B-Font]\-\-offset\-limit\f[]=\f\*[I-Font]float\f[]
56Limit of absolute offset.
57The default
58\f\*[I-Font]float\f[]
59for this option is:
60.ti +4
61 0.128
62.sp
63.TP
64.NOP \f\*[B-Font]\-\-peer\f[]=\f\*[I-Font]string\f[]
65Peers to generate plots for.
66This option may appear an unlimited number of times.
67.sp
68        By default the peer_summary plots are not generated. Use this option to
69        specify list of peers if you want to generate plots for them.
70.TP
71.NOP \f\*[B-Font]\-\-plot\-term\f[]=\f\*[I-Font]string\f[]
72Gnuplot terminal.
73.sp
74        This is string is passed directly to the \fBgnuplot set terminal\fP
75        command.  Default is \fBx11\fP if \fBDISPLAY\fP is set and
76        \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set
77        terminal") for the list of avalaible options.
78.TP
79.NOP \f\*[B-Font]\-\-output\-file\f[]=\f\*[I-Font]str\f[]
80Output file.
81.sp
82        Output file for \fBgnuplot\fP, default to stdout.
83.TP
84.NOP \f\*[B-Font]\-\-dont\-wait\f[]
85Don't wait for keystroke between plots.
86.sp
87.TP
88.NOP \f\*[B-Font]\-\-help\f[]
89Display usage information and exit.
90.TP
91.NOP \f\*[B-Font]\-\-more-help\f[]
92Pass the extended usage information through a pager.
93.TP
94.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]
95Output version of program and exit.  The default mode is `v', a simple
96version.  The `c' mode will print copyright information and `n' will
97print the full copyright notice.
98.PP
99.SH "EXIT STATUS"
100One of the following exit values will be returned:
101.TP
102.NOP 0 " (EXIT_SUCCESS)"
103Successful program execution.
104.TP
105.NOP 1 " (EXIT_FAILURE)"
106The operation failed or the command syntax was not valid.
107.TP
108.NOP 70 " (EX_SOFTWARE)"
109libopts had an internal operational error.  Please report
110it to autogen-users@lists.sourceforge.net.  Thank you.
111.PP
112.SH "NOTES"
113This manual page was \fIAutoGen\fP-erated from the \fBplot_summary\fP
114option definitions.
115