summary.man.in revision 362716
1.de1 NOP 2. it 1 an-trap 3. if \\n[.$] \,\\$*\/ 4.. 5.ie t \ 6.ds B-Font [CB] 7.ds I-Font [CI] 8.ds R-Font [CR] 9.el \ 10.ds B-Font B 11.ds I-Font I 12.ds R-Font R 13.TH summary 1summaryman "23 Jun 2020" "ntp (4.2.8p15)" "User Commands" 14.\" 15.\" EDIT THIS FILE WITH CAUTION (in-mem file) 16.\" 17.\" It has been AutoGen-ed June 23, 2020 at 02:21:51 AM by AutoGen 5.18.5 18.\" From the definitions summary-opts.def 19.\" and the template file agman-cmd.tpl 20.SH NAME 21\f\*[B-Font]summary\fP 22\- compute various stastics from NTP stat files 23.SH SYNOPSIS 24\f\*[B-Font]summary\fP 25[\f\*[B-Font]\-\-option-name\f[]] 26[\f\*[B-Font]\-\-option-name\f[] \f\*[I-Font]value\f[]] 27.sp \n(Ppu 28.ne 2 29 30All arguments must be options. 31.sp \n(Ppu 32.ne 2 33 34.SH DESCRIPTION 35.sp 36.SH "OPTIONS" 37.TP 38.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[] 39Directory containing stat files. 40The default 41\f\*[I-Font]string\f[] 42for this option is: 43.ti +4 44 /var/log/ntp 45.sp 46 The directory where \fBntpd\fP will search for .stat files generated 47 by \fBntpd\fP. 48.TP 49.NOP \f\*[B-Font]\-\-end\-date\f[]=\f\*[I-Font]number\f[] 50End date. 51This option takes an integer number as its argument. 52.sp 53 Process all files with the date suffix less or equal to value of this 54 option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) 55 to get the timestamp. 56.TP 57.NOP \f\*[B-Font]\-\-output\-directory\f[]=\f\*[I-Font]str\f[] 58Output directory. 59The default 60\f\*[I-Font]str\f[] 61for this option is: 62.ti +4 63 /tmp 64.sp 65 The output directory \fBsummary\fP will write all output files to. 66.TP 67.NOP \f\*[B-Font]\-\-peer\-dist\-limit\f[]=\f\*[I-Font]float\f[] 68Peer dist limit. 69The default 70\f\*[I-Font]float\f[] 71for this option is: 72.ti +4 73 400 74.sp 75.TP 76.NOP \f\*[B-Font]\-\-skip\-time\-steps\f[]=\f\*[I-Font]float\f[] 77Ignore time offsets larger that this. 78The default 79\f\*[I-Font]float\f[] 80for this option is: 81.ti +4 82 3600 83.sp 84.TP 85.NOP \f\*[B-Font]\-\-start\-date\f[]=\f\*[I-Font]num\f[] 86Start date. 87This option takes an integer number as its argument. 88The default 89\f\*[I-Font]num\f[] 90for this option is: 91.ti +4 92 19700101 93.sp 94 Process all files with the date suffix more or equal to value of 95 this option. Defaults to 197000101. 96.TP 97.NOP \f\*[B-Font]\-\-help\f[] 98Display usage information and exit. 99.TP 100.NOP \f\*[B-Font]\-\-more-help\f[] 101Pass the extended usage information through a pager. 102.TP 103.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 104Output version of program and exit. The default mode is `v', a simple 105version. The `c' mode will print copyright information and `n' will 106print the full copyright notice. 107.PP 108.SH "EXIT STATUS" 109One of the following exit values will be returned: 110.TP 111.NOP 0 " (EXIT_SUCCESS)" 112Successful program execution. 113.TP 114.NOP 1 " (EXIT_FAILURE)" 115The operation failed or the command syntax was not valid. 116.TP 117.NOP 70 " (EX_SOFTWARE)" 118libopts had an internal operational error. Please report 119it to autogen-users@lists.sourceforge.net. Thank you. 120.PP 121.SH "NOTES" 122This manual page was \fIAutoGen\fP-erated from the \fBsummary\fP 123option definitions. 124