plot_summary.mdoc.in revision 1.1.1.1
1.Dd December 24 2013 2.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands 3.Os SunOS 5.10 4.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc) 5.\" 6.\" It has been AutoGen-ed December 24, 2013 at 11:36:01 AM by AutoGen 5.18.3pre5 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.El 71There is no description for this command. 72cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc' 73cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd 74 `/`basename "$cvt_prog"` 75cd $tmp_dir 76test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" 77{ 78 list='synopsis description options option\-presets' 79 for f in $list ; do cat $f ; echo ; done 80 rm \-f $list name 81 list='implementation\-notes environment files examples exit\-status errors 82 compatibility see\-also conforming\-to history authors copyright bugs 83 notes' 84 for f in $list ; do cat $f ; echo ; done > .end\-doc 85 rm \-f $list 86 list=`ls \-1 *`' .end\-doc' 87 for f in $list ; do cat $f ; echo ; done 88 rm \-f $list 89} 1>.doc 2>/dev/null 90/usr/local/gnu/bin/grep \-E \-v '^[ ]*$' .doc | $cvt_prog 91.Sh "EXIT STATUS" 92One of the following exit values will be returned: 93.Bl -tag 94.It 0 " (EXIT_SUCCESS)" 95Successful program execution. 96.It 1 " (EXIT_FAILURE)" 97The operation failed or the command syntax was not valid. 98.It 70 " (EX_SOFTWARE)" 99libopts had an internal operational error. Please report 100it to autogen\-users@lists.sourceforge.net. Thank you. 101.El 102.Sh "NOTES" 103This manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP 104option definitions. 105