1310419Sdelphij.Dd November 21 2016
2290001Sglebius.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands
3290001Sglebius.Os
4290001Sglebius.\"  EDIT THIS FILE WITH CAUTION  (calc_tickadj-opts.mdoc)
5290001Sglebius.\"
6310419Sdelphij.\"  It has been AutoGen-ed  November 21, 2016 at 07:58:36 AM by AutoGen 5.18.5
7290001Sglebius.\"  From the definitions    calc_tickadj-opts.def
8290001Sglebius.\"  and the template file   agmdoc-cmd.tpl
9290001Sglebius.Sh NAME
10290001Sglebius.Nm calc_tickadj
11290001Sglebius.Nd Calculates "optimal" value for tick given ntp drift file.
12290001Sglebius.Sh SYNOPSIS
13290001Sglebius.Nm
14290001Sglebius.\" Mixture of short (flag) options and long options
15290001Sglebius.Op Fl flags
16290001Sglebius.Op Fl flag Op Ar value
17290001Sglebius.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18290001Sglebius.Pp
19290001SglebiusAll arguments must be options.
20290001Sglebius.Pp
21290001Sglebius.Sh DESCRIPTION
22290001SglebiusThe \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal
23290001Sglebiustick value. Generally, ntpd can do better job if the drift value is the
24290001Sglebiussmallest possible number. 
25290001Sglebius.sp
26290001SglebiusThe example output of 
27290001Sglebius.Bd -literal -offset indent
28290001Sglebius$ ./calc_tickadj
29290001Sglebius81.699 (drift)
30290001Sglebius9999 usec; 9999779 nsec
31290001Sglebius$ cat /etc/ntp/drift
32290001Sglebius-23.159
33290001Sglebius.Ed
34290001Sglebius.sp
35290001Sglebiusmeans the following. If tick on that box is 10,000, by making the value 9999
36290001Sglebiuswe'll shift the box from its current drift of \-23.159 to a drift of 81.699, and
37290001Sglebiusin doing so we'll speed the clock up a little every second instead of slowing
38290001Sglebiusthe clock down a little.
39290001Sglebius.sp
40290001SglebiusIf 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
41290001Sglebiusvalue will be somewhere around 0.0.
42290001Sglebius.sp
43290001Sglebius\fBcalc_tickadj\fP tries to determine the the tick value by using
44290001Sglebius\fBtickadj\fP program from ntp package. If this doesn't work you can specify
45290001Sglebiuscurrent tick manually on command line.
46290001Sglebius.Sh "OPTIONS"
47290001Sglebius.Bl -tag
48290001Sglebius.It  Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string 
49290001SglebiusNtp drift file to use.
50290001SglebiusThe default
51290001Sglebius.Ar string
52290001Sglebiusfor this option is:
53290001Sglebius.ti +4
54290001Sglebius /etc/ntp/drift
55290001Sglebius.sp
56290001SglebiusUse the specified drift file for calculations
57290001Sglebius.It  Fl t Ar number , Fl \-tick Ns = Ns Ar number 
58290001SglebiusTick value of this host.
59290001SglebiusThis option takes an integer number as its argument.
60290001Sglebius.sp
61290001SglebiusThe current tick which to adjustment will be calculated
62290001Sglebius.It Fl \&? , Fl \-help
63290001SglebiusDisplay usage information and exit.
64290001Sglebius.It Fl \&! , Fl \-more\-help
65290001SglebiusPass the extended usage information through a pager.
66290001Sglebius.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
67290001SglebiusOutput version of program and exit.  The default mode is `v', a simple
68290001Sglebiusversion.  The `c' mode will print copyright information and `n' will
69290001Sglebiusprint the full copyright notice.
70290001Sglebius.El
71290001Sglebius.Sh "EXIT STATUS"
72290001SglebiusOne of the following exit values will be returned:
73290001Sglebius.Bl -tag
74290001Sglebius.It 0 " (EXIT_SUCCESS)"
75290001SglebiusSuccessful program execution.
76290001Sglebius.It 1 " (EXIT_FAILURE)"
77290001SglebiusThe operation failed or the command syntax was not valid.
78290001Sglebius.It 70 " (EX_SOFTWARE)"
79290001Sglebiuslibopts had an internal operational error.  Please report
80290001Sglebiusit to autogen\-users@lists.sourceforge.net.  Thank you.
81290001Sglebius.El
82290001Sglebius.Sh "NOTES"
83290001SglebiusThis manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP
84290001Sglebiusoption definitions.
85