10SN/A.Dd February 27 2018
23847SN/A.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
30SN/A.Os
40SN/A.\"  EDIT THIS FILE WITH CAUTION  (calc_tickadj-opts.mdoc)
50SN/A.\"
60SN/A.\"  It has been AutoGen-ed  February 27, 2018 at 10:49:43 AM by AutoGen 5.18.5
70SN/A.\"  From the definitions    calc_tickadj-opts.def
80SN/A.\"  and the template file   agmdoc-cmd.tpl
90SN/A.Sh NAME
100SN/A.Nm calc_tickadj
110SN/A.Nd Calculates "optimal" value for tick given ntp drift file.
120SN/A.Sh SYNOPSIS
130SN/A.Nm
140SN/A.\" Mixture of short (flag) options and long options
152362SN/A.Op Fl flags
160SN/A.Op Fl flag Op Ar value
170SN/A.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
180SN/A.Pp
190SN/AAll arguments must be options.
200SN/A.Pp
210SN/A.Sh DESCRIPTION
220SN/AThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal
230SN/Atick value. Generally, ntpd can do better job if the drift value is the
240SN/Asmallest possible number. 
250SN/A.sp
260SN/AThe example output of 
270SN/A.Bd -literal -offset indent
280SN/A$ ./calc_tickadj
290SN/A81.699 (drift)
300SN/A9999 usec; 9999779 nsec
310SN/A$ cat /etc/ntp/drift
324457SN/A-23.159
334457SN/A.Ed
344457SN/A.sp
354457SN/Ameans the following. If tick on that box is 10,000, by making the value 9999
364457SN/Awe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and
374457SN/Ain doing so we'll speed the clock up a little every second instead of slowing
384457SN/Athe clock down a little.
394457SN/A.sp
404457SN/AIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
410SN/Avalue will be somewhere around 0.0.
420SN/A.sp
433847SN/A\fBcalc_tickadj\fP tries to determine the the tick value by using
440SN/A\fBtickadj\fP program from ntp package. If this doesn't work you can specify
453847SN/Acurrent tick manually on command line.
460SN/A.Sh "OPTIONS"
470SN/A.Bl -tag
480SN/A.It  Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 
490SN/ANtp drift file to use.
503847SN/AThe default
510SN/A.Ar string
523847SN/Afor this option is:
530SN/A.ti +4
540SN/A /etc/ntp/drift
550SN/A.sp
560SN/AUse the specified drift file for calculations
573847SN/A.It  Fl t Ar number , Fl \-tick Ns = Ns Ar number 
580SN/ATick value of this host.
590SN/AThis option takes an integer number as its argument.
600SN/A.sp
610SN/AThe current tick which to adjustment will be calculated
620SN/A.It Fl \&? , Fl \-help
630SN/ADisplay usage information and exit.
640SN/A.It Fl \&! , Fl \-more\-help
650SN/APass the extended usage information through a pager.
660SN/A.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
670SN/AOutput version of program and exit.  The default mode is `v', a simple
680SN/Aversion.  The `c' mode will print copyright information and `n' will
690SN/Aprint the full copyright notice.
700SN/A.El
710SN/A.Sh "EXIT STATUS"
720SN/AOne of the following exit values will be returned:
733847SN/A.Bl -tag
740SN/A.It 0 " (EXIT_SUCCESS)"
750SN/ASuccessful program execution.
760SN/A.It 1 " (EXIT_FAILURE)"
770SN/AThe operation failed or the command syntax was not valid.
780SN/A.It 70 " (EX_SOFTWARE)"
790SN/Alibopts had an internal operational error.  Please report
800SN/Ait to autogen\-users@lists.sourceforge.net.  Thank you.
810SN/A.El
820SN/A.Sh "NOTES"
830SN/AThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP
840SN/Aoption definitions.
850SN/A