summary.mdoc.in revision 290001 
1.Dd October 21 2015
2.Dt SUMMARY 1summarymdoc User Commands
3.Os
4.\"  EDIT THIS FILE WITH CAUTION  (summary-opts.mdoc)
5.\"
6.\"  It has been AutoGen-ed  October 21, 2015 at 12:34:58 PM by AutoGen 5.18.5
7.\"  From the definitions    summary-opts.def
8.\"  and the template file   agmdoc-cmd.tpl
9.Sh NAME
10.Nm summary
11.Nd compute various stastics from NTP stat files
12.Sh SYNOPSIS
13.Nm
14.Op Fl \-option\-name
15.Op Fl \-option\-name Ar value
16.Pp
17All arguments must be options.
18.Pp
19.Sh DESCRIPTION
20.sp
21.Sh "OPTIONS"
22.Bl -tag
23.It  Fl \-directory  Ns = Ns Ar string 
24Directory containing stat files.
25The default
26.Ar string
27for this option is:
28.ti +4
29 /var/log/ntp
30.sp
31        The directory where \fBntpd\fP will search for .stat files generated
32        by \fBntpd\fP.
33.It  Fl \-end\-date  Ns = Ns Ar number 
34End date.
35This option takes an integer number as its argument.
36.sp
37        Process all files with the date suffix less or equal to value of this
38        option.  Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP)
39        to get the timestamp.
40.It  Fl \-output\-directory  Ns = Ns Ar str 
41Output directory.
42The default
43.Ar str
44for this option is:
45.ti +4
46 /tmp
47.sp
48        The output directory \fBsummary\fP will write all output files to.
49.It  Fl \-peer\-dist\-limit  Ns = Ns Ar float 
50Peer dist limit.
51The default
52.Ar float
53for this option is:
54.ti +4
55 400
56.sp
57.It  Fl \-skip\-time\-steps  Ns = Ns Ar float 
58Ignore time offsets larger that this.
59The default
60.Ar float
61for this option is:
62.ti +4
63 3600
64.sp
65.It  Fl \-start\-date  Ns = Ns Ar num 
66Start date.
67This option takes an integer number as its argument.
68The default
69.Ar num
70for this option is:
71.ti +4
72 19700101
73.sp
74        Process all files with the date suffix more or equal to value of
75        this option.  Defaults to 197000101.
76.It Fl \-help
77Display usage information and exit.
78.It Fl \-more\-help
79Pass the extended usage information through a pager.
80.It Fl \-version Op Brq Ar v|c|n
81Output version of program and exit.  The default mode is `v', a simple
82version.  The `c' mode will print copyright information and `n' will
83print the full copyright notice.
84.El
85.Sh "EXIT STATUS"
86One of the following exit values will be returned:
87.Bl -tag
88.It 0 " (EXIT_SUCCESS)"
89Successful program execution.
90.It 1 " (EXIT_FAILURE)"
91The operation failed or the command syntax was not valid.
92.It 70 " (EX_SOFTWARE)"
93libopts had an internal operational error.  Please report
94it to autogen\-users@lists.sourceforge.net.  Thank you.
95.El
96.Sh "NOTES"
97This manual page was \fIAutoGen\fP\-erated from the \fBsummary\fP
98option definitions.
99