calc_tickadj.mdoc.in revision 301301
1238104Sdes.Dd June 2 2016 2238104Sdes.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3238104Sdes.Os 4238104Sdes.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5238104Sdes.\" 6238104Sdes.\" It has been AutoGen-ed June 2, 2016 at 07:24:27 AM by AutoGen 5.18.5 7238104Sdes.\" From the definitions calc_tickadj-opts.def 8238104Sdes.\" and the template file agmdoc-cmd.tpl 9238104Sdes.Sh NAME 10238104Sdes.Nm calc_tickadj 11238104Sdes.Nd Calculates "optimal" value for tick given ntp drift file. 12238104Sdes.Sh SYNOPSIS 13238104Sdes.Nm 14238104Sdes.\" Mixture of short (flag) options and long options 15238104Sdes.Op Fl flags 16238104Sdes.Op Fl flag Op Ar value 17238104Sdes.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18238104Sdes.Pp 19238104SdesAll arguments must be options. 20238104Sdes.Pp 21238104Sdes.Sh DESCRIPTION 22238104SdesThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23238104Sdestick value. Generally, ntpd can do better job if the drift value is the 24238104Sdessmallest possible number. 25238104Sdes.sp 26238104SdesThe example output of 27238104Sdes.Bd -literal -offset indent 28238104Sdes$ ./calc_tickadj 29238104Sdes81.699 (drift) 30238104Sdes9999 usec; 9999779 nsec 31238104Sdes$ cat /etc/ntp/drift 32238104Sdes-23.159 33238104Sdes.Ed 34238104Sdes.sp 35238104Sdesmeans the following. If tick on that box is 10,000, by making the value 9999 36238104Sdeswe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37238104Sdesin doing so we'll speed the clock up a little every second instead of slowing 38238104Sdesthe clock down a little. 39238104Sdes.sp 40238104SdesIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41238104Sdesvalue will be somewhere around 0.0. 42238104Sdes.sp 43238104Sdes\fBcalc_tickadj\fP tries to determine the the tick value by using 44238104Sdes\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45238104Sdescurrent tick manually on command line. 46238104Sdes.Sh "OPTIONS" 47238104Sdes.Bl -tag 48238104Sdes.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49238104SdesNtp drift file to use. 50238104SdesThe default 51238104Sdes.Ar string 52238104Sdesfor this option is: 53238104Sdes.ti +4 54238104Sdes /etc/ntp/drift 55238104Sdes.sp 56238104SdesUse the specified drift file for calculations 57238104Sdes.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58238104SdesTick value of this host. 59238104SdesThis option takes an integer number as its argument. 60238104Sdes.sp 61238104SdesThe current tick which to adjustment will be calculated 62238104Sdes.It Fl \&? , Fl \-help 63238104SdesDisplay usage information and exit. 64238104Sdes.It Fl \&! , Fl \-more\-help 65238104SdesPass the extended usage information through a pager. 66238104Sdes.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67238104SdesOutput version of program and exit. The default mode is `v', a simple 68238104Sdesversion. The `c' mode will print copyright information and `n' will 69238104Sdesprint the full copyright notice. 70238104Sdes.El 71238104Sdes.Sh "EXIT STATUS" 72238104SdesOne of the following exit values will be returned: 73238104Sdes.Bl -tag 74238104Sdes.It 0 " (EXIT_SUCCESS)" 75238104SdesSuccessful program execution. 76238104Sdes.It 1 " (EXIT_FAILURE)" 77238104SdesThe operation failed or the command syntax was not valid. 78238104Sdes.It 70 " (EX_SOFTWARE)" 79238104Sdeslibopts had an internal operational error. Please report 80238104Sdesit to autogen\-users@lists.sourceforge.net. Thank you. 81238104Sdes.El 82238104Sdes.Sh "NOTES" 83238104SdesThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84238104Sdesoption definitions. 85238104Sdes