← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/ntp/gutsy

« back to all changes in this revision

Viewing changes to html/ntpdc.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-05-18 22:41:56 UTC
  • mfrom: (1.2.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070518224156-563ruqxsxvqvoy8h
Tags: 1:4.2.4p0+dfsg-1ubuntu1
* Merge from Debian unstable.
* Remaining Ubuntu changes:
  - Update version in conflicts/replaces to that which was shipped in edgy,
    which was later than that in Debian (due to the ubuntuX).
  - Change default server to ntp.ubuntu.com.
  - Remove stop links from rc0 and rc6
  - Call dh_installinit with --error-handler
  - Set Ubuntu maintainer address.

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/ntpdc.html
13
13
                <h3><tt>ntpdc</tt> - special NTP query program</h3>
14
14
                <img src="pic/alice31.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/~mills/pictures.html">from <i>Alice's Adventures in Wonderland</i>, Lewis Carroll</a>
15
15
                <p>This program is a big puppy.</p>
16
 
                <p>Last update: <csobj format="ShortTime" h="25" locale="00000409" region="0" t="DateTime" w="61">18:45</csobj> UTC <csobj format="LongDate" h="25" locale="00000409" region="0" t="DateTime" w="246">Thursday, July 28, 2005</csobj></p>
 
16
                <p>Last update: <csobj format="ShortTime" h="25" locale="00000409" region="0" t="DateTime" w="99">04:11 AM</csobj> UTC <csobj format="LongDate" h="25" locale="00000409" region="0" t="DateTime" w="294">Monday, November 27, 2006</csobj></p>
17
17
                <br clear="left">
18
18
                <h4>More Help</h4>
19
19
                <script type="text/javascript" language="javascript" src="scripts/links12.txt"></script>
62
62
                        <dt><tt>keyid <i>keyid</i></tt>
63
63
                        <dd>This command allows the specification of a
64
64
                key number to be used to authenticate configuration
65
 
                requests from ntpdc to the <NOBR>host(s).</NOBR> This must
 
65
                requests from ntpdc to the host(s). This must
66
66
                correspond to a key number which the host/server has
67
67
                been configured to use for this purpose (server
68
68
                options: <tt>trustedkey</tt>, and
69
69
                <tt>requestkey</tt>).  If authentication is not
70
 
                enabled on the <NOBR>host(s)</NOBR> for ntpdc
 
70
                enabled on the host(s) for ntpdc
71
71
                commands, the command
72
72
                <tt>"keyid 0"</tt> should be given; otherwise the
73
73
                <i>keyid</i> of the next subsequent <tt>addpeer/addserver/broadcast
77
77
                        <dd>Exit <tt>ntpdc</tt>.
78
78
                        <dt><tt>passwd</tt>
79
79
                        <dd>This command prompts you to type in a password (which will not be echoed) which will be used to authenticate configuration requests. The password must correspond to the key configured for use by the NTP server for this purpose if such requests are to be successful.
80
 
                        <dt><tt>timeout <i>millseconds</i></tt>
 
80
                        <dt><tt>timeout <i>milliseconds</i></tt>
81
81
                        <dd>Specify a timeout period for responses to server queries. The default is about 8000 milliseconds. Note that since <tt>ntpdc</tt> retries each query once after a timeout, the total waiting time for a timeout will be twice the timeout value set.
82
82
                </dl>
83
83
                <h4>Control Message Commands</h4>
104
104
                        <dt><tt>sysinfo</tt>
105
105
                        <dd>Print a variety of system state variables, i.e., state related to the local server. All except the last four lines are described in the NTP Version 3 specification, RFC-1305.
106
106
                                <p>The <tt>system flags</tt> show various system flags, some of which can be set and cleared by the <tt>enable</tt> and <tt>disable</tt> configuration commands, respectively. These are the <tt>auth</tt>, <tt>bclient</tt>, <tt>monitor</tt>, <tt>pll</tt>, <tt>pps</tt> and <tt>stats</tt> flags. See the <tt>ntpd</tt> documentation for the meaning of these flags. There are two additional flags which are read only, the <tt>kernel_pll</tt> and <tt>kernel_pps</tt>. These flags indicate the synchronization status when the precision time kernel modifications are in use. The <tt>kernel_pll</tt> indicates that the local clock is being disciplined by the kernel, while the kernel_pps indicates the kernel discipline is provided by the PPS signal.</p>
107
 
                                <p>The <tt>stability</tt> is the residual frequency error remaining afterthe system frequency correction is applied and is intended for maintenance and debugging. In most architectures, this value will initially decrease from as high as 500 ppm to a nominal value in the range .01 to 0.1 ppm. If it remains high for some time after starting the daemon, something may be wrong with the local clock, or the value of the kernel variable <tt>tick</tt> may be incorrect.</p>
 
107
                                <p>The <tt>stability</tt> is the residual frequency error remaining after the system frequency correction is applied and is intended for maintenance and debugging. In most architectures, this value will initially decrease from as high as 500 ppm to a nominal value in the range .01 to 0.1 ppm. If it remains high for some time after starting the daemon, something may be wrong with the local clock, or the value of the kernel variable <tt>tick</tt> may be incorrect.</p>
108
108
                                <p>The <tt>broadcastdelay</tt> shows the default broadcast delay, as set by the <tt>broadcastdelay</tt> configuration command.</p>
109
109
                                <p>The <tt>authdelay</tt> shows the default authentication delay, as set by the <tt>authdelay</tt> configuration command.</p>
110
110
                        <dt><tt>sysstats</tt>
117
117
                        <dd>Print statistics counters maintained in the timer/event queue support code.
118
118
                        <dt><tt>reslist</tt>
119
119
                        <dd>Obtain and print the server's restriction list. This list is (usually) printed in sorted order and may help to understand how the restrictions are applied.
 
120
                        <dt><tt>ifstats</tt>
 
121
                        <dd>List interface statistics for interfaces used by ntpd for network communication.</dd>
 
122
                        <dt><tt>ifreload</tt>
 
123
                        <dd>Force rescan of current system interfaces. Outputs interface statistics for interfaces that could possibly change. Marks unchanged interfaces with <b>.</b>, added interfaces with <b>+</b> and deleted interfaces with <b>-</b>.</dd>
120
124
                        <dt><tt>monlist [ <i>version</i> ]</tt>
121
125
                        <dd>Obtain and print traffic counts collected and maintained by the monitor facility. The version number should not normally need to be specified.
122
126
                        <dt><tt>clkbug <i>clock_peer_address</i> [...]</tt>
130
134
                <dt><tt>addpeer <i>peer_address</i> [
131
135
                <i>keyid</i> ] [ <i>version</i> ] [
132
136
                <tt>minpoll# | prefer | iburst  | burst | minpoll
133
 
                <i>N</i> | <tt>maxpoll</tt> <i>N</i> [...] ]</tt>
 
137
                <i>N</i> | <tt>maxpoll</tt> <i>N</i> [ <i>dynamic</i> ] [...] ]</tt>
