calc_tickadj.mdoc.in revision 275970
11590Srgrimes.Dd December 19 2014 21590Srgrimes.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands 31590Srgrimes.Os 41590Srgrimes.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) 51590Srgrimes.\" 61590Srgrimes.\" It has been AutoGen-ed December 19, 2014 at 07:44:39 AM by AutoGen 5.18.5pre4 71590Srgrimes.\" From the definitions calc_tickadj-opts.def 81590Srgrimes.\" and the template file agmdoc-cmd.tpl 91590Srgrimes.Sh NAME 101590Srgrimes.Nm calc_tickadj 111590Srgrimes.Nd Calculates "optimal" value for tick given ntp drift file. 121590Srgrimes.Sh SYNOPSIS 131590Srgrimes.Nm 141590Srgrimes.\" Mixture of short (flag) options and long options 151590Srgrimes.Op Fl flags 161590Srgrimes.Op Fl flag Op Ar value 171590Srgrimes.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 181590Srgrimes.Pp 191590SrgrimesAll arguments must be options. 201590Srgrimes.Pp 211590Srgrimes.Sh DESCRIPTION 221590SrgrimesThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal 231590Srgrimestick value. Generally, ntpd can do better job if the drift value is the 241590Srgrimessmallest possible number. 251590Srgrimes.sp 261590SrgrimesThe example output of 271590Srgrimes.Bd -literal -offset indent 281590Srgrimes$ ./calc_tickadj 291590Srgrimes81.699 (drift) 301590Srgrimes9999 usec; 9999779 nsec 311590Srgrimes$ cat /etc/ntp/drift 321590Srgrimes-23.159 331590Srgrimes.Ed 341590Srgrimes.sp 351590Srgrimesmeans the following. If tick on that box is 10,000, by making the value 9999 361590Srgrimeswe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and 371590Srgrimesin doing so we'll speed the clock up a little every second instead of slowing 381590Srgrimesthe clock down a little. 391590Srgrimes.sp 401590SrgrimesIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 411590Srgrimesvalue will be somewhere around 0.0. 421590Srgrimes.sp 431590Srgrimes\fBcalc_tickadj\fP tries to determine the the tick value by using 441590Srgrimes\fBtickadj\fP program from ntp package. If this doesn't work you can specify 451590Srgrimescurrent tick manually on command line. 461590Srgrimes.Sh "OPTIONS" 471590Srgrimes.Bl -tag 481590Srgrimes.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 491590SrgrimesNtp drift file to use. 501590SrgrimesThe default 511590Srgrimes.Ar string 521590Srgrimesfor this option is: 531590Srgrimes.ti +4 541590Srgrimes /etc/ntp/drift 551590Srgrimes.sp 561590SrgrimesUse the specified drift file for calculations 5728969Swosch.It Fl t Ar number , Fl \-tick Ns = Ns Ar number 581590SrgrimesTick value of this host. 591590SrgrimesThis option takes an integer number as its argument. 601590Srgrimes.sp 6128969SwoschThe current tick which to adjustment will be calculated 621590Srgrimes.It Fl \&? , Fl \-help 631590SrgrimesDisplay usage information and exit. 641590Srgrimes.It Fl \&! , Fl \-more\-help 651590SrgrimesPass the extended usage information through a pager. 661590Srgrimes.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 671590SrgrimesOutput version of program and exit. The default mode is `v', a simple 681590Srgrimesversion. The `c' mode will print copyright information and `n' will 691590Srgrimesprint the full copyright notice. 701590Srgrimes.El 711590Srgrimes.Sh "EXIT STATUS" 721590SrgrimesOne of the following exit values will be returned: 731590Srgrimes.Bl -tag 741590Srgrimes.It 0 " (EXIT_SUCCESS)" 751590SrgrimesSuccessful program execution. 761590Srgrimes.It 1 " (EXIT_FAILURE)" 771590SrgrimesThe operation failed or the command syntax was not valid. 781590Srgrimes.It 70 " (EX_SOFTWARE)" 791590Srgrimeslibopts had an internal operational error. Please report 801590Srgrimesit to autogen\-users@lists.sourceforge.net. Thank you. 811590Srgrimes.El 821590Srgrimes.Sh "NOTES" 831590SrgrimesThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP 841590Srgrimesoption definitions. 851590Srgrimes