1338531Sdelphij.Dd August 14 2018 2275970Scy.Dt SUMMARY 1summarymdoc User Commands 3275970Scy.Os 4275970Scy.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc) 5275970Scy.\" 6338531Sdelphij.\" It has been AutoGen-ed August 14, 2018 at 08:09:51 AM by AutoGen 5.18.5 7275970Scy.\" From the definitions summary-opts.def 8275970Scy.\" and the template file agmdoc-cmd.tpl 9275970Scy.Sh NAME 10275970Scy.Nm summary 11275970Scy.Nd compute various stastics from NTP stat files 12275970Scy.Sh SYNOPSIS 13275970Scy.Nm 14275970Scy.Op Fl \-option\-name 15275970Scy.Op Fl \-option\-name Ar value 16275970Scy.Pp 17275970ScyAll arguments must be options. 18275970Scy.Pp 19275970Scy.Sh DESCRIPTION 20275970Scy.sp 21275970Scy.Sh "OPTIONS" 22275970Scy.Bl -tag 23275970Scy.It Fl \-directory Ns = Ns Ar string 24275970ScyDirectory containing stat files. 25275970ScyThe default 26275970Scy.Ar string 27275970Scyfor this option is: 28275970Scy.ti +4 29275970Scy /var/log/ntp 30275970Scy.sp 31275970Scy The directory where \fBntpd\fP will search for .stat files generated 32275970Scy by \fBntpd\fP. 33275970Scy.It Fl \-end\-date Ns = Ns Ar number 34275970ScyEnd date. 35275970ScyThis option takes an integer number as its argument. 36275970Scy.sp 37275970Scy Process all files with the date suffix less or equal to value of this 38275970Scy option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) 39275970Scy to get the timestamp. 40275970Scy.It Fl \-output\-directory Ns = Ns Ar str 41275970ScyOutput directory. 42275970ScyThe default 43275970Scy.Ar str 44275970Scyfor this option is: 45275970Scy.ti +4 46275970Scy /tmp 47275970Scy.sp 48275970Scy The output directory \fBsummary\fP will write all output files to. 49275970Scy.It Fl \-peer\-dist\-limit Ns = Ns Ar float 50275970ScyPeer dist limit. 51275970ScyThe default 52275970Scy.Ar float 53275970Scyfor this option is: 54275970Scy.ti +4 55275970Scy 400 56275970Scy.sp 57275970Scy.It Fl \-skip\-time\-steps Ns = Ns Ar float 58275970ScyIgnore time offsets larger that this. 59275970ScyThe default 60275970Scy.Ar float 61275970Scyfor this option is: 62275970Scy.ti +4 63275970Scy 3600 64275970Scy.sp 65275970Scy.It Fl \-start\-date Ns = Ns Ar num 66275970ScyStart date. 67275970ScyThis option takes an integer number as its argument. 68275970ScyThe default 69275970Scy.Ar num 70275970Scyfor this option is: 71275970Scy.ti +4 72275970Scy 19700101 73275970Scy.sp 74275970Scy Process all files with the date suffix more or equal to value of 75275970Scy this option. Defaults to 197000101. 76275970Scy.It Fl \-help 77275970ScyDisplay usage information and exit. 78275970Scy.It Fl \-more\-help 79275970ScyPass the extended usage information through a pager. 80275970Scy.It Fl \-version Op Brq Ar v|c|n 81275970ScyOutput version of program and exit. The default mode is `v', a simple 82275970Scyversion. The `c' mode will print copyright information and `n' will 83275970Scyprint the full copyright notice. 84275970Scy.El 85275970Scy.Sh "EXIT STATUS" 86275970ScyOne of the following exit values will be returned: 87275970Scy.Bl -tag 88275970Scy.It 0 " (EXIT_SUCCESS)" 89275970ScySuccessful program execution. 90275970Scy.It 1 " (EXIT_FAILURE)" 91275970ScyThe operation failed or the command syntax was not valid. 92275970Scy.It 70 " (EX_SOFTWARE)" 93275970Scylibopts had an internal operational error. Please report 94275970Scyit to autogen\-users@lists.sourceforge.net. Thank you. 95275970Scy.El 96275970Scy.Sh "NOTES" 97275970ScyThis manual page was \fIAutoGen\fP\-erated from the \fBsummary\fP 98275970Scyoption definitions. 99