calc_tickadj.1calc_tickadjmdoc revision 302408
1193323Sed.Dd June 2 2016 2193323Sed.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3193323Sed.Os 4193323Sed.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5193323Sed.\" 6193323Sed.\" It has been AutoGen-ed June 2, 2016 at 07:24:27 AM by AutoGen 5.18.5 7193323Sed.\" From the definitions calc_tickadj-opts.def 8193323Sed.\" and the template file agmdoc-cmd.tpl 9193323Sed.Sh NAME 10193323Sed.Nm calc_tickadj 11212904Sdim.Nd Calculates "optimal" value for tick given ntp drift file. 12193323Sed.Sh SYNOPSIS 13193323Sed.Nm 14193323Sed.\" Mixture of short (flag) options and long options 15212904Sdim.Op Fl flags 16212904Sdim.Op Fl flag Op Ar value 17212904Sdim.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18212904Sdim.Pp 19212904SdimAll arguments must be options. 20193323Sed.Pp 21212904Sdim.Sh DESCRIPTION 22212904SdimThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23193323Sedtick value. Generally, ntpd can do better job if the drift value is the 24193323Sedsmallest possible number. 25193323Sed.sp 26193323SedThe example output of 27193323Sed.Bd -literal -offset indent 28193323Sed$ ./calc_tickadj 29198090Srdivacky81.699 (drift) 30212904Sdim9999 usec; 9999779 nsec 31198090Srdivacky$ cat /etc/ntp/drift 32198090Srdivacky-23.159 33198090Srdivacky.Ed 34198090Srdivacky.sp 35193323Sedmeans the following. If tick on that box is 10,000, by making the value 9999 36193323Sedwe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37193323Sedin doing so we'll speed the clock up a little every second instead of slowing 38193323Sedthe clock down a little. 39198090Srdivacky.sp 40198090SrdivackyIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41198090Srdivackyvalue will be somewhere around 0.0. 42193323Sed.sp 43193323Sed\fBcalc_tickadj\fP tries to determine the the tick value by using 44193323Sed\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45193323Sedcurrent tick manually on command line. 46193323Sed.Sh "OPTIONS" 47193323Sed.Bl -tag 48193323Sed.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49193323SedNtp drift file to use. 50193323SedThe default 51198892Srdivacky.Ar string 52193323Sedfor this option is: 53212904Sdim.ti +4 54212904Sdim /etc/ntp/drift 55212904Sdim.sp 56212904SdimUse the specified drift file for calculations 57212904Sdim.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58212904SdimTick value of this host. 59193323SedThis option takes an integer number as its argument. 60193323Sed.sp 61198090SrdivackyThe current tick which to adjustment will be calculated 62193323Sed.It Fl \&? , Fl \-help 63193323SedDisplay usage information and exit. 64193323Sed.It Fl \&! , Fl \-more\-help 65193323SedPass the extended usage information through a pager. 66193323Sed.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67193323SedOutput version of program and exit. The default mode is `v', a simple 68193323Sedversion. The `c' mode will print copyright information and `n' will 69193323Sedprint the full copyright notice. 70193323Sed.El 71193323Sed.Sh "EXIT STATUS" 72193323SedOne of the following exit values will be returned: 73212904Sdim.Bl -tag 74212904Sdim.It 0 " (EXIT_SUCCESS)" 75212904SdimSuccessful program execution. 76212904Sdim.It 1 " (EXIT_FAILURE)" 77212904SdimThe operation failed or the command syntax was not valid. 78212904Sdim.It 70 " (EX_SOFTWARE)" 79212904Sdimlibopts had an internal operational error. Please report 80212904Sdimit to autogen\-users@lists.sourceforge.net. Thank you. 81212904Sdim.El 82212904Sdim.Sh "NOTES" 83212904SdimThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84212904Sdimoption definitions. 85212904Sdim