1316722Sdelphij.Dd March 21 2017
2275970Scy.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
3275970Scy.Os
4275970Scy.\"  EDIT THIS FILE WITH CAUTION  (plot_summary-opts.mdoc)
5275970Scy.\"
6316722Sdelphij.\"  It has been AutoGen-ed  March 21, 2017 at 10:40:44 AM by AutoGen 5.18.5
7275970Scy.\"  From the definitions    plot_summary-opts.def
8275970Scy.\"  and the template file   agmdoc-cmd.tpl
9275970Scy.Sh NAME
10275970Scy.Nm plot_summary
11275970Scy.Nd plot statistics generated by summary script
12275970Scy.Sh SYNOPSIS
13275970Scy.Nm
14275970Scy.Op Fl \-option\-name
15275970Scy.Op Fl \-option\-name Ar value
16275970Scy.Pp
17275970ScyAll arguments must be options.
18275970Scy.Pp
19275970Scy.Sh "DESCRIPTION"
20275970ScyThere is no description for this command.
21275970Scy.Sh "OPTIONS"
22275970Scy.Bl -tag
23275970Scy.It  Fl \-directory  Ns = Ns Ar string 
24275970ScyWhere the summary files are.
25275970ScyThe default
26275970Scy.Ar string
27275970Scyfor this option is:
28275970Scy.ti +4
29275970Scy /tmp
30275970Scy.sp
31275970Scy        The directory where the \fBplot_summary\fP will search for the
32275970Scy        *_summary files generated by \fBsummary\fP script.
33275970Scy.It  Fl \-identifier  Ns = Ns Ar string 
34275970ScyOrigin of the data.
35275970Scy.sp
36275970Scy        Where does the plotted data come from, default to string "host" plus
37275970Scy        current hostname
38275970Scy.It  Fl \-offset\-limit  Ns = Ns Ar float 
39275970ScyLimit of absolute offset.
40275970ScyThe default
41275970Scy.Ar float
42275970Scyfor this option is:
43275970Scy.ti +4
44275970Scy 0.128
45275970Scy.sp
46275970Scy.It  Fl \-peer  Ns = Ns Ar string 
47275970ScyPeers to generate plots for.
48275970ScyThis option may appear an unlimited number of times.
49275970Scy.sp
50275970Scy        By default the peer_summary plots are not generated. Use this option to
51275970Scy        specify list of peers if you want to generate plots for them.
52275970Scy.It  Fl \-plot\-term  Ns = Ns Ar string 
53275970ScyGnuplot terminal.
54275970Scy.sp
55275970Scy        This is string is passed directly to the \fBgnuplot set terminal\fP
56275970Scy        command.  Default is \fBx11\fP if \fBDISPLAY\fP is set and
57275970Scy        \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set
58301247Sdelphij        terminal") for the list of available options.
59275970Scy.It  Fl \-output\-file  Ns = Ns Ar str 
60275970ScyOutput file.
61275970Scy.sp
62275970Scy        Output file for \fBgnuplot\fP, default to stdout.
63275970Scy.It  Fl \-dont\-wait 
64275970ScyDon't wait for keystroke between plots.
65275970Scy.sp
66275970Scy.It Fl \-help
67275970ScyDisplay usage information and exit.
68275970Scy.It Fl \-more\-help
69275970ScyPass the extended usage information through a pager.
70275970Scy.It Fl \-version Op Brq Ar v|c|n
71275970ScyOutput version of program and exit.  The default mode is `v', a simple
72275970Scyversion.  The `c' mode will print copyright information and `n' will
73275970Scyprint the full copyright notice.
74275970Scy.El
75275970Scy.Sh "EXIT STATUS"
76275970ScyOne of the following exit values will be returned:
77275970Scy.Bl -tag
78275970Scy.It 0 " (EXIT_SUCCESS)"
79275970ScySuccessful program execution.
80275970Scy.It 1 " (EXIT_FAILURE)"
81275970ScyThe operation failed or the command syntax was not valid.
82275970Scy.It 70 " (EX_SOFTWARE)"
83275970Scylibopts had an internal operational error.  Please report
84275970Scyit to autogen\-users@lists.sourceforge.net.  Thank you.
85275970Scy.El
86275970Scy.Sh "NOTES"
87275970ScyThis manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP
88275970Scyoption definitions.
89