1@node plot_summary Invocation 2@section Invoking plot_summary 3@pindex plot_summary 4@cindex plot statistics generated by summary script 5@ignore 6# 7# EDIT THIS FILE WITH CAUTION (invoke-plot_summary.texi) 8# 9# It has been AutoGen-ed June 6, 2023 at 04:39:36 AM by AutoGen 5.18.16 10# From the definitions plot_summary-opts.def 11# and the template file agtexi-cmd.tpl 12@end ignore 13 14 15This section was generated by @strong{AutoGen}, 16using the @code{agtexi-cmd} template and the option descriptions for the @code{plot_summary} program. 17 18@menu 19* plot_summary usage:: plot_summary help/usage (@option{--help}) 20* plot_summary directory:: directory option 21* plot_summary identifier:: identifier option 22* plot_summary peer:: peer option 23* plot_summary plot-term:: plot-term option 24* plot_summary output-file:: output-file option 25* plot_summary exit status:: exit status 26@end menu 27 28@node plot_summary usage 29@subsection plot_summary help/usage (@option{--help}) 30@cindex plot_summary help 31 32This is the automatically generated usage text for plot_summary. 33 34The text printed is the same whether selected with the @code{help} option 35(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 36the usage text by passing it through a pager program. 37@code{more-help} is disabled on platforms without a working 38@code{fork(2)} function. The @code{PAGER} environment variable is 39used to select the program, defaulting to @file{more}. Both will exit 40with a status code of 0. 41 42@exampleindent 0 43@example 44plot_summary - plot statistics generated by summary script - Ver. 4.2.8p17 45USAGE: plot_summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 46 47 --directory=str Where the summary files are 48 --identifier=str Origin of the data 49 --offset-limit=float Limit of absolute offset 50 --peer=str Peers to generate plots for 51 - may appear multiple times 52 --plot-term=str Gnuplot terminal 53 --output-file=str Output file 54 --dont-wait Don't wait for keystroke between plots 55 -?, --help Display usage information and exit 56 --more-help Pass the extended usage text through a pager 57 58Options are specified by doubled hyphens and their name or by a single 59hyphen and the flag character. 60@end example 61@exampleindent 4 62 63@node plot_summary directory 64@subsection directory option 65@cindex plot_summary-directory 66 67This is the ``where the summary files are'' option. 68This option takes a string argument. 69 The directory where the @code{plot_summary} will search for the 70 *_summary files generated by @code{summary} script. 71@node plot_summary identifier 72@subsection identifier option 73@cindex plot_summary-identifier 74 75This is the ``origin of the data'' option. 76This option takes a string argument. 77 Where does the plotted data come from, default to string "host" plus 78 current hostname 79@node plot_summary peer 80@subsection peer option 81@cindex plot_summary-peer 82 83This is the ``peers to generate plots for'' option. 84This option takes a string argument. 85 86@noindent 87This option has some usage constraints. It: 88@itemize @bullet 89@item 90may appear an unlimited number of times. 91@end itemize 92 93 By default the peer_summary plots are not generated. Use this option to 94 specify list of peers if you want to generate plots for them. 95@node plot_summary plot-term 96@subsection plot-term option 97@cindex plot_summary-plot-term 98 99This is the ``gnuplot terminal'' option. 100This option takes a string argument. 101 This is string is passed directly to the @code{gnuplot set terminal} 102 command. Default is @code{x11} if @code{DISPLAY} is set and 103 @code{dumb} is it's not'. See output from @code(gnuplot -e "set 104 terminal") for the list of available options. 105@node plot_summary output-file 106@subsection output-file option 107@cindex plot_summary-output-file 108 109This is the ``output file'' option. 110This option takes a str argument. 111 Output file for @code{gnuplot}, default to stdout. 112@node plot_summary exit status 113@subsection plot_summary exit status 114 115One of the following exit values will be returned: 116@table @samp 117@item 0 (EXIT_SUCCESS) 118Successful program execution. 119@item 1 (EXIT_FAILURE) 120The operation failed or the command syntax was not valid. 121@end table 122