134
138
                <dt><tt>addpeer <i>peer_address</i> [
135
139
                <tt>prefer | iburst | burst | minpoll
136
140
                <i>N</i> | <tt>maxpoll</tt> <i>N</i> | <tt>keyid</tt>
159
163
                        ntpd.  See the <a href="confopt.html">Server Options</a> page for further information.
160
164
                        Each flag (or its absence) replaces the
161
165
                        previous setting. The <tt>prefer</tt> keyword indicates a preferred peer (and thus will be used primarily for clock synchronisation if possible). The preferred peer also determines the validity of the PPS signal - if the preferred peer is suitable for synchronisation so is the PPS signal.
 
166
                        The <tt>dynamic</tt> keyword allows association configuration even when no suitable network interface is found at configuration time. The dynamic interface update mechanism may complete the configuration when new interfaces appear (e.g. WLAN/PPP interfaces) at a later time and thus render the association operable.
162
167
                        <dt><tt>addserver <i>peer_address</i> [
163
168
                <i>keyid</i> ] [ <i>version</i> ] [
164
169
                <tt>minpoll# | prefer | iburst  | burst | minpoll
166
171
                <dt><tt>addserver <i>peer_address</i> [
167
172
                <tt>prefer | iburst | burst | minpoll
168
173
                <i>N</i> | <tt>maxpoll</tt> <i>N</i> | <tt>keyid</tt>
169
 
                        <i>N</i> | <tt>version</tt> <i>N</i> [...] ]</tt>
170
 
 
 
174
                        <i>N</i> | <tt>version</tt> <i>N</i> [...] [ <i>dynamic</i> ] ]</tt>
171
175
                        <dd>Identical to the addpeer command, except that the operating mode is client.
172
176
                        <dt><tt>broadcast <i>peer_address</i> [
173
177
                        <i>keyid</i> ] [ <i>version</i> ] [ <i>prefer</i> ]</tt>