Home | History | Annotate | Line # | Download | only in scripts 
      1 /* -*- Mode: Text -*- */
      2 AutoGen Definitions perlopt;
      3 
      4 #include autogen-version.def
      5 
      6 prog-name      = 'summary';
      7 prog-title     = 'compute various stastics from NTP stat files';
      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 = '/var/log/ntp';
     18     descrip     = 'Directory containing stat files';
     19     doc         = <<-  _EndOfDoc_
     20         The directory where @code{ntpd} will search for .stat files generated
     21         by @code{ntpd}.
     22 	_EndOfDoc_;
     23 };
     24 
     25 flag = {
     26     name        = end-date;
     27     arg-type    = number;
     28     descrip     = 'End date';
     29     doc         = <<-  _EndOfDoc_
     30         Process all files with the date suffix less or equal to value of this
     31         option.  Defaults to today minus one day (Use @code{date -u +%Y%m%d})
     32         to get the timestamp.
     33 	_EndOfDoc_;
     34 };
     35 
     36 flag = {
     37     name        = output-directory;
     38     arg-type    = str;
     39     arg-default = '/tmp';
     40     descrip     = 'Output directory';
     41     doc         = <<-  _EndOfDoc_
     42         The output directory @code{summary} will write all output files to.
     43 	_EndOfDoc_;
     44 };
     45 
     46 flag = {
     47     name        = peer-dist-limit;
     48     arg-type    = string;
     49     arg-name    = float;
     50     arg-default = 400;
     51     descrip     = 'Peer dist limit';
     52     doc     = <<-  _EndOfDoc_
     53 	_EndOfDoc_;
     54 };
     55 
     56 flag = {
     57     name        = skip-time-steps;
     58     arg-type    = string;
     59     arg-name    = float;
     60     arg-default = 3600;
     61     descrip     = 'Ignore time offsets larger that this';
     62     doc     = <<-  _EndOfDoc_
     63 	_EndOfDoc_;
     64 };
     65 
     66 flag = {
     67     name        = start-date;
     68     arg-type    = num;
     69     arg-default = 19700101;
     70     descrip     = 'Start date';
     71     doc     = <<-  _EndOfDoc_
     72         Process all files with the date suffix more or equal to value of
     73         this option.  Defaults to 197000101.
     74 	_EndOfDoc_;
     75 };
     76 
     77 doc-section = {
     78     ds-type     = 'DESCRIPTION';
     79     ds-format   = 'texi';
     80     ds-text     = <<- _EndOfDoc
     81 	_EndOfDoc;
     82 };
     83