calc_tickadj.mdoc.in revision 301247
1202878Srdivacky.Dd June 2 2016 2202878Srdivacky.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 3202878Srdivacky.Os 4202878Srdivacky.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 5202878Srdivacky.\" 6202878Srdivacky.\" It has been AutoGen-ed June 2, 2016 at 07:24:27 AM by AutoGen 5.18.5 7202878Srdivacky.\" From the definitions calc_tickadj-opts.def 8202878Srdivacky.\" and the template file agmdoc-cmd.tpl 9202878Srdivacky.Sh NAME 10249423Sdim.Nm calc_tickadj 11249423Sdim.Nd Calculates "optimal" value for tick given ntp drift file. 12202878Srdivacky.Sh SYNOPSIS 13202878Srdivacky.Nm 14202878Srdivacky.\" Mixture of short (flag) options and long options 15202878Srdivacky.Op Fl flags 16202878Srdivacky.Op Fl flag Op Ar value 17202878Srdivacky.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18202878Srdivacky.Pp 19202878SrdivackyAll arguments must be options. 20202878Srdivacky.Pp 21202878Srdivacky.Sh DESCRIPTION 22202878SrdivackyThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 23202878Srdivackytick value. Generally, ntpd can do better job if the drift value is the 24202878Srdivackysmallest possible number. 25202878Srdivacky.sp 26202878SrdivackyThe example output of 27202878Srdivacky.Bd -literal -offset indent 28202878Srdivacky$ ./calc_tickadj 29202878Srdivacky81.699 (drift) 30202878Srdivacky9999 usec; 9999779 nsec 31202878Srdivacky$ cat /etc/ntp/drift 32202878Srdivacky-23.159 33202878Srdivacky.Ed 34202878Srdivacky.sp 35202878Srdivackymeans the following. If tick on that box is 10,000, by making the value 9999 36202878Srdivackywe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 37202878Srdivackyin doing so we'll speed the clock up a little every second instead of slowing 38202878Srdivackythe clock down a little. 39202878Srdivacky.sp 40202878SrdivackyIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 41value will be somewhere around 0.0. 42.sp 43\fBcalc_tickadj\fP tries to determine the the tick value by using 44\fBtickadj\fP program from ntp package. If this doesn't work you can specify 45current tick manually on command line. 46.Sh "OPTIONS" 47.Bl -tag 48.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 49Ntp drift file to use. 50The default 51.Ar string 52for this option is: 53.ti +4 54 /etc/ntp/drift 55.sp 56Use the specified drift file for calculations 57.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 58Tick value of this host. 59This option takes an integer number as its argument. 60.sp 61The current tick which to adjustment will be calculated 62.It Fl \&? , Fl \-help 63Display usage information and exit. 64.It Fl \&! , Fl \-more\-help 65Pass the extended usage information through a pager. 66.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 67Output version of program and exit. The default mode is `v', a simple 68version. The `c' mode will print copyright information and `n' will 69print the full copyright notice. 70.El 71.Sh "EXIT STATUS" 72One of the following exit values will be returned: 73.Bl -tag 74.It 0 " (EXIT_SUCCESS)" 75Successful program execution. 76.It 1 " (EXIT_FAILURE)" 77The operation failed or the command syntax was not valid. 78.It 70 " (EX_SOFTWARE)" 79libopts had an internal operational error. Please report 80it to autogen\-users@lists.sourceforge.net. Thank you. 81.El 82.Sh "NOTES" 83This manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 84option definitions. 85