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