invoke-plot_summary.texi revision 298699
139213Sgibbs@node plot_summary Invocation 239213Sgibbs@section Invoking plot_summary 371752Sken@pindex plot_summary 439213Sgibbs@cindex plot statistics generated by summary script 539213Sgibbs@ignore 639213Sgibbs# 739213Sgibbs# EDIT THIS FILE WITH CAUTION (invoke-plot_summary.texi) 839213Sgibbs# 939213Sgibbs# It has been AutoGen-ed April 26, 2016 at 08:25:00 PM by AutoGen 5.18.5 1039213Sgibbs# From the definitions plot_summary-opts.def 1139213Sgibbs# and the template file agtexi-cmd.tpl 1239213Sgibbs@end ignore 1339213Sgibbs 1439213Sgibbs 1539213SgibbsThis section was generated by @strong{AutoGen}, 1639213Sgibbsusing the @code{agtexi-cmd} template and the option descriptions for the @code{plot_summary} program. 1739213Sgibbs 1839213Sgibbs@menu 1939213Sgibbs* plot_summary usage:: plot_summary help/usage (@option{--help}) 2039213Sgibbs* plot_summary directory:: directory option 2139213Sgibbs* plot_summary identifier:: identifier option 2239213Sgibbs* plot_summary peer:: peer option 2339213Sgibbs* plot_summary plot-term:: plot-term option 2439213Sgibbs* plot_summary output-file:: output-file option 2539213Sgibbs* plot_summary exit status:: exit status 2639213Sgibbs@end menu 2750477Speter 2839213Sgibbs@node plot_summary usage 2939213Sgibbs@subsection plot_summary help/usage (@option{--help}) 3039213Sgibbs@cindex plot_summary help 3139213Sgibbs 3239213SgibbsThis is the automatically generated usage text for plot_summary. 3339213Sgibbs 3439213SgibbsThe text printed is the same whether selected with the @code{help} option 3539213Sgibbs(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 3639213Sgibbsthe usage text by passing it through a pager program. 3739213Sgibbs@code{more-help} is disabled on platforms without a working 3839213Sgibbs@code{fork(2)} function. The @code{PAGER} environment variable is 3939213Sgibbsused to select the program, defaulting to @file{more}. Both will exit 4039213Sgibbswith a status code of 0. 4139213Sgibbs 4239213Sgibbs@exampleindent 0 4339213Sgibbs@example 4439213Sgibbsplot_summary - plot statistics generated by summary script - Ver. 4.2.8p7 4539213SgibbsUSAGE: plot_summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 4639213Sgibbs 4739213Sgibbs --directory=str Where the summary files are 4839213Sgibbs --identifier=str Origin of the data 4940020Sken --offset-limit=float Limit of absolute offset 5039213Sgibbs --peer=str Peers to generate plots for 5139213Sgibbs - may appear multiple times 5239213Sgibbs --plot-term=str Gnuplot terminal 5339213Sgibbs --output-file=str Output file 5460041Sphk --dont-wait Don't wait for keystroke between plots 5551836Sphk -?, --help Display usage information and exit 5651836Sphk --more-help Pass the extended usage text through a pager 5739213Sgibbs 5839213SgibbsOptions are specified by doubled hyphens and their name or by a single 5960422Skenhyphen and the flag character. 6039213Sgibbs@end example 6139213Sgibbs@exampleindent 4 6239213Sgibbs 6339213Sgibbs@node plot_summary directory 6439213Sgibbs@subsection directory option 6539213Sgibbs@cindex plot_summary-directory 6639213Sgibbs 6739213SgibbsThis is the ``where the summary files are'' option. 6839213SgibbsThis option takes a string argument. 6939213Sgibbs The directory where the @code{plot_summary} will search for the 7039213Sgibbs *_summary files generated by @code{summary} script. 7139213Sgibbs@node plot_summary identifier 7239213Sgibbs@subsection identifier option 7339213Sgibbs@cindex plot_summary-identifier 7439213Sgibbs 7539213SgibbsThis is the ``origin of the data'' option. 7639213SgibbsThis option takes a string argument. 7739213Sgibbs Where does the plotted data come from, default to string "host" plus 7839213Sgibbs current hostname 7939213Sgibbs@node plot_summary peer 8039213Sgibbs@subsection peer option 8139213Sgibbs@cindex plot_summary-peer 8239213Sgibbs 8339213SgibbsThis is the ``peers to generate plots for'' option. 8439213SgibbsThis option takes a string argument. 8539213Sgibbs 8639213Sgibbs@noindent 8739213SgibbsThis option has some usage constraints. It: 8839213Sgibbs@itemize @bullet 8939213Sgibbs@item 9039213Sgibbsmay appear an unlimited number of times. 9139213Sgibbs@end itemize 9239213Sgibbs 9339213Sgibbs By default the peer_summary plots are not generated. Use this option to 9439213Sgibbs specify list of peers if you want to generate plots for them. 9539213Sgibbs@node plot_summary plot-term 9639213Sgibbs@subsection plot-term option 9739213Sgibbs@cindex plot_summary-plot-term 9839213Sgibbs 9939213SgibbsThis is the ``gnuplot terminal'' option. 10039213SgibbsThis option takes a string argument. 10139213Sgibbs This is string is passed directly to the @code{gnuplot set terminal} 10239213Sgibbs command. Default is @code{x11} if @code{DISPLAY} is set and 10339213Sgibbs @code{dumb} is it's not'. See output from @code(gnuplot -e "set 10439213Sgibbs terminal") for the list of avalaible options. 10539213Sgibbs@node plot_summary output-file 10639213Sgibbs@subsection output-file option 10739213Sgibbs@cindex plot_summary-output-file 10839213Sgibbs 10939213SgibbsThis is the ``output file'' option. 11039213SgibbsThis option takes a str argument. 11139213Sgibbs Output file for @code{gnuplot}, default to stdout. 11239213Sgibbs@node plot_summary exit status 11339213Sgibbs@subsection plot_summary exit status 11439213Sgibbs 11539213SgibbsOne of the following exit values will be returned: 11639213Sgibbs@table @samp 11739213Sgibbs@item 0 (EXIT_SUCCESS) 11839213SgibbsSuccessful program execution. 11939213Sgibbs@item 1 (EXIT_FAILURE) 12039213SgibbsThe operation failed or the command syntax was not valid. 12139213Sgibbs@end table 12239213Sgibbs