1362716Scy.Dd June 23 2020
2275970Scy.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
3275970Scy.Os
4275970Scy.\"  EDIT THIS FILE WITH CAUTION  (calc_tickadj-opts.mdoc)
5275970Scy.\"
6362716Scy.\"  It has been AutoGen-ed  June 23, 2020 at 02:21:28 AM by AutoGen 5.18.5
7275970Scy.\"  From the definitions    calc_tickadj-opts.def
8275970Scy.\"  and the template file   agmdoc-cmd.tpl
9275970Scy.Sh NAME
10275970Scy.Nm calc_tickadj
11275970Scy.Nd Calculates "optimal" value for tick given ntp drift file.
12275970Scy.Sh SYNOPSIS
13275970Scy.Nm
14275970Scy.\" Mixture of short (flag) options and long options
15275970Scy.Op Fl flags
16275970Scy.Op Fl flag Op Ar value
17275970Scy.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18275970Scy.Pp
19275970ScyAll arguments must be options.
20275970Scy.Pp
21275970Scy.Sh DESCRIPTION
22275970ScyThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal
23275970Scytick value. Generally, ntpd can do better job if the drift value is the
24275970Scysmallest possible number. 
25275970Scy.sp
26275970ScyThe example output of 
27275970Scy.Bd -literal -offset indent
28275970Scy$ ./calc_tickadj
29275970Scy81.699 (drift)
30275970Scy9999 usec; 9999779 nsec
31275970Scy$ cat /etc/ntp/drift
32275970Scy-23.159
33275970Scy.Ed
34275970Scy.sp
35275970Scymeans the following. If tick on that box is 10,000, by making the value 9999
36275970Scywe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and
37275970Scyin doing so we'll speed the clock up a little every second instead of slowing
38275970Scythe clock down a little.
39275970Scy.sp
40275970ScyIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
41275970Scyvalue will be somewhere around 0.0.
42275970Scy.sp
43275970Scy\fBcalc_tickadj\fP tries to determine the the tick value by using
44275970Scy\fBtickadj\fP program from ntp package. If this doesn't work you can specify
45275970Scycurrent tick manually on command line.
46275970Scy.Sh "OPTIONS"
47275970Scy.Bl -tag
48275970Scy.It  Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 
49275970ScyNtp drift file to use.
50275970ScyThe default
51275970Scy.Ar string
52275970Scyfor this option is:
53275970Scy.ti +4
54275970Scy /etc/ntp/drift
55275970Scy.sp
56275970ScyUse the specified drift file for calculations
57275970Scy.It  Fl t Ar number , Fl \-tick Ns = Ns Ar number 
58275970ScyTick value of this host.
59275970ScyThis option takes an integer number as its argument.
60275970Scy.sp
61275970ScyThe current tick which to adjustment will be calculated
62275970Scy.It Fl \&? , Fl \-help
63275970ScyDisplay usage information and exit.
64275970Scy.It Fl \&! , Fl \-more\-help
65275970ScyPass the extended usage information through a pager.
66275970Scy.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
67275970ScyOutput version of program and exit.  The default mode is `v', a simple
68275970Scyversion.  The `c' mode will print copyright information and `n' will
69275970Scyprint the full copyright notice.
70275970Scy.El
71275970Scy.Sh "EXIT STATUS"
72275970ScyOne of the following exit values will be returned:
73275970Scy.Bl -tag
74275970Scy.It 0 " (EXIT_SUCCESS)"
75275970ScySuccessful program execution.
76275970Scy.It 1 " (EXIT_FAILURE)"
77275970ScyThe operation failed or the command syntax was not valid.
78275970Scy.It 70 " (EX_SOFTWARE)"
79275970Scylibopts had an internal operational error.  Please report
80275970Scyit to autogen\-users@lists.sourceforge.net.  Thank you.
81275970Scy.El
82275970Scy.Sh "NOTES"
83275970ScyThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP
84275970Scyoption definitions.
85