Home | History | Annotate | Line # | Download | only in scripts 
      1 .Dd May 25 2024
      2 .Dt PLOT_SUMMARY 1plot_summarymdoc User Commands
      3 .Os
      4 .\"  EDIT THIS FILE WITH CAUTION  (plot_summary-opts.mdoc)
      5 .\"
      6 .\"  It has been AutoGen-ed  May 25, 2024 at 12:06:00 AM by AutoGen 5.18.16
      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
     17 All arguments must be options.
     18 .Pp
     19 .Sh "DESCRIPTION"
     20 There is no description for this command.
     21 .Sh "OPTIONS"
     22 .Bl -tag
     23 .It  Fl \-directory  Ns = Ns Ar string 
     24 Where the summary files are.
     25 The default
     26 .Ar string
     27 for 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 
     34 Origin 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 
     39 Limit of absolute offset.
     40 The default
     41 .Ar float
     42 for this option is:
     43 .ti +4
     44  0.128
     45 .sp
     46 .It  Fl \-peer  Ns = Ns Ar string 
     47 Peers to generate plots for.
     48 This 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 
     53 Gnuplot 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 available options.
     59 .It  Fl \-output\-file  Ns = Ns Ar str 
     60 Output file.
     61 .sp
     62         Output file for \fBgnuplot\fP, default to stdout.
     63 .It  Fl \-dont\-wait 
     64 Don't wait for keystroke between plots.
     65 .sp
     66 .It Fl \-help
     67 Display usage information and exit.
     68 .It Fl \-more\-help
     69 Pass the extended usage information through a pager.
     70 .It Fl \-version Op Brq Ar v|c|n
     71 Output version of program and exit.  The default mode is `v', a simple
     72 version.  The `c' mode will print copyright information and `n' will
     73 print the full copyright notice.
     74 .El
     75 .Sh "EXIT STATUS"
     76 One of the following exit values will be returned:
     77 .Bl -tag
     78 .It 0 " (EXIT_SUCCESS)"
     79 Successful program execution.
     80 .It 1 " (EXIT_FAILURE)"
     81 The operation failed or the command syntax was not valid.
     82 .It 70 " (EX_SOFTWARE)"
     83 libopts had an internal operational error.  Please report
     84 it to autogen\-users (a] lists.sourceforge.net.  Thank you.
     85 .El
     86 .Sh "NOTES"
     87 This manual page was \fIAutoGen\fP\-erated from the \fBplot_summary\fP
     88 option definitions.
     89