1275970Scy@node calc_tickadj Invocation 2275970Scy@section Invoking calc_tickadj 3275970Scy@pindex calc_tickadj 4275970Scy@cindex Calculates "optimal" value for tick given ntp drift file. 5275970Scy@ignore 6275970Scy# 7275970Scy# EDIT THIS FILE WITH CAUTION (invoke-calc_tickadj.texi) 8275970Scy# 9338531Sdelphij# It has been AutoGen-ed August 14, 2018 at 08:08:59 AM by AutoGen 5.18.5 10275970Scy# From the definitions calc_tickadj-opts.def 11275970Scy# and the template file agtexi-cmd.tpl 12275970Scy@end ignore 13275970Scy 14275970ScyThe @code{calc_tickadj} script uses provided ntp drift file to generate optimal 15275970Scytick value. Generally, ntpd can do better job if the drift value is the 16275970Scysmallest possible number. 17275970Scy 18275970ScyThe example output of 19275970Scy@example 20275970Scy$ ./calc_tickadj 21275970Scy81.699 (drift) 22275970Scy9999 usec; 9999779 nsec 23275970Scy$ cat /etc/ntp/drift 24275970Scy-23.159 25275970Scy@end example 26275970Scy 27275970Scymeans the following. If tick on that box is 10,000, by making the value 9999 28275970Scywe'll shift the box from its current drift of -23.159 to a drift of 81.699, and 29275970Scyin doing so we'll speed the clock up a little every second instead of slowing 30275970Scythe clock down a little. 31275970Scy 32275970ScyIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift 33275970Scyvalue will be somewhere around 0.0. 34275970Scy 35275970Scy@code{calc_tickadj} tries to determine the the tick value by using 36275970Scy@code{tickadj} program from ntp package. If this doesn't work you can specify 37275970Scycurrent tick manually on command line. 38275970Scy 39275970Scy 40275970ScyThis section was generated by @strong{AutoGen}, 41275970Scyusing the @code{agtexi-cmd} template and the option descriptions for the @code{calc_tickadj} program. 42275970Scy 43275970Scy@menu 44275970Scy* calc_tickadj usage:: calc_tickadj help/usage (@option{--help}) 45275970Scy* calc_tickadj drift-file:: drift-file option (-d) 46275970Scy* calc_tickadj tick:: tick option (-t) 47275970Scy* calc_tickadj exit status:: exit status 48275970Scy@end menu 49275970Scy 50275970Scy@node calc_tickadj usage 51275970Scy@subsection calc_tickadj help/usage (@option{--help}) 52275970Scy@cindex calc_tickadj help 53275970Scy 54275970ScyThis is the automatically generated usage text for calc_tickadj. 55275970Scy 56275970ScyThe text printed is the same whether selected with the @code{help} option 57275970Scy(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 58275970Scythe usage text by passing it through a pager program. 59275970Scy@code{more-help} is disabled on platforms without a working 60275970Scy@code{fork(2)} function. The @code{PAGER} environment variable is 61275970Scyused to select the program, defaulting to @file{more}. Both will exit 62275970Scywith a status code of 0. 63275970Scy 64275970Scy@exampleindent 0 65275970Scy@example 66275970Scycalc_tickadj - Calculates "optimal" value for tick given ntp drift file. - Ver. 4.2.7p467 67275970ScyUSAGE: calc_tickadj [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 68275970Scy 69275970Scy -d, --drift-file=str Ntp drift file to use 70275970Scy -t, --tick=num Tick value of this host 71275970Scy -?, --help Display usage information and exit 72275970Scy --more-help Pass the extended usage text through a pager 73275970Scy 74275970ScyOptions are specified by doubled hyphens and their name or by a single 75275970Scyhyphen and the flag character. 76275970Scy@end example 77275970Scy@exampleindent 4 78275970Scy 79275970Scy@node calc_tickadj drift-file 80275970Scy@subsection drift-file option (-d) 81275970Scy@cindex calc_tickadj-drift-file 82275970Scy 83275970ScyThis is the ``ntp drift file to use'' option. 84275970ScyThis option takes a string argument. 85275970ScyUse the specified drift file for calculations 86275970Scy@node calc_tickadj tick 87275970Scy@subsection tick option (-t) 88275970Scy@cindex calc_tickadj-tick 89275970Scy 90275970ScyThis is the ``tick value of this host'' option. 91275970ScyThis option takes a number argument. 92275970ScyThe current tick which to adjustment will be calculated 93275970Scy@node calc_tickadj exit status 94275970Scy@subsection calc_tickadj exit status 95275970Scy 96275970ScyOne of the following exit values will be returned: 97275970Scy@table @samp 98275970Scy@item 0 (EXIT_SUCCESS) 99275970ScySuccessful program execution. 100275970Scy@item 1 (EXIT_FAILURE) 101275970ScyThe operation failed or the command syntax was not valid. 102275970Scy@end table 103