1131087Smarcel.Dd February 27 2018 2131087Smarcel.Dt SUMMARY 1summarymdoc User Commands 3131087Smarcel.Os 4131087Smarcel.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc) 5131087Smarcel.\" 6131087Smarcel.\" It has been AutoGen-ed February 27, 2018 at 04:56:08 PM by AutoGen 5.18.5 7131087Smarcel.\" From the definitions summary-opts.def 8131087Smarcel.\" and the template file agmdoc-cmd.tpl 9131087Smarcel.Sh NAME 10131087Smarcel.Nm summary 11131087Smarcel.Nd compute various stastics from NTP stat files 12131087Smarcel.Sh SYNOPSIS 13131087Smarcel.Nm 14131087Smarcel.Op Fl \-option\-name 15131087Smarcel.Op Fl \-option\-name Ar value 16131087Smarcel.Pp 17131087SmarcelAll arguments must be options. 18131087Smarcel.Pp 19131087Smarcel.Sh DESCRIPTION 20131087Smarcel.sp 21131087Smarcel.Sh "OPTIONS" 22131087Smarcel.Bl -tag 23131087Smarcel.It Fl \-directory Ns = Ns Ar string 24131087SmarcelDirectory containing stat files. 25131087SmarcelThe default 26131087Smarcel.Ar string 27131087Smarcelfor this option is: 28131087Smarcel.ti +4 29131087Smarcel /var/log/ntp 30131087Smarcel.sp 31131087Smarcel The directory where \fBntpd\fP will search for .stat files generated 32131087Smarcel by \fBntpd\fP. 33131087Smarcel.It Fl \-end\-date Ns = Ns Ar number 34131087SmarcelEnd date. 35131087SmarcelThis option takes an integer number as its argument. 36131087Smarcel.sp 37131087Smarcel Process all files with the date suffix less or equal to value of this 38131087Smarcel option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) 39131087Smarcel to get the timestamp. 40131087Smarcel.It Fl \-output\-directory Ns = Ns Ar str 41131087SmarcelOutput directory. 42131087SmarcelThe default 43131087Smarcel.Ar str 44131087Smarcelfor this option is: 45131087Smarcel.ti +4 46131087Smarcel /tmp 47131087Smarcel.sp 48131087Smarcel The output directory \fBsummary\fP will write all output files to. 49131087Smarcel.It Fl \-peer\-dist\-limit Ns = Ns Ar float 50131087SmarcelPeer dist limit. 51131087SmarcelThe default 52131087Smarcel.Ar float 53131087Smarcelfor this option is: 54131087Smarcel.ti +4 55131087Smarcel 400 56131087Smarcel.sp 57131087Smarcel.It Fl \-skip\-time\-steps Ns = Ns Ar float 58131087SmarcelIgnore time offsets larger that this. 59131087SmarcelThe default 60131087Smarcel.Ar float 61131087Smarcelfor this option is: 62131087Smarcel.ti +4 63131087Smarcel 3600 64131087Smarcel.sp 65131087Smarcel.It Fl \-start\-date Ns = Ns Ar num 66131087SmarcelStart date. 67131087SmarcelThis option takes an integer number as its argument. 68131087SmarcelThe default 69131087Smarcel.Ar num 70131087Smarcelfor this option is: 71131087Smarcel.ti +4 72131087Smarcel 19700101 73131087Smarcel.sp 74131087Smarcel Process all files with the date suffix more or equal to value of 75131087Smarcel this option. Defaults to 197000101. 76131087Smarcel.It Fl \-help 77131087SmarcelDisplay usage information and exit. 78131087Smarcel.It Fl \-more\-help 79131087SmarcelPass the extended usage information through a pager. 80131087Smarcel.It Fl \-version Op Brq Ar v|c|n 81131087SmarcelOutput version of program and exit. The default mode is `v', a simple 82131087Smarcelversion. The `c' mode will print copyright information and `n' will 83131087Smarcelprint the full copyright notice. 84131087Smarcel.El 85131087Smarcel.Sh "EXIT STATUS" 86131087SmarcelOne of the following exit values will be returned: 87131087Smarcel.Bl -tag 88131087Smarcel.It 0 " (EXIT_SUCCESS)" 89131087SmarcelSuccessful program execution. 90131087Smarcel.It 1 " (EXIT_FAILURE)" 91131087SmarcelThe operation failed or the command syntax was not valid. 92131087Smarcel.It 70 " (EX_SOFTWARE)" 93131087Smarcellibopts had an internal operational error. Please report 94131087Smarcelit to autogen\-users@lists.sourceforge.net. Thank you. 95131087Smarcel.El 96131087Smarcel.Sh "NOTES" 97131087SmarcelThis manual page was \fIAutoGen\fP\-erated from the \fBsummary\fP 98131087Smarceloption definitions. 99131087Smarcel