summary.1summarymdoc revision 309007
156160Sru.Dd November 21 2016 2116525Sru.Dt SUMMARY 1summarymdoc User Commands 356160Sru.Os 4116525Sru.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc) 556160Sru.\" 656160Sru.\" It has been AutoGen-ed November 21, 2016 at 07:59:36 AM by AutoGen 5.18.5 756160Sru.\" From the definitions summary-opts.def 856160Sru.\" and the template file agmdoc-cmd.tpl 956160Sru.Sh NAME 1056160Sru.Nm summary 1156160Sru.Nd compute various stastics from NTP stat files 1256160Sru.Sh SYNOPSIS 1356160Sru.Nm 1456160Sru.Op Fl \-option\-name 1556160Sru.Op Fl \-option\-name Ar value 1656160Sru.Pp 1756160SruAll arguments must be options. 1856160Sru.Pp 1956160Sru.Sh DESCRIPTION 2056160Sru.sp 2156160Sru.Sh "OPTIONS" 2256160Sru.Bl -tag 2356160Sru.It Fl \-directory Ns = Ns Ar string 2456160SruDirectory containing stat files. 2556160SruThe default 2656160Sru.Ar string 27114472Srufor this option is: 28114472Sru.ti +4 29116525Sru /var/log/ntp 30116525Sru.sp 3156160Sru The directory where \fBntpd\fP will search for .stat files generated 3256160Sru by \fBntpd\fP. 33114472Sru.It Fl \-end\-date Ns = Ns Ar number 3456160SruEnd date. 35116525SruThis option takes an integer number as its argument. 3656160Sru.sp 3756160Sru Process all files with the date suffix less or equal to value of this 3856160Sru option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) 39116525Sru to get the timestamp. 4093139Sru.It Fl \-output\-directory Ns = Ns Ar str 4156160SruOutput directory. 4256160SruThe default 4356160Sru.Ar str 4456160Srufor this option is: 4593139Sru.ti +4 4693139Sru /tmp 4793139Sru.sp 4856160Sru The output directory \fBsummary\fP will write all output files to. 4993139Sru.It Fl \-peer\-dist\-limit Ns = Ns Ar float 5056160SruPeer dist limit. 5156160SruThe default 5256160Sru.Ar float 5393139Srufor this option is: 5493139Sru.ti +4 55116525Sru 400 5656160Sru.sp 5793139Sru.It Fl \-skip\-time\-steps Ns = Ns Ar float 5893139SruIgnore time offsets larger that this. 5993139SruThe default 6093139Sru.Ar float 61114472Srufor this option is: 6293139Sru.ti +4 63114472Sru 3600 64114472Sru.sp 65116525Sru.It Fl \-start\-date Ns = Ns Ar num 66116525SruStart date. 67116525SruThis option takes an integer number as its argument. 68114472SruThe default 69114472Sru.Ar num 70116525Srufor this option is: 71100513Sru.ti +4 72100513Sru 19700101 73100513Sru.sp 74100513Sru Process all files with the date suffix more or equal to value of 75100513Sru this option. Defaults to 197000101. 76100513Sru.It Fl \-help 77100513SruDisplay usage information and exit. 78100513Sru.It Fl \-more\-help 79100513SruPass the extended usage information through a pager. 80100513Sru.It Fl \-version Op Brq Ar v|c|n 81100513SruOutput version of program and exit. The default mode is `v', a simple 82100513Sruversion. The `c' mode will print copyright information and `n' will 83116525Sruprint the full copyright notice. 84116525Sru.El 85116525Sru.Sh "EXIT STATUS" 86116525SruOne of the following exit values will be returned: 87116525Sru.Bl -tag 88116525Sru.It 0 " (EXIT_SUCCESS)" 89116525SruSuccessful program execution. 90116525Sru.It 1 " (EXIT_FAILURE)" 91116525SruThe operation failed or the command syntax was not valid. 92116525Sru.It 70 " (EX_SOFTWARE)" 93116525Srulibopts had an internal operational error. Please report 94116525Sruit to autogen\-users@lists.sourceforge.net. Thank you. 95116525Sru.El 96116525Sru.Sh "NOTES" 97116525SruThis manual page was \fIAutoGen\fP\-erated from the \fBsummary\fP 98116525Sruoption definitions. 99116525Sru