calc_tickadj.mdoc.in revision 301301
1219019Sgabor.Dd June 2 2016 2219019Sgabor.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3219019Sgabor.Os 4219019Sgabor.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5219019Sgabor.\" 6219019Sgabor.\" It has been AutoGen-ed June 2, 2016 at 07:24:27 AM by AutoGen 5.18.5 7219019Sgabor.\" From the definitions calc_tickadj-opts.def 8219019Sgabor.\" and the template file agmdoc-cmd.tpl 9219019Sgabor.Sh NAME 10219019Sgabor.Nm calc_tickadj 11219019Sgabor.Nd Calculates "optimal" value for tick given ntp drift file. 12219019Sgabor.Sh SYNOPSIS 13219019Sgabor.Nm 14219019Sgabor.\" Mixture of short (flag) options and long options 15219019Sgabor.Op Fl flags 16219019Sgabor.Op Fl flag Op Ar value 17219019Sgabor.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18219019Sgabor.Pp 19219019SgaborAll arguments must be options. 20219019Sgabor.Pp 21219019Sgabor.Sh DESCRIPTION 22219019SgaborThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23219019Sgabortick value. Generally, ntpd can do better job if the drift value is the 24219019Sgaborsmallest possible number. 25219019Sgabor.sp 26219019SgaborThe example output of 27219019Sgabor.Bd -literal -offset indent 28219019Sgabor$ ./calc_tickadj 29219019Sgabor81.699 (drift) 30219019Sgabor9999 usec; 9999779 nsec 31219019Sgabor$ cat /etc/ntp/drift 32219019Sgabor-23.159 33219019Sgabor.Ed 34219019Sgabor.sp 35219019Sgabormeans the following. If tick on that box is 10,000, by making the value 9999 36219019Sgaborwe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37219019Sgaborin doing so we'll speed the clock up a little every second instead of slowing 38219019Sgaborthe clock down a little. 39219019Sgabor.sp 40219019SgaborIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41219019Sgaborvalue will be somewhere around 0.0. 42219019Sgabor.sp 43219019Sgabor\fBcalc_tickadj\fP tries to determine the the tick value by using 44219019Sgabor\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45219019Sgaborcurrent tick manually on command line. 46240365Sdim.Sh "OPTIONS" 47219019Sgabor.Bl -tag 48219019Sgabor.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49219019SgaborNtp drift file to use. 50219019SgaborThe default 51219019Sgabor.Ar string 52219019Sgaborfor this option is: 53219019Sgabor.ti +4 54219019Sgabor /etc/ntp/drift 55219019Sgabor.sp 56219019SgaborUse the specified drift file for calculations 57219019Sgabor.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58219019SgaborTick value of this host. 59219019SgaborThis option takes an integer number as its argument. 60219019Sgabor.sp 61238197SeadlerThe current tick which to adjustment will be calculated 62219019Sgabor.It Fl \&? , Fl \-help 63219019SgaborDisplay usage information and exit. 64219019Sgabor.It Fl \&! , Fl \-more\-help 65219019SgaborPass the extended usage information through a pager. 66219019Sgabor.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67219019SgaborOutput version of program and exit. The default mode is `v', a simple 68219019Sgaborversion. The `c' mode will print copyright information and `n' will 69219019Sgaborprint the full copyright notice. 70219019Sgabor.El 71219019Sgabor.Sh "EXIT STATUS" 72219019SgaborOne of the following exit values will be returned: 73219019Sgabor.Bl -tag 74219019Sgabor.It 0 " (EXIT_SUCCESS)" 75219019SgaborSuccessful program execution. 76219019Sgabor.It 1 " (EXIT_FAILURE)" 77219019SgaborThe operation failed or the command syntax was not valid. 78219019Sgabor.It 70 " (EX_SOFTWARE)" 79219019Sgaborlibopts had an internal operational error. Please report 80219019Sgaborit to autogen\-users@lists.sourceforge.net. Thank you. 81219019Sgabor.El 82219019Sgabor.Sh "NOTES" 83219019SgaborThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84219019Sgaboroption definitions. 85219019Sgabor