calc_tickadj.mdoc.in revision 1.1.1.9
1238106Sdes.Dd November 21 2016 2238106Sdes.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3238106Sdes.Os 4238106Sdes.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5238106Sdes.\" 6238106Sdes.\" It has been AutoGen-ed November 21, 2016 at 07:58:36 AM by AutoGen 5.18.5 7238106Sdes.\" From the definitions calc_tickadj-opts.def 8238106Sdes.\" and the template file agmdoc-cmd.tpl 9238106Sdes.Sh NAME 10238106Sdes.Nm calc_tickadj 11238106Sdes.Nd Calculates "optimal" value for tick given ntp drift file. 12238106Sdes.Sh SYNOPSIS 13238106Sdes.Nm 14238106Sdes.\" Mixture of short (flag) options and long options 15238106Sdes.Op Fl flags 16238106Sdes.Op Fl flag Op Ar value 17238106Sdes.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18238106Sdes.Pp 19238106SdesAll arguments must be options. 20238106Sdes.Pp 21238106Sdes.Sh DESCRIPTION 22238106SdesThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23238106Sdestick value. Generally, ntpd can do better job if the drift value is the 24269257Sdessmallest possible number. 25269257Sdes.sp 26269257SdesThe example output of 27269257Sdes.Bd -literal -offset indent 28269257Sdes$ ./calc_tickadj 29269257Sdes81.699 (drift) 30269257Sdes9999 usec; 9999779 nsec 31269257Sdes$ cat /etc/ntp/drift 32269257Sdes-23.159 33269257Sdes.Ed 34238106Sdes.sp 35238106Sdesmeans the following. If tick on that box is 10,000, by making the value 9999 36238106Sdeswe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37238106Sdesin doing so we'll speed the clock up a little every second instead of slowing 38238106Sdesthe clock down a little. 39238106Sdes.sp 40238106SdesIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41238106Sdesvalue will be somewhere around 0.0. 42238106Sdes.sp 43238106Sdes\fBcalc_tickadj\fP tries to determine the the tick value by using 44238106Sdes\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45238106Sdescurrent tick manually on command line. 46238106Sdes.Sh "OPTIONS" 47238106Sdes.Bl -tag 48238106Sdes.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49238106SdesNtp drift file to use. 50238106SdesThe default 51238106Sdes.Ar string 52238106Sdesfor this option is: 53238106Sdes.ti +4 54238106Sdes /etc/ntp/drift 55238106Sdes.sp 56238106SdesUse the specified drift file for calculations 57238106Sdes.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58238106SdesTick value of this host. 59238106SdesThis option takes an integer number as its argument. 60238106Sdes.sp 61238106SdesThe current tick which to adjustment will be calculated 62238106Sdes.It Fl \&? , Fl \-help 63238106SdesDisplay usage information and exit. 64238106Sdes.It Fl \&! , Fl \-more\-help 65238106SdesPass the extended usage information through a pager. 66238106Sdes.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67238106SdesOutput version of program and exit. The default mode is `v', a simple 68238106Sdesversion. The `c' mode will print copyright information and `n' will 69238106Sdesprint the full copyright notice. 70238106Sdes.El 71238106Sdes.Sh "EXIT STATUS" 72238106SdesOne of the following exit values will be returned: 73238106Sdes.Bl -tag 74238106Sdes.It 0 " (EXIT_SUCCESS)" 75238106SdesSuccessful program execution. 76238106Sdes.It 1 " (EXIT_FAILURE)" 77238106SdesThe operation failed or the command syntax was not valid. 78238106Sdes.It 70 " (EX_SOFTWARE)" 79238106Sdeslibopts had an internal operational error. Please report 80238106Sdesit to autogen\-users@lists.sourceforge.net. Thank you. 81238106Sdes.El 82238106Sdes.Sh "NOTES" 83238106SdesThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84238106Sdesoption definitions. 85238106Sdes