plot_summary.mdoc.in revision 293896
1145522Sdarrenr.Dd January 7 2016 2145522Sdarrenr.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands 353642Sguido.Os 4255332Scy.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc) 5145522Sdarrenr.\" 6145522Sdarrenr.\" It has been AutoGen-ed January 7, 2016 at 11:27:20 PM by AutoGen 5.18.5 7145522Sdarrenr.\" From the definitions plot_summary-opts.def 8255332Scy.\" and the template file agmdoc-cmd.tpl 9145522Sdarrenr.Sh NAME 1053642Sguido.Nm plot_summary 1153642Sguido.Nd plot statistics generated by summary script 1257126Sguido.Sh SYNOPSIS 1353642Sguido.Nm 1453642Sguido.Op Fl \-option\-name 1553642Sguido.Op Fl \-option\-name Ar value 1653642Sguido.Pp 17255332ScyAll arguments must be options. 18255332Scy.Pp 19255332Scy.Sh "DESCRIPTION" 20255332ScyThere is no description for this command. 21255332Scy.Sh "OPTIONS" 2253642Sguido.Bl -tag 23369245Sgit2svn.It Fl \-directory Ns = Ns Ar string 24369245Sgit2svnWhere the summary files are. 25255332ScyThe default 26369245Sgit2svn.Ar string 27369245Sgit2svnfor this option is: 28369245Sgit2svn.ti +4 29369245Sgit2svn /tmp 30369245Sgit2svn.sp 31369245Sgit2svn The directory where the \fBplot_summary\fP will search for the 32369245Sgit2svn *_summary files generated by \fBsummary\fP script. 33369245Sgit2svn.It Fl \-identifier Ns = Ns Ar string 3453642SguidoOrigin of the data. 3553642Sguido.sp 3653642Sguido Where does the plotted data come from, default to string "host" plus 37255332Scy current hostname 3853642Sguido.It Fl \-offset\-limit Ns = Ns Ar float 39145522SdarrenrLimit of absolute offset. 4053642SguidoThe default 4153642Sguido.Ar float 4253642Sguidofor this option is: 43255332Scy.ti +4 44255332Scy 0.128 4553642Sguido.sp 4653642Sguido.It Fl \-peer Ns = Ns Ar string 4753642SguidoPeers to generate plots for. 4853642SguidoThis option may appear an unlimited number of times. 49145522Sdarrenr.sp 50145522Sdarrenr By default the peer_summary plots are not generated. Use this option to 5153642Sguido specify list of peers if you want to generate plots for them. 5253642Sguido.It Fl \-plot\-term Ns = Ns Ar string 5353642SguidoGnuplot terminal. 54255332Scy.sp 55255332Scy This is string is passed directly to the \fBgnuplot set terminal\fP 56145522Sdarrenr command. Default is \fBx11\fP if \fBDISPLAY\fP is set and 57145522Sdarrenr \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set 58145522Sdarrenr terminal") for the list of avalaible options. 59145522Sdarrenr.It Fl \-output\-file Ns = Ns Ar str 60145522SdarrenrOutput file. 61145522Sdarrenr.sp 62145522Sdarrenr Output file for \fBgnuplot\fP, default to stdout. 63145522Sdarrenr.It Fl \-dont\-wait 6453642SguidoDon't wait for keystroke between plots. 6553642Sguido.sp 6653642Sguido.It Fl \-help 67255332ScyDisplay usage information and exit. 68255332Scy.It Fl \-more\-help 69255332ScyPass the extended usage information through a pager. 70255332Scy.It Fl \-version Op Brq Ar v|c|n 71255332ScyOutput version of program and exit. The default mode is `v', a simple 72255332Scyversion. The `c' mode will print copyright information and `n' will 7353642Sguidoprint the full copyright notice. 7453642Sguido.El 75255332Scy.Sh "EXIT STATUS" 76255332ScyOne of the following exit values will be returned: 77255332Scy.Bl -tag 78255332Scy.It 0 " (EXIT_SUCCESS)" 7953642SguidoSuccessful program execution. 80145522Sdarrenr.It 1 " (EXIT_FAILURE)" 81145522SdarrenrThe operation failed or the command syntax was not valid. 82255332Scy.It 70 " (EX_SOFTWARE)" 83255332Scylibopts had an internal operational error. Please report 84255332Scyit to autogen\-users@lists.sourceforge.net. Thank you. 85255332Scy.El 86145522Sdarrenr.Sh "NOTES" 87255332ScyThis manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP 88145522Sdarrenroption definitions. 8953642Sguido