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