summary.1summarymdoc revision 289997 
1359575Sdim.Dd October 21 2015
2359575Sdim.Dt SUMMARY 1summarymdoc User Commands
3359575Sdim.Os
4359575Sdim.\"  EDIT THIS FILE WITH CAUTION  (summary-opts.mdoc)
5359575Sdim.\"
6359575Sdim.\"  It has been AutoGen-ed  October 21, 2015 at 12:34:58 PM by AutoGen 5.18.5
7359575Sdim.\"  From the definitions    summary-opts.def
8359575Sdim.\"  and the template file   agmdoc-cmd.tpl
9359575Sdim.Sh NAME
10359575Sdim.Nm summary
11359575Sdim.Nd compute various stastics from NTP stat files
12359575Sdim.Sh SYNOPSIS
13359575Sdim.Nm
14359575Sdim.Op Fl \-option\-name
15359575Sdim.Op Fl \-option\-name Ar value
16359575Sdim.Pp
17359575SdimAll arguments must be options.
18359575Sdim.Pp
19359575Sdim.Sh DESCRIPTION
20359575Sdim.sp
21359575Sdim.Sh "OPTIONS"
22359575Sdim.Bl -tag
23359575Sdim.It  Fl \-directory  Ns = Ns Ar string 
24359575SdimDirectory containing stat files.
25359575SdimThe default
26359575Sdim.Ar string
27359575Sdimfor this option is:
28359575Sdim.ti +4
29359575Sdim /var/log/ntp
30359575Sdim.sp
31359575Sdim        The directory where \fBntpd\fP will search for .stat files generated
32359575Sdim        by \fBntpd\fP.
33359575Sdim.It  Fl \-end\-date  Ns = Ns Ar number 
34359575SdimEnd date.
35359575SdimThis option takes an integer number as its argument.
36359575Sdim.sp
37359575Sdim        Process all files with the date suffix less or equal to value of this
38359575Sdim        option.  Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP)
39359575Sdim        to get the timestamp.
40359575Sdim.It  Fl \-output\-directory  Ns = Ns Ar str 
41359575SdimOutput directory.
42359575SdimThe default
43359575Sdim.Ar str
44359575Sdimfor 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