diff options
Diffstat (limited to 'scripts/calc_tickadj/calc_tickadj.html')
| -rw-r--r-- | scripts/calc_tickadj/calc_tickadj.html | 306 |
1 files changed, 181 insertions, 125 deletions
diff --git a/scripts/calc_tickadj/calc_tickadj.html b/scripts/calc_tickadj/calc_tickadj.html index baba8c71883b..3f65c4948359 100644 --- a/scripts/calc_tickadj/calc_tickadj.html +++ b/scripts/calc_tickadj/calc_tickadj.html @@ -1,115 +1,156 @@ -<html lang="en"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> <head> -<title>calc_tickadj User's Manual</title> -<meta http-equiv="Content-Type" content="text/html"> -<meta name="description" content="calc_tickadj User's Manual"> -<meta name="generator" content="makeinfo 4.7"> -<link title="Top" rel="top" href="#Top"> -<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> -<meta http-equiv="Content-Style-Type" content="text/css"> -<style type="text/css"><!-- - pre.display { font-family:inherit } - pre.format { font-family:inherit } - pre.smalldisplay { font-family:inherit; font-size:smaller } - pre.smallformat { font-family:inherit; font-size:smaller } - pre.smallexample { font-size:smaller } - pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family: serif; font-weight: normal; } ---></style> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>calc_tickadj User’s Manual</title> + +<meta name="description" content="calc_tickadj User’s Manual"> +<meta name="keywords" content="calc_tickadj User’s Manual"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="#Top" rel="start" title="Top"> +<link href="dir.html#Top" rel="up" title="(dir)"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smalllisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + </head> -<body> -<h1 class="settitle">calc_tickadj User's Manual</h1> -<div class="node"> -<p><hr> -<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#calc_005ftickadj-Description">calc_tickadj Description</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -<br> -</div> -<h2 class="unnumbered">calc_tickadj User's Manual</h2> +<body lang="en"> +<h1 class="settitle" align="center">calc_tickadj User’s Manual</h1> -<p>This document describes the use of the NTP Project's <code>calc_tickadj</code> program. -This document applies to version 4.2.8p12 of <code>calc_tickadj</code>. - <div class="shortcontents"> -<h2>Short Contents</h2> -<ul> -<a href="#Top">calc_tickadj User's Manual</a> + + +<a name="Top"></a> +<div class="header"> +<p> +Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> +</div> +<a name="calc_005ftickadj-User_0027s-Manual"></a> +<h1 class="top">calc_tickadj User’s Manual</h1> + +<p>This document describes the use of the NTP Project’s <code>calc_tickadj</code> program. +This document applies to version 4.2.8p13 of <code>calc_tickadj</code>. +</p> +<a name="SEC_Overview"></a> +<h2 class="shortcontents-heading">Short Table of Contents</h2> + +<div class="shortcontents"> +<ul class="no-bullet"> +<li><a name="stoc-Invoking-calc_005ftickadj" href="#toc-Invoking-calc_005ftickadj">1 Invoking calc_tickadj</a></li> </ul> </div> -<ul class="menu"> -<li><a accesskey="1" href="#calc_005ftickadj-Description">calc_tickadj Description</a>: Description -<li><a accesskey="2" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a>: Invoking calc_tickadj -</ul> -<div class="node"> -<p><hr> -<a name="calc_005ftickadj-Invocation"></a>Previous: <a rel="previous" accesskey="p" href="#calc_005ftickadj-Description">calc_tickadj Description</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> -<br> -</div> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• calc_tickadj Description:</td><td> </td><td align="left" valign="top">Description +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-Invocation" accesskey="2">calc_tickadj Invocation</a>:</td><td> </td><td align="left" valign="top">Invoking calc_tickadj +</td></tr> +</table> -<h3 class="section">Invoking calc_tickadj</h3> +<hr> +<a name="calc_005ftickadj-Invocation"></a> +<div class="header"> +<p> +Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> +</div> +<a name="Invoking-calc_005ftickadj"></a> +<h2 class="chapter">1 Invoking calc_tickadj</h2> +<a name="index-calc_005ftickadj"></a> +<a name="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e"></a> -<p><a name="index-calc_005ftickadj-1"></a><a name="index-Calculates-_0022optimal_0022-value-for-tick-given-ntp-drift-file_002e-2"></a> -The <code>calc_tickadj</code> script uses provided ntp drift file to generate optimal +<p>The <code>calc_tickadj</code> script uses provided ntp drift file to generate optimal tick value. Generally, ntpd can do better job if the drift value is the -smallest possible number. - - <p>The example output of -<pre class="example"> $ ./calc_tickadj - 81.699 (drift) - 9999 usec; 9999779 nsec - $ cat /etc/ntp/drift - -23.159 -</pre> - <p>means the following. If tick on that box is 10,000, by making the value 9999 -we'll shift the box from its current drift of -23.159 to a drift of 81.699, and -in doing so we'll speed the clock up a little every second instead of slowing +smallest possible number. +</p> +<p>The example output of +</p><div class="example"> +<pre class="example">$ ./calc_tickadj +81.699 (drift) +9999 usec; 9999779 nsec +$ cat /etc/ntp/drift +-23.159 +</pre></div> + +<p>means the following. If tick on that box is 10,000, by making the value 9999 +we’ll shift the box from its current drift of -23.159 to a drift of 81.699, and +in doing so we’ll speed the clock up a little every second instead of slowing the clock down a little. - - <p>If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +</p> +<p>If ’tick’ on that box is 10,000,000 then by setting it to 9999779 the drift value will be somewhere around 0.0. - - <p><code>calc_tickadj</code> tries to determine the the tick value by using -<code>tickadj</code> program from ntp package. If this doesn't work you can specify +</p> +<p><code>calc_tickadj</code> tries to determine the the tick value by using +<code>tickadj</code> program from ntp package. If this doesn’t work you can specify current tick manually on command line. +</p> - <p>This section was generated by <strong>AutoGen</strong>, +<p>This section was generated by <strong>AutoGen</strong>, using the <code>agtexi-cmd</code> template and the option descriptions for the <code>calc_tickadj</code> program. - -<ul class="menu"> -<li><a accesskey="1" href="#calc_005ftickadj-usage">calc_tickadj usage</a>: calc_tickadj help/usage (<span class="option">--help</span>) -<li><a accesskey="2" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>: drift-file option (-d) -<li><a accesskey="3" href="#calc_005ftickadj-tick">calc_tickadj tick</a>: tick option (-t) -<li><a accesskey="4" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>: exit status -</ul> - -<div class="node"> -<p><hr> -<a name="calc_005ftickadj-usage"></a>Next: <a rel="next" accesskey="n" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>, -Up: <a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a> -<br> +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-usage" accesskey="1">calc_tickadj usage</a>:</td><td> </td><td align="left" valign="top">calc_tickadj help/usage (<samp>--help</samp>) +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="2">calc_tickadj drift-file</a>:</td><td> </td><td align="left" valign="top">drift-file option (-d) +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="3">calc_tickadj tick</a>:</td><td> </td><td align="left" valign="top">tick option (-t) +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="4">calc_tickadj exit status</a>:</td><td> </td><td align="left" valign="top">exit status +</td></tr> +</table> + +<hr> +<a name="calc_005ftickadj-usage"></a> +<div class="header"> +<p> +Next: <a href="#calc_005ftickadj-drift_002dfile" accesskey="n" rel="next">calc_tickadj drift-file</a>, Up: <a href="#calc_005ftickadj-Invocation" accesskey="u" rel="up">calc_tickadj Invocation</a> </p> </div> - -<h4 class="subsection">calc_tickadj help/usage (<span class="option">--help</span>)</h4> - -<p><a name="index-calc_005ftickadj-help-3"></a> -This is the automatically generated usage text for calc_tickadj. - - <p>The text printed is the same whether selected with the <code>help</code> option -(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print -the usage text by passing it through a pager program. +<a name="calc_005ftickadj-help_002fusage-_0028_002d_002dhelp_0029"></a> +<h3 class="section">1.1 calc_tickadj help/usage (<samp>--help</samp>)</h3> +<a name="index-calc_005ftickadj-help"></a> + +<p>This is the automatically generated usage text for calc_tickadj. +</p> +<p>The text printed is the same whether selected with the <code>help</code> option +(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print +the usage text by passing it through a pager program. <code>more-help</code> is disabled on platforms without a working <code>fork(2)</code> function. The <code>PAGER</code> environment variable is -used to select the program, defaulting to <span class="file">more</span>. Both will exit +used to select the program, defaulting to <samp>more</samp>. Both will exit with a status code of 0. - -<pre class="example">calc_tickadj - Calculates "optimal" value for tick given ntp drift file. - Ver. 4.2.7p467 -USAGE: calc_tickadj [ -<flag> [<val>] | --<name>[{=| }<val>] ]... +</p> +<div class="example"> +<pre class="example">calc_tickadj - Calculates "optimal" value for tick given ntp drift file. - Ver. 4.2.7p467 +USAGE: calc_tickadj [ -<flag> [<val>] | --<name>[{=| }<val>] ]... -d, --drift-file=str Ntp drift file to use -t, --tick=num Tick value of this host @@ -118,49 +159,64 @@ USAGE: calc_tickadj [ -<flag> [<val>] | --<name>[{=| }<val& Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -</pre> - <div class="node"> -<p><hr> -<a name="calc_005ftickadj-drift_002dfile"></a>Next: <a rel="next" accesskey="n" href="#calc_005ftickadj-tick">calc_tickadj tick</a>, -Previous: <a rel="previous" accesskey="p" href="#calc_005ftickadj-usage">calc_tickadj usage</a>, -Up: <a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a> -<br> +</pre></div> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-drift_002dfile" accesskey="1">calc_tickadj drift-file</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-tick" accesskey="2">calc_tickadj tick</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#calc_005ftickadj-exit-status" accesskey="3">calc_tickadj exit status</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> +<a name="calc_005ftickadj-drift_002dfile"></a> +<div class="header"> +<p> +Next: <a href="#calc_005ftickadj-tick" accesskey="n" rel="next">calc_tickadj tick</a>, Previous: <a href="#calc_005ftickadj-usage" accesskey="p" rel="prev">calc_tickadj usage</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p> </div> +<a name="drift_002dfile-option-_0028_002dd_0029"></a> +<h4 class="subsection">1.1.1 drift-file option (-d)</h4> +<a name="index-calc_005ftickadj_002ddrift_002dfile"></a> -<h4 class="subsection">drift-file option (-d)</h4> - -<p><a name="index-calc_005ftickadj_002ddrift_002dfile-4"></a> -This is the “ntp drift file to use” option. -This option takes a string argument. +<p>This is the “ntp drift file to use” option. +This option takes a string argument. Use the specified drift file for calculations -<div class="node"> -<p><hr> -<a name="calc_005ftickadj-tick"></a>Next: <a rel="next" accesskey="n" href="#calc_005ftickadj-exit-status">calc_tickadj exit status</a>, -Previous: <a rel="previous" accesskey="p" href="#calc_005ftickadj-drift_002dfile">calc_tickadj drift-file</a>, -Up: <a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a> -<br> +</p><hr> +<a name="calc_005ftickadj-tick"></a> +<div class="header"> +<p> +Next: <a href="#calc_005ftickadj-exit-status" accesskey="n" rel="next">calc_tickadj exit status</a>, Previous: <a href="#calc_005ftickadj-drift_002dfile" accesskey="p" rel="prev">calc_tickadj drift-file</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p> </div> +<a name="tick-option-_0028_002dt_0029"></a> +<h4 class="subsection">1.1.2 tick option (-t)</h4> +<a name="index-calc_005ftickadj_002dtick"></a> -<h4 class="subsection">tick option (-t)</h4> - -<p><a name="index-calc_005ftickadj_002dtick-5"></a> -This is the “tick value of this host” option. -This option takes a number argument. +<p>This is the “tick value of this host” option. +This option takes a number argument. The current tick which to adjustment will be calculated -<div class="node"> -<p><hr> -<a name="calc_005ftickadj-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#calc_005ftickadj-tick">calc_tickadj tick</a>, -Up: <a rel="up" accesskey="u" href="#calc_005ftickadj-Invocation">calc_tickadj Invocation</a> -<br> +</p><hr> +<a name="calc_005ftickadj-exit-status"></a> +<div class="header"> +<p> +Previous: <a href="#calc_005ftickadj-tick" accesskey="p" rel="prev">calc_tickadj tick</a>, Up: <a href="#calc_005ftickadj-usage" accesskey="u" rel="up">calc_tickadj usage</a> </p> </div> - -<h4 class="subsection">calc_tickadj exit status</h4> +<a name="calc_005ftickadj-exit-status-1"></a> +<h4 class="subsection">1.1.3 calc_tickadj exit status</h4> <p>One of the following exit values will be returned: - <dl> -<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. -<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. +</p><dl compact="compact"> +<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt> +<dd><p>Successful program execution. +</p></dd> +<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt> +<dd><p>The operation failed or the command syntax was not valid. +</p></dd> </dl> +<hr> + -</body></html> +</body> +</html> |