1290001Sglebius<html lang="en">
2290001Sglebius<head>
3290001Sglebius<title>calc_tickadj User's Manual</title>
4290001Sglebius<meta http-equiv="Content-Type" content="text/html">
5290001Sglebius<meta name="description" content="calc_tickadj User's Manual">
6290001Sglebius<meta name="generator" content="makeinfo 4.7">
7290001Sglebius<link title="Top" rel="top" href="#Top">
8290001Sglebius<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9290001Sglebius<meta http-equiv="Content-Style-Type" content="text/css">
10290001Sglebius<style type="text/css"><!--
11290001Sglebius  pre.display { font-family:inherit }
12290001Sglebius  pre.format  { font-family:inherit }
13290001Sglebius  pre.smalldisplay { font-family:inherit; font-size:smaller }
14290001Sglebius  pre.smallformat  { font-family:inherit; font-size:smaller }
15290001Sglebius  pre.smallexample { font-size:smaller }
16290001Sglebius  pre.smalllisp    { font-size:smaller }
17290001Sglebius  span.sc { font-variant:small-caps }
18290001Sglebius  span.roman { font-family: serif; font-weight: normal; } 
19290001Sglebius--></style>
20290001Sglebius</head>
21290001Sglebius<body>
22290001Sglebius<h1 class="settitle">calc_tickadj User's Manual</h1>
23290001Sglebius<div class="node">
24290001Sglebius<p><hr>
25290001Sglebius<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-Description">calc_tickadj Description</a>,
26290001SglebiusPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28290001Sglebius<br>
29290001Sglebius</div>
30290001Sglebius
31290001Sglebius<h2 class="unnumbered">calc_tickadj User's Manual</h2>
32290001Sglebius
33290001Sglebius<p>This document describes the use of the NTP Project's <code>calc_tickadj</code> program. 
34310419SdelphijThis document applies to version 4.2.8p9 of <code>calc_tickadj</code>.
35290001Sglebius
36290001Sglebius  <div class="shortcontents">
37290001Sglebius<h2>Short Contents</h2>
38290001Sglebius<ul>
39290001Sglebius<a href="#Top">calc_tickadj User's Manual</a>
40290001Sglebius</ul>
41290001Sglebius</div>
42290001Sglebius
43290001Sglebius<ul class="menu">
44290001Sglebius<li><a accesskey="1" href="#calc_005ftickadj-Description">calc_tickadj Description</a>:        Description
45290001Sglebius<li><a accesskey="2" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>:         Invoking calc_tickadj
46290001Sglebius</ul>
47290001Sglebius
48290001Sglebius<div class="node">
49290001Sglebius<p><hr>
50290001Sglebius<a name="calc_005ftickadj-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-Description">calc_tickadj Description</a>,
51290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
52290001Sglebius<br>
53290001Sglebius</div>
54290001Sglebius
55290001Sglebius<h3 class="section">Invoking calc_tickadj</h3>
56290001Sglebius
57290001Sglebius<p><a name="index-calc_005ftickadj-1"></a><a name="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e-2"></a>
58290001SglebiusThe <code>calc_tickadj</code> script uses provided ntp drift file to generate optimal
59290001Sglebiustick value. Generally, ntpd can do better job if the drift value is the
60290001Sglebiussmallest possible number.
61290001Sglebius
62290001Sglebius  <p>The example output of
63290001Sglebius<pre class="example">     $ ./calc_tickadj
64290001Sglebius     81.699 (drift)
65290001Sglebius     9999 usec; 9999779 nsec
66290001Sglebius     $ cat /etc/ntp/drift
67290001Sglebius     -23.159
68290001Sglebius</pre>
69290001Sglebius  <p>means the following. If tick on that box is 10,000, by making the value 9999
70290001Sglebiuswe'll shift the box from its current drift of -23.159 to a drift of 81.699, and
71290001Sglebiusin doing so we'll speed the clock up a little every second instead of slowing
72290001Sglebiusthe clock down a little.
73290001Sglebius
74290001Sglebius  <p>If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
75290001Sglebiusvalue will be somewhere around 0.0.
76290001Sglebius
77290001Sglebius  <p><code>calc_tickadj</code> tries to determine the the tick value by using
78290001Sglebius<code>tickadj</code> program from ntp package. If this doesn't work you can specify
79290001Sglebiuscurrent tick manually on command line.
80290001Sglebius
81290001Sglebius  <p>This section was generated by <strong>AutoGen</strong>,
82290001Sglebiususing the <code>agtexi-cmd</code> template and the option descriptions for the <code>calc_tickadj</code> program.
83290001Sglebius
84290001Sglebius<ul class="menu">
85290001Sglebius<li><a accesskey="1" href="#calc_005ftickadj-usage">calc_tickadj usage</a>:                   calc_tickadj help/usage (<span class="option">--help</span>)
86290001Sglebius<li><a accesskey="2" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>:              drift-file option (-d)
87290001Sglebius<li><a accesskey="3" href="#calc_005ftickadj-tick">calc_tickadj tick</a>:                    tick option (-t)
88290001Sglebius<li><a accesskey="4" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>:             exit status
89290001Sglebius</ul>
90290001Sglebius
91290001Sglebius<div class="node">
92290001Sglebius<p><hr>
93290001Sglebius<a name="calc_005ftickadj-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>,
94290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
95290001Sglebius<br>
96290001Sglebius</div>
97290001Sglebius
98290001Sglebius<h4 class="subsection">calc_tickadj help/usage (<span class="option">--help</span>)</h4>
99290001Sglebius
100290001Sglebius<p><a name="index-calc_005ftickadj-help-3"></a>
101290001SglebiusThis is the automatically generated usage text for calc_tickadj.
102290001Sglebius
103290001Sglebius  <p>The text printed is the same whether selected with the <code>help</code> option
104290001Sglebius(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
105290001Sglebiusthe usage text by passing it through a pager program. 
106290001Sglebius<code>more-help</code> is disabled on platforms without a working
107290001Sglebius<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
108290001Sglebiusused to select the program, defaulting to <span class="file">more</span>.  Both will exit
109290001Sglebiuswith a status code of 0.
110290001Sglebius
111290001Sglebius<pre class="example">calc_tickadj - Calculates "optimal" value for tick given ntp drift file. - Ver. 4.2.7p467
112290001SglebiusUSAGE: calc_tickadj [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
113290001Sglebius
114290001Sglebius    -d, --drift-file=str         Ntp drift file to use
115290001Sglebius    -t, --tick=num               Tick value of this host
116290001Sglebius    -?, --help                   Display usage information and exit
117290001Sglebius        --more-help              Pass the extended usage text through a pager
118290001Sglebius
119290001SglebiusOptions are specified by doubled hyphens and their name or by a single
120290001Sglebiushyphen and the flag character.
121290001Sglebius</pre>
122290001Sglebius  <div class="node">
123290001Sglebius<p><hr>
124290001Sglebius<a name="calc_005ftickadj-drift_002dfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-tick">calc_tickadj tick</a>,
125290001SglebiusPrevious:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-usage">calc_tickadj usage</a>,
126290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
127290001Sglebius<br>
128290001Sglebius</div>
129290001Sglebius
130290001Sglebius<h4 class="subsection">drift-file option (-d)</h4>
131290001Sglebius
132290001Sglebius<p><a name="index-calc_005ftickadj_002ddrift_002dfile-4"></a>
133290001SglebiusThis is the &ldquo;ntp drift file to use&rdquo; option. 
134290001SglebiusThis option takes a string argument. 
135290001SglebiusUse the specified drift file for calculations
136290001Sglebius<div class="node">
137290001Sglebius<p><hr>
138290001Sglebius<a name="calc_005ftickadj-tick"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>,
139290001SglebiusPrevious:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>,
140290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
141290001Sglebius<br>
142290001Sglebius</div>
143290001Sglebius
144290001Sglebius<h4 class="subsection">tick option (-t)</h4>
145290001Sglebius
146290001Sglebius<p><a name="index-calc_005ftickadj_002dtick-5"></a>
147290001SglebiusThis is the &ldquo;tick value of this host&rdquo; option. 
148290001SglebiusThis option takes a number argument. 
149290001SglebiusThe current tick which to adjustment will be calculated
150290001Sglebius<div class="node">
151290001Sglebius<p><hr>
152290001Sglebius<a name="calc_005ftickadj-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-tick">calc_tickadj tick</a>,
153290001SglebiusUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
154290001Sglebius<br>
155290001Sglebius</div>
156290001Sglebius
157290001Sglebius<h4 class="subsection">calc_tickadj exit status</h4>
158290001Sglebius
159290001Sglebius<p>One of the following exit values will be returned:
160290001Sglebius     <dl>
161290001Sglebius<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
162290001Sglebius<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
163290001Sglebius</dl>
164290001Sglebius
165290001Sglebius</body></html>
166290001Sglebius
167