contrib/ntp/scripts/plot_summary-opts.def

   1 /* -*- Mode: Text -*- */
   2 AutoGen Definitions perlopt;
   3
   4 #include autogen-version.def
   5
   6 prog-name      = 'plot_summary';
   7 prog-title     = 'plot statistics generated by summary script';
   8 package         = ntp;
   9 #include        version.def
  10
  11 long-opts;
  12 gnu-usage;
  13
  14 flag = {
  15     name        = directory;
  16     arg-type    = string;
  17     arg-default = '/tmp';
  18     descrip     = 'Where the summary files are';
  19     doc         = <<-  _EndOfDoc_
  20         The directory where the @code{plot_summary} will search for the
  21         *_summary files generated by @code{summary} script.
  22         _EndOfDoc_;
  23 };
  24
  25 flag = {
  26     name        = identifier;
  27     arg-type    = string;
  28     descrip     = 'Origin of the data';
  29     doc         = <<-  _EndOfDoc_
  30         Where does the plotted data come from, default to string "host" plus
  31         current hostname
  32         _EndOfDoc_;
  33 };
  34
  35 flag = {
  36     name        = offset-limit;
  37     arg-type    = string;
  38     arg-name    = float;
  39     arg-default = "0.128";
  40     descrip     = 'Limit of absolute offset';
  41     doc         = <<-  _EndOfDoc_
  42         _EndOfDoc_;
  43 };
  44
  45 flag = {
  46     name        = peer;
  47     arg-type    = string;
  48     stack-arg;
  49     max         = NOLIMIT;
  50     descrip     = 'Peers to generate plots for';
  51     doc         = <<-  _EndOfDoc_
  52         By default the peer_summary plots are not generated. Use this option to
  53         specify list of peers if you want to generate plots for them.
  54         _EndOfDoc_;
  55 };
  56
  57 flag = {
  58     name        = plot-term;
  59     arg-type    = string;
  60     descrip     = 'Gnuplot terminal';
  61     doc         = <<-  _EndOfDoc_
  62         This is string is passed directly to the @code{gnuplot set terminal}
  63         command.  Default is @code{x11} if @code{DISPLAY} is set and
  64         @code{dumb} is it's not'. See output from @code(gnuplot -e "set
  65         terminal") for the list of available options.
  66         _EndOfDoc_;
  67 };
  68
  69 flag = {
  70     name        = output-file;
  71     arg-type    = str;
  72     descrip     = 'Output file';
  73     doc         = <<-  _EndOfDoc_
  74         Output file for @code{gnuplot}, default to stdout.
  75         _EndOfDoc_;
  76 };
  77
  78 flag = {
  79     name        = dont-wait;
  80     descrip     = "Don't wait for keystroke between plots";
  81     doc         = <<-  _EndOfDoc_
  82         _EndOfDoc_;
  83 };