1275970Scy@node plot_summary Invocation 2275970Scy@section Invoking plot_summary 3275970Scy@pindex plot_summary 4275970Scy@cindex plot statistics generated by summary script 5275970Scy@ignore 6275970Scy# 7275970Scy# EDIT THIS FILE WITH CAUTION (invoke-plot_summary.texi) 8275970Scy# 9338531Sdelphij# It has been AutoGen-ed August 14, 2018 at 08:09:41 AM by AutoGen 5.18.5 10275970Scy# From the definitions plot_summary-opts.def 11275970Scy# and the template file agtexi-cmd.tpl 12275970Scy@end ignore 13275970Scy 14275970Scy 15275970ScyThis section was generated by @strong{AutoGen}, 16275970Scyusing the @code{agtexi-cmd} template and the option descriptions for the @code{plot_summary} program. 17275970Scy 18275970Scy@menu 19275970Scy* plot_summary usage:: plot_summary help/usage (@option{--help}) 20275970Scy* plot_summary directory:: directory option 21275970Scy* plot_summary identifier:: identifier option 22275970Scy* plot_summary peer:: peer option 23275970Scy* plot_summary plot-term:: plot-term option 24275970Scy* plot_summary output-file:: output-file option 25275970Scy* plot_summary exit status:: exit status 26275970Scy@end menu 27275970Scy 28275970Scy@node plot_summary usage 29275970Scy@subsection plot_summary help/usage (@option{--help}) 30275970Scy@cindex plot_summary help 31275970Scy 32275970ScyThis is the automatically generated usage text for plot_summary. 33275970Scy 34275970ScyThe text printed is the same whether selected with the @code{help} option 35275970Scy(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 36275970Scythe usage text by passing it through a pager program. 37275970Scy@code{more-help} is disabled on platforms without a working 38275970Scy@code{fork(2)} function. The @code{PAGER} environment variable is 39275970Scyused to select the program, defaulting to @file{more}. Both will exit 40275970Scywith a status code of 0. 41275970Scy 42275970Scy@exampleindent 0 43275970Scy@example 44338531Sdelphijplot_summary - plot statistics generated by summary script - Ver. 4.2.8p12 45275970ScyUSAGE: plot_summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 46275970Scy 47275970Scy --directory=str Where the summary files are 48275970Scy --identifier=str Origin of the data 49275970Scy --offset-limit=float Limit of absolute offset 50275970Scy --peer=str Peers to generate plots for 51275970Scy - may appear multiple times 52275970Scy --plot-term=str Gnuplot terminal 53275970Scy --output-file=str Output file 54275970Scy --dont-wait Don't wait for keystroke between plots 55275970Scy -?, --help Display usage information and exit 56275970Scy --more-help Pass the extended usage text through a pager 57275970Scy 58275970ScyOptions are specified by doubled hyphens and their name or by a single 59275970Scyhyphen and the flag character. 60275970Scy@end example 61275970Scy@exampleindent 4 62275970Scy 63275970Scy@node plot_summary directory 64275970Scy@subsection directory option 65275970Scy@cindex plot_summary-directory 66275970Scy 67275970ScyThis is the ``where the summary files are'' option. 68275970ScyThis option takes a string argument. 69275970Scy The directory where the @code{plot_summary} will search for the 70275970Scy *_summary files generated by @code{summary} script. 71275970Scy@node plot_summary identifier 72275970Scy@subsection identifier option 73275970Scy@cindex plot_summary-identifier 74275970Scy 75275970ScyThis is the ``origin of the data'' option. 76275970ScyThis option takes a string argument. 77275970Scy Where does the plotted data come from, default to string "host" plus 78275970Scy current hostname 79275970Scy@node plot_summary peer 80275970Scy@subsection peer option 81275970Scy@cindex plot_summary-peer 82275970Scy 83275970ScyThis is the ``peers to generate plots for'' option. 84275970ScyThis option takes a string argument. 85275970Scy 86275970Scy@noindent 87275970ScyThis option has some usage constraints. It: 88275970Scy@itemize @bullet 89275970Scy@item 90275970Scymay appear an unlimited number of times. 91275970Scy@end itemize 92275970Scy 93275970Scy By default the peer_summary plots are not generated. Use this option to 94275970Scy specify list of peers if you want to generate plots for them. 95275970Scy@node plot_summary plot-term 96275970Scy@subsection plot-term option 97275970Scy@cindex plot_summary-plot-term 98275970Scy 99275970ScyThis is the ``gnuplot terminal'' option. 100275970ScyThis option takes a string argument. 101275970Scy This is string is passed directly to the @code{gnuplot set terminal} 102275970Scy command. Default is @code{x11} if @code{DISPLAY} is set and 103275970Scy @code{dumb} is it's not'. See output from @code(gnuplot -e "set 104301256Sdelphij terminal") for the list of available options. 105275970Scy@node plot_summary output-file 106275970Scy@subsection output-file option 107275970Scy@cindex plot_summary-output-file 108275970Scy 109275970ScyThis is the ``output file'' option. 110275970ScyThis option takes a str argument. 111275970Scy Output file for @code{gnuplot}, default to stdout. 112275970Scy@node plot_summary exit status 113275970Scy@subsection plot_summary exit status 114275970Scy 115275970ScyOne of the following exit values will be returned: 116275970Scy@table @samp 117275970Scy@item 0 (EXIT_SUCCESS) 118275970ScySuccessful program execution. 119275970Scy@item 1 (EXIT_FAILURE) 120275970ScyThe operation failed or the command syntax was not valid. 121275970Scy@end table 122