xref: /freebsd/contrib/ntp/scripts/summary.man.in (revision e95923a2288fb2845c7be4822b1b92b2fc106d18)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
summary 1summaryman "20 Feb 2019" "ntp (4.2.8p13)" "User Commands"

EDIT THIS FILE WITH CAUTION (in-mem file)

It has been AutoGen-ed February 20, 2019 at 05:04:30 PM by AutoGen 5.18.5
From the definitions summary-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]summary - compute various stastics from NTP stat files
SYNOPSIS
\f\*[B-Font]summary [\f\*[B-Font]--option-name\f[]] [\f\*[B-Font]--option-name\f[] \f\*[I-Font]value\f[]] All arguments must be options.
DESCRIPTION
"OPTIONS"

.NOP \f\*[B-Font]--directory\f[]=\f\*[I-Font]string\f[] Directory containing stat files. The default \f\*[I-Font]string\f[] for this option is: /var/log/ntp The directory where ntpd will search for .stat files generated by ntpd.

.NOP \f\*[B-Font]--end-date\f[]=\f\*[I-Font]number\f[] End date. This option takes an integer number as its argument. Process all files with the date suffix less or equal to value of this option. Defaults to today minus one day (Use date -u +%Y%m%d) to get the timestamp.

.NOP \f\*[B-Font]--output-directory\f[]=\f\*[I-Font]str\f[] Output directory. The default \f\*[I-Font]str\f[] for this option is: /tmp The output directory summary will write all output files to.

.NOP \f\*[B-Font]--peer-dist-limit\f[]=\f\*[I-Font]float\f[] Peer dist limit. The default \f\*[I-Font]float\f[] for this option is: 400

.NOP \f\*[B-Font]--skip-time-steps\f[]=\f\*[I-Font]float\f[] Ignore time offsets larger that this. The default \f\*[I-Font]float\f[] for this option is: 3600

.NOP \f\*[B-Font]--start-date\f[]=\f\*[I-Font]num\f[] Start date. This option takes an integer number as its argument. The default \f\*[I-Font]num\f[] for this option is: 19700101 Process all files with the date suffix more or equal to value of this option. Defaults to 197000101.

.NOP \f\*[B-Font]--help\f[] Display usage information and exit.

.NOP \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.

.NOP \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}] Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice.

"EXIT STATUS"
One of the following exit values will be returned:

.NOP 0 " (EXIT_SUCCESS)" Successful program execution.

.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.

.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

"NOTES"
This manual page was AutoGen-erated from the summary option definitions.