summary.1summaryman revision 1.1.1.1
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 "24 Dec 2013" "" "User Commands" 14.\" 15.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-41aGTL/ag-e2aWSL) 16.\" 17.\" It has been AutoGen-ed December 24, 2013 at 11:36:05 AM by AutoGen 5.18.3pre5 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.PP 103.TH summary 1summaryman "24 Dec 2013" "" "User Commands" 104.\" 105.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-41aGTL/ag-e2aWSL) 106.\" 107.\" It has been AutoGen-ed December 24, 2013 at 11:36:05 AM by AutoGen 5.18.3pre5 108.\" From the definitions summary-opts.def 109.\" and the template file agman-cmd.tpl 110.SH NAME 111\f\*[B-Font]summary\fP summary 112\- compute various stastics from NTP stat files 113cvt_prog='/usr/local/gnu/share/autogen/texi2man' 114cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd 115 `/`basename "$cvt_prog"` 116cd $tmp_dir 117test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" 118{ 119 list='synopsis description options option-presets' 120 for f in $list ; do cat $f ; echo ; done 121 rm \-f $list name 122 list='implementation-notes environment files examples exit-status errors 123 compatibility see-also conforming-to history authors copyright bugs 124 notes' 125 for f in $list ; do cat $f ; echo ; done > .end-doc 126 rm \-f $list 127 list=`ls \-1 *`' .end-doc' 128 for f in $list ; do cat $f ; echo ; done 129 rm \-f $list 130} 1>.doc 2>/dev/null 131/usr/local/gnu/bin/grep \-E \-v '^[ ]*$' .doc | $cvt_prog 132.SH "EXIT STATUS" 133One of the following exit values will be returned: 134.TP 135.NOP 0 " (EXIT_SUCCESS)" 136Successful program execution. 137.TP 138.NOP 1 " (EXIT_FAILURE)" 139The operation failed or the command syntax was not valid. 140.TP 141.NOP 70 " (EX_SOFTWARE)" 142libopts had an internal operational error. Please report 143it to autogen-users@lists.sourceforge.net. Thank you. 144.PP 145.SH "NOTES" 146This manual page was \fIAutoGen\fP-erated from the \fBsummary\fP 147option definitions. 148