calc_tickadj.1calc_tickadjmdoc revision 310419
1219820Sjeff.Dd November 21 2016 2219820Sjeff.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3219820Sjeff.Os 4219820Sjeff.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5219820Sjeff.\" 6219820Sjeff.\" It has been AutoGen-ed November 21, 2016 at 07:58:36 AM by AutoGen 5.18.5 7219820Sjeff.\" From the definitions calc_tickadj-opts.def 8219820Sjeff.\" and the template file agmdoc-cmd.tpl 9219820Sjeff.Sh NAME 10219820Sjeff.Nm calc_tickadj 11219820Sjeff.Nd Calculates "optimal" value for tick given ntp drift file. 12219820Sjeff.Sh SYNOPSIS 13219820Sjeff.Nm 14219820Sjeff.\" Mixture of short (flag) options and long options 15219820Sjeff.Op Fl flags 16219820Sjeff.Op Fl flag Op Ar value 17219820Sjeff.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18219820Sjeff.Pp 19219820SjeffAll arguments must be options. 20219820Sjeff.Pp 21219820Sjeff.Sh DESCRIPTION 22219820SjeffThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23219820Sjefftick value. Generally, ntpd can do better job if the drift value is the 24219820Sjeffsmallest possible number. 25219820Sjeff.sp 26219820SjeffThe example output of 27219820Sjeff.Bd -literal -offset indent 28219820Sjeff$ ./calc_tickadj 29219820Sjeff81.699 (drift) 30219820Sjeff9999 usec; 9999779 nsec 31219820Sjeff$ cat /etc/ntp/drift 32219820Sjeff-23.159 33219820Sjeff.Ed 34219820Sjeff.sp 35219820Sjeffmeans the following. If tick on that box is 10,000, by making the value 9999 36219820Sjeffwe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37219820Sjeffin doing so we'll speed the clock up a little every second instead of slowing 38219820Sjeffthe clock down a little. 39219820Sjeff.sp 40219820SjeffIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41219820Sjeffvalue will be somewhere around 0.0. 42219820Sjeff.sp 43219820Sjeff\fBcalc_tickadj\fP tries to determine the the tick value by using 44219820Sjeff\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45219820Sjeffcurrent tick manually on command line. 46219820Sjeff.Sh "OPTIONS" 47219820Sjeff.Bl -tag 48219820Sjeff.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49219820SjeffNtp drift file to use. 50219820SjeffThe default 51219820Sjeff.Ar string 52219820Sjefffor this option is: 53219820Sjeff.ti +4 54219820Sjeff /etc/ntp/drift 55219820Sjeff.sp 56219820SjeffUse the specified drift file for calculations 57219820Sjeff.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58219820SjeffTick value of this host. 59219820SjeffThis option takes an integer number as its argument. 60219820Sjeff.sp 61219820SjeffThe current tick which to adjustment will be calculated 62219820Sjeff.It Fl \&? , Fl \-help 63219820SjeffDisplay usage information and exit. 64219820Sjeff.It Fl \&! , Fl \-more\-help 65219820SjeffPass the extended usage information through a pager. 66219820Sjeff.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67219820SjeffOutput version of program and exit. The default mode is `v', a simple 68219820Sjeffversion. The `c' mode will print copyright information and `n' will 69219820Sjeffprint the full copyright notice. 70219820Sjeff.El 71219820Sjeff.Sh "EXIT STATUS" 72219820SjeffOne of the following exit values will be returned: 73219820Sjeff.Bl -tag 74219820Sjeff.It 0 " (EXIT_SUCCESS)" 75219820SjeffSuccessful program execution. 76219820Sjeff.It 1 " (EXIT_FAILURE)" 77219820SjeffThe operation failed or the command syntax was not valid. 78219820Sjeff.It 70 " (EX_SOFTWARE)" 79219820Sjefflibopts had an internal operational error. Please report 80219820Sjeffit to autogen\-users@lists.sourceforge.net. Thank you. 81219820Sjeff.El 82219820Sjeff.Sh "NOTES" 83219820SjeffThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84219820Sjeffoption definitions. 85219820Sjeff