xref: /freebsd-11.0-release/contrib/ntp/scripts/calc_tickadj/calc_tickadj.mdoc.in

.Dd October 21 2015
.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
.Os
.\"  EDIT THIS FILE WITH CAUTION  (calc_tickadj-opts.mdoc)
.\"
.\"  It has been AutoGen-ed  October 21, 2015 at 12:34:02 PM by AutoGen 5.18.5
.\"  From the definitions    calc_tickadj-opts.def
.\"  and the template file   agmdoc-cmd.tpl
.Sh NAME
.Nm calc_tickadj
.Nd Calculates "optimal" value for tick given ntp drift file.
.Sh SYNOPSIS
.Nm
.\" Mixture of short (flag) options and long options
.Op Fl flags
.Op Fl flag Op Ar value
.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
.Pp
All arguments must be options.
.Pp
.Sh DESCRIPTION
The \fBcalc_tickadj\fP 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. 
.sp
The example output of 
.Bd -literal -offset indent
$ ./calc_tickadj
81.699 (drift)
9999 usec; 9999779 nsec
$ cat /etc/ntp/drift
-23.159
.Ed
.sp
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.
.sp
If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
value will be somewhere around 0.0.
.sp
\fBcalc_tickadj\fP tries to determine the the tick value by using
\fBtickadj\fP program from ntp package. If this doesn't work you can specify
current tick manually on command line.
.Sh "OPTIONS"
.Bl -tag
.It  Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 
Ntp drift file to use.
The default
.Ar string
for this option is:
.ti +4
 /etc/ntp/drift
.sp
Use the specified drift file for calculations
.It  Fl t Ar number , Fl \-tick Ns = Ns Ar number 
Tick value of this host.
This option takes an integer number as its argument.
.sp
The current tick which to adjustment will be calculated
.It Fl \&? , Fl \-help
Display usage information and exit.
.It Fl \&! , Fl \-more\-help
Pass the extended usage information through a pager.
.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
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.
.El
.Sh "EXIT STATUS"
One of the following exit values will be returned:
.Bl -tag
.It 0 " (EXIT_SUCCESS)"
Successful program execution.
.It 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.It 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen\-users@lists.sourceforge.net.  Thank you.
.El
.Sh "NOTES"
This manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP
option definitions.