xref: /freebsd/contrib/ntp/scripts/calc_tickadj/calc_tickadj.man.in (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
calc_tickadj 1calc_tickadjman "02 Jun 2016" "ntp (4.2.8p8)" "User Commands"

EDIT THIS FILE WITH CAUTION (/tmp/.ag-3laW2J/ag-ema41J)

It has been AutoGen-ed June 2, 2016 at 07:24:25 AM by AutoGen 5.18.5
From the definitions calc_tickadj-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]calc_tickadj - Calculates optimal value for tick given ntp drift file.
SYNOPSIS
\f\*[B-Font]calc_tickadj Mixture of short (flag) options and long options
[\f\*[B-Font]-flags\f[]] [\f\*[B-Font]-flag\f[] [\f\*[I-Font]value\f[]]] [\f\*[B-Font]--option-name\f[][[=| ]\f\*[I-Font]value\f[]]] All arguments must be options.
DESCRIPTION
The calc_tickadj script uses provided ntp drift file to generate optimal tick value. Generally, ntpd can do better job if the drift value is the smallest possible number. The example output of

$ ./calc_tickadj
81.699 (drift)
9999 usec; 9999779 nsec
$ cat /etc/ntp/drift
-23.159
means the following. If tick on that box is 10,000, by making the value 9999 we'll shift the box from its current drift of -23.159 to a drift of 81.699, and in doing so we'll speed the clock up a little every second instead of slowing the clock down a little. If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift value will be somewhere around 0.0. calc_tickadj tries to determine the the tick value by using tickadj program from ntp package. If this doesn't work you can specify current tick manually on command line.
"OPTIONS"

.NOP \f\*[B-Font]-d\f[] \f\*[I-Font]string\f[], \f\*[B-Font]--drift-file\f[]=\f\*[I-Font]string\f[] Ntp drift file to use. The default \f\*[I-Font]string\f[] for this option is: /etc/ntp/drift Use the specified drift file for calculations

.NOP \f\*[B-Font]-t\f[] \f\*[I-Font]number\f[], \f\*[B-Font]--tick\f[]=\f\*[I-Font]number\f[] Tick value of this host. This option takes an integer number as its argument. The current tick which to adjustment will be calculated

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

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

.NOP \f\*[B-Font]-v\f[] [{\f\*[I-Font]v|c|n\f[] \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 calc_tickadj option definitions.