1275970Scy<html lang="en">
2275970Scy<head>
3275970Scy<title>calc_tickadj User's Manual</title>
4275970Scy<meta http-equiv="Content-Type" content="text/html">
5275970Scy<meta name="description" content="calc_tickadj User's Manual">
6275970Scy<meta name="generator" content="makeinfo 4.7">
7275970Scy<link title="Top" rel="top" href="#Top">
8275970Scy<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9275970Scy<meta http-equiv="Content-Style-Type" content="text/css">
10275970Scy<style type="text/css"><!--
11275970Scy  pre.display { font-family:inherit }
12275970Scy  pre.format  { font-family:inherit }
13275970Scy  pre.smalldisplay { font-family:inherit; font-size:smaller }
14275970Scy  pre.smallformat  { font-family:inherit; font-size:smaller }
15275970Scy  pre.smallexample { font-size:smaller }
16275970Scy  pre.smalllisp    { font-size:smaller }
17275970Scy  span.sc { font-variant:small-caps }
18275970Scy  span.roman { font-family: serif; font-weight: normal; } 
19275970Scy--></style>
20275970Scy</head>
21275970Scy<body>
22275970Scy<h1 class="settitle">calc_tickadj User's Manual</h1>
23275970Scy<div class="node">
24275970Scy<p><hr>
25275970Scy<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-Description">calc_tickadj Description</a>,
26275970ScyPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28275970Scy<br>
29275970Scy</div>
30275970Scy
31275970Scy<h2 class="unnumbered">calc_tickadj User's Manual</h2>
32275970Scy
33275970Scy<p>This document describes the use of the NTP Project's <code>calc_tickadj</code> program. 
34316722SdelphijThis document applies to version 4.2.8p10 of <code>calc_tickadj</code>.
35275970Scy
36275970Scy  <div class="shortcontents">
37275970Scy<h2>Short Contents</h2>
38275970Scy<ul>
39275970Scy<a href="#Top">calc_tickadj User's Manual</a>
40275970Scy</ul>
41275970Scy</div>
42275970Scy
43275970Scy<ul class="menu">
44275970Scy<li><a accesskey="1" href="#calc_005ftickadj-Description">calc_tickadj Description</a>:        Description
45275970Scy<li><a accesskey="2" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>:         Invoking calc_tickadj
46275970Scy</ul>
47275970Scy
48275970Scy<div class="node">
49275970Scy<p><hr>
50275970Scy<a name="calc_005ftickadj-Invocation"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-Description">calc_tickadj Description</a>,
51275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
52275970Scy<br>
53275970Scy</div>
54275970Scy
55275970Scy<h3 class="section">Invoking calc_tickadj</h3>
56275970Scy
57275970Scy<p><a name="index-calc_005ftickadj-1"></a><a name="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e-2"></a>
58275970ScyThe <code>calc_tickadj</code> script uses provided ntp drift file to generate optimal
59275970Scytick value. Generally, ntpd can do better job if the drift value is the
60275970Scysmallest possible number.
61275970Scy
62275970Scy  <p>The example output of
63275970Scy<pre class="example">     $ ./calc_tickadj
64275970Scy     81.699 (drift)
65275970Scy     9999 usec; 9999779 nsec
66275970Scy     $ cat /etc/ntp/drift
67275970Scy     -23.159
68275970Scy</pre>
69275970Scy  <p>means the following. If tick on that box is 10,000, by making the value 9999
70275970Scywe'll shift the box from its current drift of -23.159 to a drift of 81.699, and
71275970Scyin doing so we'll speed the clock up a little every second instead of slowing
72275970Scythe clock down a little.
73275970Scy
74275970Scy  <p>If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift
75275970Scyvalue will be somewhere around 0.0.
76275970Scy
77275970Scy  <p><code>calc_tickadj</code> tries to determine the the tick value by using
78275970Scy<code>tickadj</code> program from ntp package. If this doesn't work you can specify
79275970Scycurrent tick manually on command line.
80275970Scy
81275970Scy  <p>This section was generated by <strong>AutoGen</strong>,
82275970Scyusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>calc_tickadj</code> program.
83275970Scy
84275970Scy<ul class="menu">
85275970Scy<li><a accesskey="1" href="#calc_005ftickadj-usage">calc_tickadj usage</a>:                   calc_tickadj help/usage (<span class="option">--help</span>)
86275970Scy<li><a accesskey="2" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>:              drift-file option (-d)
87275970Scy<li><a accesskey="3" href="#calc_005ftickadj-tick">calc_tickadj tick</a>:                    tick option (-t)
88275970Scy<li><a accesskey="4" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>:             exit status
89275970Scy</ul>
90275970Scy
91275970Scy<div class="node">
92275970Scy<p><hr>
93275970Scy<a name="calc_005ftickadj-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>,
94275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
95275970Scy<br>
96275970Scy</div>
97275970Scy
98275970Scy<h4 class="subsection">calc_tickadj help/usage (<span class="option">--help</span>)</h4>
99275970Scy
100275970Scy<p><a name="index-calc_005ftickadj-help-3"></a>
101275970ScyThis is the automatically generated usage text for calc_tickadj.
102275970Scy
103275970Scy  <p>The text printed is the same whether selected with the <code>help</code> option
104275970Scy(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
105275970Scythe usage text by passing it through a pager program. 
106275970Scy<code>more-help</code> is disabled on platforms without a working
107275970Scy<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
108275970Scyused to select the program, defaulting to <span class="file">more</span>.  Both will exit
109275970Scywith a status code of 0.
110275970Scy
111275970Scy<pre class="example">calc_tickadj - Calculates "optimal" value for tick given ntp drift file. - Ver. 4.2.7p467
112275970ScyUSAGE: calc_tickadj [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]...
113275970Scy
114275970Scy    -d, --drift-file=str         Ntp drift file to use
115275970Scy    -t, --tick=num               Tick value of this host
116275970Scy    -?, --help                   Display usage information and exit
117275970Scy        --more-help              Pass the extended usage text through a pager
118275970Scy
119275970ScyOptions are specified by doubled hyphens and their name or by a single
120275970Scyhyphen and the flag character.
121275970Scy</pre>
122275970Scy  <div class="node">
123275970Scy<p><hr>
124275970Scy<a name="calc_005ftickadj-drift_002dfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-tick">calc_tickadj tick</a>,
125275970ScyPrevious:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-usage">calc_tickadj usage</a>,
126275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
127275970Scy<br>
128275970Scy</div>
129275970Scy
130275970Scy<h4 class="subsection">drift-file option (-d)</h4>
131275970Scy
132275970Scy<p><a name="index-calc_005ftickadj_002ddrift_002dfile-4"></a>
133275970ScyThis is the &ldquo;ntp drift file to use&rdquo; option. 
134275970ScyThis option takes a string argument. 
135275970ScyUse the specified drift file for calculations
136275970Scy<div class="node">
137275970Scy<p><hr>
138275970Scy<a name="calc_005ftickadj-tick"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>,
139275970ScyPrevious:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>,
140275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
141275970Scy<br>
142275970Scy</div>
143275970Scy
144275970Scy<h4 class="subsection">tick option (-t)</h4>
145275970Scy
146275970Scy<p><a name="index-calc_005ftickadj_002dtick-5"></a>
147275970ScyThis is the &ldquo;tick value of this host&rdquo; option. 
148275970ScyThis option takes a number argument. 
149275970ScyThe current tick which to adjustment will be calculated
150275970Scy<div class="node">
151275970Scy<p><hr>
152275970Scy<a name="calc_005ftickadj-exit-status"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#calc_005ftickadj-tick">calc_tickadj tick</a>,
153275970ScyUp:&nbsp;<a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>
154275970Scy<br>
155275970Scy</div>
156275970Scy
157275970Scy<h4 class="subsection">calc_tickadj exit status</h4>
158275970Scy
159275970Scy<p>One of the following exit values will be returned:
160275970Scy     <dl>
161275970Scy<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
162275970Scy<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
163275970Scy</dl>
164275970Scy
165275970Scy</body></html>
166275970Scy
167