ntpq.html revision 1.1.1.1.6.1 1 1.1 christos <html lang="en">
2 1.1 christos <head>
3 1.1 christos <title>ntpq: Network Time Protocol Query User's Manual</title>
4 1.1 christos <meta http-equiv="Content-Type" content="text/html">
5 1.1 christos <meta name="description" content="ntpq: Network Time Protocol Query User's Manual">
6 1.1 christos <meta name="generator" content="makeinfo 4.7">
7 1.1 christos <link title="Top" rel="top" href="#Top">
8 1.1 christos <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9 1.1 christos <meta http-equiv="Content-Style-Type" content="text/css">
10 1.1 christos <style type="text/css"><!--
11 1.1 christos pre.display { font-family:inherit }
12 1.1 christos pre.format { font-family:inherit }
13 1.1 christos pre.smalldisplay { font-family:inherit; font-size:smaller }
14 1.1 christos pre.smallformat { font-family:inherit; font-size:smaller }
15 1.1 christos pre.smallexample { font-size:smaller }
16 1.1 christos pre.smalllisp { font-size:smaller }
17 1.1 christos span.sc { font-variant:small-caps }
18 1.1 christos span.roman { font-family: serif; font-weight: normal; }
19 1.1 christos --></style>
20 1.1 christos </head>
21 1.1 christos <body>
22 1.1 christos <h1 class="settitle">ntpq: Network Time Protocol Query User's Manual</h1>
23 1.1 christos <div class="shortcontents">
24 1.1 christos <h2>Short Contents</h2>
25 1.1 christos <ul>
26 1.1 christos <a href="#Top">ntpq: Network Time Protocol Query User Manual</a>
27 1.1 christos </ul>
28 1.1 christos </div>
29 1.1 christos
30 1.1 christos
31 1.1 christos
32 1.1 christos <div class="node">
33 1.1 christos <p><hr>
34 1.1 christos <a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntpq-Description">ntpq Description</a>,
35 1.1 christos Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
36 1.1 christos Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
37 1.1 christos <br>
38 1.1 christos </div>
39 1.1 christos
40 1.1 christos <h2 class="unnumbered">ntpq: Network Time Protocol Query User Manual</h2>
41 1.1 christos
42 1.1 christos <p>The <code>ntpq</code> utility program is used to
43 1.1 christos monitor the operational status
44 1.1 christos and determine the performance of
45 1.1 christos <code>ntpd</code>, the NTP daemon.
46 1.1 christos
47 1.1.1.1.6.1 riz <p>This document applies to version 4.2.8 of <code>ntpq</code>.
48 1.1 christos
49 1.1 christos <ul class="menu">
50 1.1 christos <li><a accesskey="1" href="#ntpq-Description">ntpq Description</a>
51 1.1 christos <li><a accesskey="2" href="#ntpq-Invocation">ntpq Invocation</a>: Invoking ntpq
52 1.1 christos <li><a accesskey="3" href="#Usage">Usage</a>
53 1.1 christos <li><a accesskey="4" href="#Internal-Commands">Internal Commands</a>
54 1.1 christos <li><a accesskey="5" href="#Control-Message-Commands">Control Message Commands</a>
55 1.1 christos <li><a accesskey="6" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>
56 1.1 christos <li><a accesskey="7" href="#System-Variables">System Variables</a>
57 1.1 christos <li><a accesskey="8" href="#Peer-Variables">Peer Variables</a>
58 1.1 christos <li><a accesskey="9" href="#Clock-Variables">Clock Variables</a>
59 1.1 christos </ul>
60 1.1 christos
61 1.1 christos <div class="node">
62 1.1 christos <p><hr>
63 1.1 christos <a name="ntpq-Description"></a>Next: <a rel="next" accesskey="n" href="#Usage">Usage</a>,
64 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
65 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
66 1.1 christos <br>
67 1.1 christos </div>
68 1.1 christos
69 1.1 christos <!-- node-name, next, previous, up -->
70 1.1 christos <h3 class="section">Description</h3>
71 1.1 christos
72 1.1 christos <p>The <code>ntpq</code> utility program is used to monitor NTP daemon <code>ntpd</code> operations and determine performance.
73 1.1 christos It uses the standard NTP mode 6 control message formats defined in
74 1.1 christos Appendix B of the NTPv3 specification RFC1305.
75 1.1 christos The same formats are used in NTPv4, although some of the variable names have changed and new ones added.
76 1.1 christos The description on this page is for the NTPv4 variables.
77 1.1 christos
78 1.1 christos <p>The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The <code>ntpq</code> can also obtain and print a list of peers in a common format by sending multiple queries to the server.
79 1.1 christos
80 1.1 christos <p>If one or more request options is included on the command line when <code>ntpq</code> is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, <code>ntpq</code> will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. <code>ntpq</code> will prompt for commands if the standard input is a terminal device.
81 1.1 christos
82 1.1 christos <p><code>ntpq</code> uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. <code>ntpq</code> makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.
83 1.1 christos
84 1.1 christos <p>Note that in contexts where a host name is expected, a <code>-4</code> qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a <code>-6</code> qualifier forces DNS resolution to the IPv6 namespace.
85 1.1 christos
86 1.1 christos <p>For examples and usage, see the <a href="debug.html">NTP Debugging Techniques</a> page.
87 1.1 christos
88 1.1 christos <div class="node">
89 1.1 christos <p><hr>
90 1.1 christos <a name="ntpq-Invocation"></a>
91 1.1 christos <br>
92 1.1 christos </div>
93 1.1 christos
94 1.1 christos <h3 class="section">Invoking ntpq</h3>
95 1.1 christos
96 1.1 christos <p><a name="index-ntpq-1"></a><a name="index-standard-NTP-query-program-2"></a>
97 1.1 christos
98 1.1 christos <p>The
99 1.1 christos <code>ntpq</code>
100 1.1 christos utility program is used to query NTP servers which
101 1.1 christos implement the standard NTP mode 6 control message formats defined
102 1.1 christos in Appendix B of the NTPv3 specification RFC1305, requesting
103 1.1 christos information about current state and/or changes in that state.
104 1.1 christos The same formats are used in NTPv4, although some of the
105 1.1 christos variables have changed and new ones added. The description on this
106 1.1 christos page is for the NTPv4 variables.
107 1.1 christos The program may be run either in interactive mode or controlled using
108 1.1 christos command line arguments.
109 1.1 christos Requests to read and write arbitrary
110 1.1 christos variables can be assembled, with raw and pretty-printed output
111 1.1 christos options being available.
112 1.1 christos The
113 1.1 christos <code>ntpq</code>
114 1.1 christos utility can also obtain and print a
115 1.1 christos list of peers in a common format by sending multiple queries to the
116 1.1 christos server.
117 1.1 christos
118 1.1 christos <p>If one or more request options is included on the command line
119 1.1 christos when
120 1.1 christos <code>ntpq</code>
121 1.1 christos is executed, each of the requests will be sent
122 1.1 christos to the NTP servers running on each of the hosts given as command
123 1.1 christos line arguments, or on localhost by default.
124 1.1 christos If no request options
125 1.1 christos are given,
126 1.1 christos <code>ntpq</code>
127 1.1 christos will attempt to read commands from the
128 1.1 christos standard input and execute these on the NTP server running on the
129 1.1 christos first host given on the command line, again defaulting to localhost
130 1.1 christos when no other host is specified.
131 1.1 christos The
132 1.1 christos <code>ntpq</code>
133 1.1 christos utility will prompt for
134 1.1 christos commands if the standard input is a terminal device.
135 1.1 christos
136 1.1 christos <p><code>ntpq</code>
137 1.1 christos uses NTP mode 6 packets to communicate with the
138 1.1 christos NTP server, and hence can be used to query any compatible server on
139 1.1 christos the network which permits it.
140 1.1 christos Note that since NTP is a UDP protocol
141 1.1 christos this communication will be somewhat unreliable, especially over
142 1.1 christos large distances in terms of network topology.
143 1.1 christos The
144 1.1 christos <code>ntpq</code>
145 1.1 christos utility makes
146 1.1 christos one attempt to retransmit requests, and will time requests out if
147 1.1 christos the remote host is not heard from within a suitable timeout
148 1.1 christos time.
149 1.1 christos
150 1.1 christos <p>Specifying a
151 1.1 christos command line option other than
152 1.1 christos <code>-i</code>
153 1.1 christos or
154 1.1 christos <code>-n</code>
155 1.1 christos will
156 1.1 christos cause the specified query (queries) to be sent to the indicated
157 1.1 christos host(s) immediately.
158 1.1 christos Otherwise,
159 1.1 christos <code>ntpq</code>
160 1.1 christos will attempt to read
161 1.1 christos interactive format commands from the standard input.
162 1.1 christos
163 1.1 christos <h5 class="subsubsection">Internal Commands</h5>
164 1.1 christos
165 1.1 christos <p>Interactive format commands consist of a keyword followed by zero
166 1.1 christos to four arguments.
167 1.1 christos Only enough characters of the full keyword to
168 1.1 christos uniquely identify the command need be typed.
169 1.1 christos
170 1.1 christos <p>A
171 1.1 christos number of interactive format commands are executed entirely within
172 1.1 christos the
173 1.1 christos <code>ntpq</code>
174 1.1 christos utility itself and do not result in NTP mode 6
175 1.1 christos requests being sent to a server.
176 1.1 christos These are described following.
177 1.1 christos <dl>
178 1.1 christos <dt><code>?</code> <code>[</code><kbd>command_keyword</kbd><code>]</code><br><dt><code>help</code> <code>[</code><kbd>command_keyword</kbd><code>]</code><dd>A
179 1.1 christos ?
180 1.1 christos by itself will print a list of all the command
181 1.1 christos keywords known to this incarnation of
182 1.1 christos <code>ntpq</code>
183 1.1 christos A
184 1.1 christos ?
185 1.1 christos followed by a command keyword will print function and usage
186 1.1 christos information about the command.
187 1.1 christos This command is probably a better
188 1.1 christos source of information about
189 1.1 christos <code>ntpq</code>
190 1.1 christos than this manual
191 1.1 christos page.
192 1.1.1.1.6.1 riz <br><dt><code>addvars</code> <kbd>variable_name</kbd><code>[=value]</code> <code>...</code><br><dt><code>rmvars</code> <kbd>variable_name</kbd> <code>...</code><br><dt><code>clearvars</code><br><dt><code>showvars</code><dd>The data carried by NTP mode 6 messages consists of a list of
193 1.1 christos items of the form
194 1.1 christos variable_name=value,
195 1.1 christos where the
196 1.1 christos =value
197 1.1 christos is ignored, and can be omitted,
198 1.1 christos in requests to the server to read variables.
199 1.1 christos The
200 1.1 christos <code>ntpq</code>
201 1.1 christos utility maintains an internal list in which data to be included in control
202 1.1 christos messages can be assembled, and sent using the
203 1.1 christos <code>readlist</code>
204 1.1 christos and
205 1.1 christos <code>writelist</code>
206 1.1 christos commands described below.
207 1.1 christos The
208 1.1 christos <code>addvars</code>
209 1.1 christos command allows variables and their optional values to be added to
210 1.1 christos the list.
211 1.1 christos If more than one variable is to be added, the list should
212 1.1 christos be comma-separated and not contain white space.
213 1.1 christos The
214 1.1 christos <code>rmvars</code>
215 1.1 christos command can be used to remove individual variables from the list,
216 1.1 christos while the
217 1.1 christos <code>clearlist</code>
218 1.1 christos command removes all variables from the
219 1.1 christos list.
220 1.1.1.1.6.1 riz The
221 1.1.1.1.6.1 riz <code>showvars</code>
222 1.1.1.1.6.1 riz command displays the current list of optional variables.
223 1.1 christos <br><dt><code>authenticate</code> <code>[yes | no]</code><dd>Normally
224 1.1 christos <code>ntpq</code>
225 1.1 christos does not authenticate requests unless
226 1.1 christos they are write requests.
227 1.1 christos The command
228 1.1 christos authenticate yes
229 1.1 christos causes
230 1.1 christos <code>ntpq</code>
231 1.1 christos to send authentication with all requests it
232 1.1 christos makes.
233 1.1 christos Authenticated requests causes some servers to handle
234 1.1 christos requests slightly differently, and can occasionally melt the CPU in
235 1.1 christos fuzzballs if you turn authentication on before doing a
236 1.1 christos <code>peer</code>
237 1.1 christos display.
238 1.1 christos The command
239 1.1 christos authenticate
240 1.1 christos causes
241 1.1 christos <code>ntpq</code>
242 1.1 christos to display whether or not
243 1.1 christos <code>ntpq</code>
244 1.1 christos is currently autheinticating requests.
245 1.1 christos <br><dt><code>cooked</code><dd>Causes output from query commands to be "cooked", so that
246 1.1 christos variables which are recognized by
247 1.1 christos <code>ntpq</code>
248 1.1 christos will have their
249 1.1 christos values reformatted for human consumption.
250 1.1 christos Variables which
251 1.1 christos <code>ntpq</code>
252 1.1 christos thinks should have a decodable value but didn't are
253 1.1 christos marked with a trailing
254 1.1 christos ?.
255 1.1 christos <br><dt><code>debug</code> <code>[more | less | off]</code><dd>With no argument, displays the current debug level.
256 1.1 christos Otherwise, the debug level is changed to the indicated level.
257 1.1 christos <br><dt><code>delay</code> <kbd>milliseconds</kbd><dd>Specify a time interval to be added to timestamps included in
258 1.1 christos requests which require authentication.
259 1.1 christos This is used to enable
260 1.1 christos (unreliable) server reconfiguration over long delay network paths
261 1.1 christos or between machines whose clocks are unsynchronized.
262 1.1 christos Actually the
263 1.1 christos server does not now require timestamps in authenticated requests,
264 1.1 christos so this command may be obsolete.
265 1.1.1.1.6.1 riz <br><dt><code>exit</code><dd>Exit
266 1.1.1.1.6.1 riz <code>ntpq</code>
267 1.1 christos <br><dt><code>host</code> <kbd>hostname</kbd><dd>Set the host to which future queries will be sent.
268 1.1 christos <kbd>hostname</kbd>
269 1.1 christos may be either a host name or a numeric address.
270 1.1 christos <br><dt><code>hostnames</code> <code>[yes | no]</code><dd>If
271 1.1 christos <code>yes</code>
272 1.1 christos is specified, host names are printed in
273 1.1 christos information displays.
274 1.1 christos If
275 1.1 christos <code>no</code>
276 1.1 christos is specified, numeric
277 1.1 christos addresses are printed instead.
278 1.1 christos The default is
279 1.1 christos <code>yes</code>,
280 1.1 christos unless
281 1.1 christos modified using the command line
282 1.1 christos <code>-n</code>
283 1.1 christos switch.
284 1.1 christos <br><dt><code>keyid</code> <kbd>keyid</kbd><dd>This command allows the specification of a key number to be
285 1.1 christos used to authenticate configuration requests.
286 1.1 christos This must correspond
287 1.1 christos to a key number the server has been configured to use for this
288 1.1 christos purpose.
289 1.1.1.1.6.1 riz <br><dt><code>keytype</code> <code>[md5 | OpenSSLDigestType]</code><dd>Specify the type of key to use for authenticating requests.
290 1.1.1.1.6.1 riz <code>md5</code>
291 1.1.1.1.6.1 riz is alway supported.
292 1.1.1.1.6.1 riz If
293 1.1.1.1.6.1 riz <code>ntpq</code>
294 1.1.1.1.6.1 riz was built with OpenSSL support,
295 1.1.1.1.6.1 riz any digest type supported by OpenSSL can also be provided.
296 1.1.1.1.6.1 riz If no argument is given, the current
297 1.1.1.1.6.1 riz <code>keytype</code>
298 1.1.1.1.6.1 riz is displayed.
299 1.1 christos <br><dt><code>ntpversion</code> <code>[1 | 2 | 3 | 4]</code><dd>Sets the NTP version number which
300 1.1 christos <code>ntpq</code>
301 1.1 christos claims in
302 1.1 christos packets.
303 1.1 christos Defaults to 3, and note that mode 6 control messages (and
304 1.1 christos modes, for that matter) didn't exist in NTP version 1.
305 1.1 christos There appear
306 1.1 christos to be no servers left which demand version 1.
307 1.1 christos With no argument, displays the current NTP version that will be used
308 1.1 christos when communicating with servers.
309 1.1 christos <br><dt><code>passwd</code><dd>This command prompts you to type in a password (which will not
310 1.1 christos be echoed) which will be used to authenticate configuration
311 1.1 christos requests.
312 1.1 christos The password must correspond to the key configured for
313 1.1 christos use by the NTP server for this purpose if such requests are to be
314 1.1 christos successful.
315 1.1.1.1.6.1 riz <code>poll</code>
316 1.1.1.1.6.1 riz <kbd>n</kbd>
317 1.1.1.1.6.1 riz <code>verbose</code>
318 1.1.1.1.6.1 riz <br><dt><code>quit</code><dd>Exit
319 1.1.1.1.6.1 riz <code>ntpq</code>
320 1.1 christos <br><dt><code>raw</code><dd>Causes all output from query commands is printed as received
321 1.1 christos from the remote server.
322 1.1 christos The only formating/interpretation done on
323 1.1 christos the data is to transform nonascii data into a printable (but barely
324 1.1 christos understandable) form.
325 1.1 christos <br><dt><code>timeout</code> <kbd>milliseconds</kbd><dd>Specify a timeout period for responses to server queries.
326 1.1 christos The
327 1.1 christos default is about 5000 milliseconds.
328 1.1 christos Note that since
329 1.1 christos <code>ntpq</code>
330 1.1 christos retries each query once after a timeout, the total waiting time for
331 1.1 christos a timeout will be twice the timeout value set.
332 1.1.1.1.6.1 riz <br><dt><code>version</code><dd>Print the version of the
333 1.1.1.1.6.1 riz <code>ntpq</code>
334 1.1.1.1.6.1 riz program.
335 1.1.1.1.6.1 riz </dl>
336 1.1.1.1.6.1 riz
337 1.1.1.1.6.1 riz <h5 class="subsubsection">Control Message Commands</h5>
338 1.1.1.1.6.1 riz
339 1.1.1.1.6.1 riz <p>Association IDs are used to identify system, peer and clock variables.
340 1.1.1.1.6.1 riz System variables are assigned an association ID of zero and system name space, while each association is assigned a nonzero association ID and peer namespace.
341 1.1.1.1.6.1 riz Most control commands send a single mode-6 message to the server and expect a single response message.
342 1.1.1.1.6.1 riz The exceptions are the
343 1.1.1.1.6.1 riz <code>peers</code>
344 1.1.1.1.6.1 riz command, which sends a series of messages,
345 1.1.1.1.6.1 riz and the
346 1.1.1.1.6.1 riz <code>mreadlist</code>
347 1.1.1.1.6.1 riz and
348 1.1.1.1.6.1 riz <code>mreadvar</code>
349 1.1.1.1.6.1 riz commands, which iterate over a range of associations.
350 1.1.1.1.6.1 riz <dl>
351 1.1.1.1.6.1 riz <dt><code>associations</code><dd>Display a list of mobilized associations in the form:
352 1.1.1.1.6.1 riz <pre class="example"> ind assid status conf reach auth condition last_event cnt
353 1.1.1.1.6.1 riz </pre>
354 1.1.1.1.6.1 riz <dl>
355 1.1.1.1.6.1 riz <dt>Sy String Ta Sy Description<br><dt><code>ind</code> <code>Ta</code> <code>index</code> <code>on</code> <code>this</code> <code>list</code><br><dt><code>assid</code> <code>Ta</code> <code>association</code> <code>ID</code><br><dt><code>status</code> <code>Ta</code> <code>peer</code> <code>status</code> <code>word</code><br><dt><code>conf</code> <code>Ta</code> <code>yes</code>: <code>persistent,</code> <code>no</code>: <code>ephemeral</code><br><dt><code>reach</code> <code>Ta</code> <code>yes</code>: <code>reachable,</code> <code>no</code>: <code>unreachable</code><br><dt><code>auth</code> <code>Ta</code> <code>ok</code>, <code>yes</code>, <code>bad</code> <code>and</code> <code>none</code><br><dt><code>condition</code> <code>Ta</code> <code>selection</code> <code>status</code> <code>(see</code> <code>the</code> <code>select</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>last_event</code> <code>Ta</code> <code>event</code> <code>report</code> <code>(see</code> <code>the</code> <code>event</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><br><dt><code>cnt</code> <code>Ta</code> <code>event</code> <code>count</code> <code>(see</code> <code>the</code> <code>count</code> <code>field</code> <code>of</code> <code>the</code> <code>peer</code> <code>status</code> <code>word)</code><dd></dl>
356 1.1.1.1.6.1 riz <br><dt><code>authinfo</code><dd>Display the authentication statistics.
357 1.1.1.1.6.1 riz <br><dt><code>clockvar</code> <kbd>assocID</kbd> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code> <code>[...]</code><br><dt><code>cv</code> <kbd>assocID</kbd> <code>[</code><kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]]</code> <code>[...]</code><dd>Display a list of clock variables for those associations supporting a reference clock.
358 1.1.1.1.6.1 riz <br><dt><code>:config</code> <code>[...]</code><dd>Send the remainder of the command line, including whitespace, to the server as a run-time configuration command in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is of course required.
359 1.1.1.1.6.1 riz <br><dt><code>config-from-file</code> <kbd>filename</kbd><dd>Send the each line of
360 1.1.1.1.6.1 riz <kbd>filename</kbd>
361 1.1.1.1.6.1 riz to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
362 1.1.1.1.6.1 riz <br><dt><code>ifstats</code><dd>Display statistics for each local network address. Authentication is required.
363 1.1.1.1.6.1 riz <br><dt><code>iostats</code><dd>Display network and reference clock I/O statistics.
364 1.1.1.1.6.1 riz <br><dt><code>kerninfo</code><dd>Display kernel loop and PPS statistics. As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable.
365 1.1.1.1.6.1 riz <br><dt><code>lassociations</code><dd>Perform the same function as the associations command, except display mobilized and unmobilized associations.
366 1.1.1.1.6.1 riz <br><dt><code>lopeers</code> <code>[-4 | -6]</code><dd>Obtain and print a list of all peers and clients showing
367 1.1.1.1.6.1 riz <kbd>dstadr</kbd>
368 1.1.1.1.6.1 riz (associated with any given IP version).
369 1.1.1.1.6.1 riz <br><dt><code>lpeers</code> <code>[-4 | -6]</code><dd>Print a peer spreadsheet for the appropriate IP version(s).
370 1.1.1.1.6.1 riz <kbd>dstadr</kbd>
371 1.1.1.1.6.1 riz (associated with any given IP version).
372 1.1.1.1.6.1 riz <br><dt><code>monstats</code><dd>Display monitor facility statistics.
373 1.1.1.1.6.1 riz <br><dt><code>mrulist</code> <code>[limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Obtain and print traffic counts collected and maintained by the monitor facility.
374 1.1.1.1.6.1 riz With the exception of
375 1.1.1.1.6.1 riz <code>sort</code>=<kbd>sortorder</kbd>,
376 1.1.1.1.6.1 riz the options filter the list returned by
377 1.1.1.1.6.1 riz <code>ntpd.</code>
378 1.1.1.1.6.1 riz The
379 1.1.1.1.6.1 riz <code>limited</code>
380 1.1.1.1.6.1 riz and
381 1.1.1.1.6.1 riz <code>kod</code>
382 1.1.1.1.6.1 riz options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
383 1.1.1.1.6.1 riz The
384 1.1.1.1.6.1 riz <code>mincount</code>=<kbd>count</kbd>
385 1.1.1.1.6.1 riz option filters entries representing less than
386 1.1.1.1.6.1 riz <kbd>count</kbd>
387 1.1.1.1.6.1 riz packets.
388 1.1.1.1.6.1 riz The
389 1.1.1.1.6.1 riz <code>laddr</code>=<kbd>localaddr</kbd>
390 1.1.1.1.6.1 riz option filters entries for packets received on any local address other than
391 1.1.1.1.6.1 riz <kbd>localaddr</kbd>.
392 1.1.1.1.6.1 riz <code>resany</code>=<kbd>hexmask</kbd>
393 1.1.1.1.6.1 riz and
394 1.1.1.1.6.1 riz <code>resall</code>=<kbd>hexmask</kbd>
395 1.1.1.1.6.1 riz filter entries containing none or less than all, respectively, of the bits in
396 1.1.1.1.6.1 riz <kbd>hexmask</kbd>,
397 1.1.1.1.6.1 riz which must begin with
398 1.1.1.1.6.1 riz <code>0x</code>.
399 1.1.1.1.6.1 riz The
400 1.1.1.1.6.1 riz <kbd>sortorder</kbd>
401 1.1.1.1.6.1 riz defaults to
402 1.1.1.1.6.1 riz <code>lstint</code>
403 1.1.1.1.6.1 riz and may be any of
404 1.1.1.1.6.1 riz <code>addr</code>,
405 1.1.1.1.6.1 riz <code>count</code>,
406 1.1.1.1.6.1 riz <code>avgint</code>,
407 1.1.1.1.6.1 riz <code>lstint</code>,
408 1.1.1.1.6.1 riz or any of those preceded by a minus sign (hyphen) to reverse the sort order.
409 1.1.1.1.6.1 riz The output columns are:
410 1.1.1.1.6.1 riz <dl>
411 1.1.1.1.6.1 riz <dt>Column<dd>Description
412 1.1.1.1.6.1 riz <br><dt><code>lstint</code><dd>Interval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by
413 1.1.1.1.6.1 riz <code>ntpq</code>
414 1.1.1.1.6.1 riz <br><dt><code>avgint</code><dd>Average interval in s between packets from this address.
415 1.1.1.1.6.1 riz <br><dt><code>rstr</code><dd>Restriction flags associated with this address.
416 1.1.1.1.6.1 riz Most are copied unchanged from the matching
417 1.1.1.1.6.1 riz <code>restrict</code>
418 1.1.1.1.6.1 riz command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
419 1.1.1.1.6.1 riz <br><dt><code>r</code><dd>Rate control indicator, either
420 1.1.1.1.6.1 riz a period,
421 1.1.1.1.6.1 riz <code>L</code>
422 1.1.1.1.6.1 riz or
423 1.1.1.1.6.1 riz <code>K</code>
424 1.1.1.1.6.1 riz for no rate control response,
425 1.1.1.1.6.1 riz rate limiting by discarding, or rate limiting with a KoD response, respectively.
426 1.1.1.1.6.1 riz <br><dt><code>m</code><dd>Packet mode.
427 1.1.1.1.6.1 riz <br><dt><code>v</code><dd>Packet version number.
428 1.1.1.1.6.1 riz <br><dt><code>count</code><dd>Packets received from this address.
429 1.1.1.1.6.1 riz <br><dt><code>rport</code><dd>Source port of last packet from this address.
430 1.1.1.1.6.1 riz <br><dt><code>remote</code> <code>address</code><dd>DNS name, numeric address, or address followed by
431 1.1.1.1.6.1 riz claimed DNS name which could not be verified in parentheses.
432 1.1.1.1.6.1 riz </dl>
433 1.1.1.1.6.1 riz <br><dt><code>mreadvar</code> <code>assocID</code> <code>assocID</code> <code>[</code><kbd>variable_name</kbd><code>[=</code><kbd>value</kbd><code>] ...]</code><br><dt><code>mrv</code> <code>assocID</code> <code>assocID</code> <code>[</code><kbd>variable_name</kbd><code>[=</code><kbd>value</kbd><code>] ...]</code><dd>Perform the same function as the
434 1.1.1.1.6.1 riz <code>readvar</code>
435 1.1.1.1.6.1 riz command, except for a range of association IDs.
436 1.1.1.1.6.1 riz This range is determined from the association list cached by the most recent
437 1.1.1.1.6.1 riz <code>associations</code>
438 1.1.1.1.6.1 riz command.
439 1.1.1.1.6.1 riz <br><dt><code>opeers</code> <code>[-4 | -6]</code><dd>Obtain and print the old-style list of all peers and clients showing
440 1.1.1.1.6.1 riz <kbd>dstadr</kbd>
441 1.1.1.1.6.1 riz (associated with any given IP version),
442 1.1.1.1.6.1 riz rather than the
443 1.1.1.1.6.1 riz <kbd>refid</kbd>.
444 1.1.1.1.6.1 riz <br><dt><code>passociations</code><dd>Perform the same function as the
445 1.1.1.1.6.1 riz <code>associations</code>
446 1.1.1.1.6.1 riz command,
447 1.1.1.1.6.1 riz except that it uses previously stored data rather than making a new query.
448 1.1.1.1.6.1 riz <br><dt><code>peers</code><dd>Display a list of peers in the form:
449 1.1.1.1.6.1 riz <pre class="example"> [tally]remote refid st t when pool reach delay offset jitter
450 1.1.1.1.6.1 riz </pre>
451 1.1.1.1.6.1 riz <dl>
452 1.1.1.1.6.1 riz <dt>Variable<dd>Description
453 1.1.1.1.6.1 riz <br><dt><code>[tally]</code><dd>single-character code indicating current value of the
454 1.1.1.1.6.1 riz <code>select</code>
455 1.1.1.1.6.1 riz field of the
456 1.1.1.1.6.1 riz .Lk decode.html#peer "peer status word"
457 1.1.1.1.6.1 riz <br><dt><code>remote</code><dd>host name (or IP number) of peer.
458 1.1.1.1.6.1 riz The value displayed will be truncated to 15 characters unless the
459 1.1.1.1.6.1 riz <code>-w</code>
460 1.1.1.1.6.1 riz flag is given, in which case the full value will be displayed
461 1.1.1.1.6.1 riz on the first line,
462 1.1.1.1.6.1 riz and the remaining data is displayed on the next line.
463 1.1.1.1.6.1 riz <br><dt><code>refid</code><dd>association ID or
464 1.1.1.1.6.1 riz .Lk decode.html#kiss "'kiss code"
465 1.1.1.1.6.1 riz <br><dt><code>st</code><dd>stratum
466 1.1.1.1.6.1 riz <br><dt><code>t</code><dd><code>u</code>:
467 1.1.1.1.6.1 riz unicast or manycast client,
468 1.1.1.1.6.1 riz <code>b</code>:
469 1.1.1.1.6.1 riz broadcast or multicast client,
470 1.1.1.1.6.1 riz <code>l</code>:
471 1.1.1.1.6.1 riz local (reference clock),
472 1.1.1.1.6.1 riz <code>s</code>:
473 1.1.1.1.6.1 riz symmetric (peer),
474 1.1.1.1.6.1 riz <code>A</code>:
475 1.1.1.1.6.1 riz manycast server,
476 1.1.1.1.6.1 riz <code>B</code>:
477 1.1.1.1.6.1 riz broadcast server,
478 1.1.1.1.6.1 riz <code>M</code>:
479 1.1.1.1.6.1 riz multicast server
480 1.1.1.1.6.1 riz <br><dt><code>when</code><dd>sec/min/hr since last received packet
481 1.1.1.1.6.1 riz <br><dt><code>poll</code><dd>poll interval (log2 s)
482 1.1.1.1.6.1 riz <br><dt><code>reach</code><dd>reach shift register (octal)
483 1.1.1.1.6.1 riz <br><dt><code>delay</code><dd>roundtrip delay
484 1.1.1.1.6.1 riz <br><dt><code>offset</code><dd>offset of server relative to this host
485 1.1.1.1.6.1 riz <br><dt><code>jitter</code><dd>jitter
486 1.1.1.1.6.1 riz </dl>
487 1.1.1.1.6.1 riz <br><dt><code>pstats</code> <kbd>assocID</kbd><dd>Show the statistics for the peer with the given
488 1.1.1.1.6.1 riz <kbd>assocID</kbd>.
489 1.1.1.1.6.1 riz <br><dt><code>readlist</code> <kbd>assocID</kbd><br><dt><code>rl</code> <kbd>assocID</kbd><dd>Read the system or peer variables included in the variable list.
490 1.1.1.1.6.1 riz <br><dt><code>readvar</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code> <code>[, ...]</code><br><dt><code>rv</code> <kbd>assocID</kbd> <kbd>name</kbd><code>[=</code><kbd>value</kbd><code>]</code> <code>[, ...]</code><dd>Display the specified variables.
491 1.1.1.1.6.1 riz If
492 1.1.1.1.6.1 riz <kbd>assocID</kbd>
493 1.1.1.1.6.1 riz is zero, the variables are from the
494 1.1.1.1.6.1 riz <a href="#System-Variables">System Variables</a>
495 1.1.1.1.6.1 riz name space, otherwise they are from the
496 1.1.1.1.6.1 riz <a href="#Peer-Variables">Peer Variables</a>
497 1.1.1.1.6.1 riz name space.
498 1.1.1.1.6.1 riz The
499 1.1.1.1.6.1 riz <kbd>assocID</kbd>
500 1.1.1.1.6.1 riz is required, as the same name can occur in both spaces.
501 1.1.1.1.6.1 riz If no
502 1.1.1.1.6.1 riz <kbd>name</kbd>
503 1.1.1.1.6.1 riz is included, all operative variables in the name space are displayed.
504 1.1.1.1.6.1 riz
505 1.1.1.1.6.1 riz <p>In this case only, if the
506 1.1.1.1.6.1 riz <kbd>assocID</kbd>
507 1.1.1.1.6.1 riz is omitted, it is assumed zero.
508 1.1.1.1.6.1 riz Multiple names are specified with comma separators and without whitespace.
509 1.1.1.1.6.1 riz Note that time values are represented in milliseconds
510 1.1.1.1.6.1 riz and frequency values in parts-per-million (PPM).
511 1.1.1.1.6.1 riz Some NTP timestamps are represented in the format
512 1.1.1.1.6.1 riz YYYYMMDDTTTT ,
513 1.1.1.1.6.1 riz where YYYY is the year,
514 1.1.1.1.6.1 riz MM the month of year,
515 1.1.1.1.6.1 riz DD the day of month and
516 1.1.1.1.6.1 riz TTTT the time of day.
517 1.1.1.1.6.1 riz <br><dt><code>reslist</code><dd>Show the access control (restrict) list for
518 1.1.1.1.6.1 riz <code>ntpq</code>
519 1.1.1.1.6.1 riz
520 1.1.1.1.6.1 riz <br><dt><code>saveconfig</code> <kbd>filename</kbd><dd>Write the current configuration,
521 1.1.1.1.6.1 riz including any runtime modifications given with
522 1.1.1.1.6.1 riz <code>:config</code>
523 1.1.1.1.6.1 riz or
524 1.1.1.1.6.1 riz <code>config-from-file</code>,
525 1.1.1.1.6.1 riz to the ntpd host's file
526 1.1.1.1.6.1 riz <kbd>filename</kbd>.
527 1.1.1.1.6.1 riz This command will be rejected by the server unless
528 1.1.1.1.6.1 riz .Lk miscopt.html#saveconfigdir "saveconfigdir"
529 1.1.1.1.6.1 riz appears in the
530 1.1.1.1.6.1 riz <code>ntpd</code>
531 1.1.1.1.6.1 riz configuration file.
532 1.1.1.1.6.1 riz <kbd>filename</kbd>
533 1.1.1.1.6.1 riz can use
534 1.1.1.1.6.1 riz <code>strftime()</code>
535 1.1.1.1.6.1 riz format specifies to substitute the current date and time, for example,
536 1.1.1.1.6.1 riz <code>q]saveconfig</code> <code>ntp-%Y%m%d-%H%M%S.confq]</code>.
537 1.1.1.1.6.1 riz The filename used is stored in system variable
538 1.1.1.1.6.1 riz <code>savedconfig</code>.
539 1.1.1.1.6.1 riz Authentication is required.
540 1.1.1.1.6.1 riz <br><dt><code>timerstats</code><dd>Display interval timer counters.
541 1.1.1.1.6.1 riz <br><dt><code>writelist</code> <kbd>assocID</kbd><dd>Write the system or peer variables included in the variable list.
542 1.1.1.1.6.1 riz <br><dt><code>writevar</code> <kbd>assocID</kbd> <kbd>name</kbd>=<kbd>value</kbd> <code>[, ...]</code><dd>Write the specified variables.
543 1.1.1.1.6.1 riz If the
544 1.1.1.1.6.1 riz <kbd>assocID</kbd>
545 1.1.1.1.6.1 riz is zero, the variables are from the
546 1.1.1.1.6.1 riz <a href="#System-Variables">System Variables</a>
547 1.1.1.1.6.1 riz name space, otherwise they are from the
548 1.1.1.1.6.1 riz <a href="#Peer-Variables">Peer Variables</a>
549 1.1.1.1.6.1 riz name space.
550 1.1.1.1.6.1 riz The
551 1.1.1.1.6.1 riz <kbd>assocID</kbd>
552 1.1.1.1.6.1 riz is required, as the same name can occur in both spaces.
553 1.1.1.1.6.1 riz <br><dt><code>sysinfo</code><dd>Display operational summary.
554 1.1.1.1.6.1 riz <br><dt><code>sysstats</code><dd>Print statistics counters maintained in the protocol module.
555 1.1.1.1.6.1 riz </dl>
556 1.1.1.1.6.1 riz
557 1.1.1.1.6.1 riz <h5 class="subsubsection">Status Words and Kiss Codes</h5>
558 1.1.1.1.6.1 riz
559 1.1.1.1.6.1 riz <p>The current state of the operating program is shown
560 1.1.1.1.6.1 riz in a set of status words
561 1.1.1.1.6.1 riz maintained by the system.
562 1.1.1.1.6.1 riz Status information is also available on a per-association basis.
563 1.1.1.1.6.1 riz These words are displayed in the
564 1.1.1.1.6.1 riz <code>rv</code>
565 1.1.1.1.6.1 riz and
566 1.1.1.1.6.1 riz <code>as</code>
567 1.1.1.1.6.1 riz commands both in hexadecimal and in decoded short tip strings.
568 1.1.1.1.6.1 riz The codes, tips and short explanations are documented on the
569 1.1.1.1.6.1 riz .Lk decode.html "Event Messages and Status Words"
570 1.1.1.1.6.1 riz page.
571 1.1.1.1.6.1 riz The page also includes a list of system and peer messages,
572 1.1.1.1.6.1 riz the code for the latest of which is included in the status word.
573 1.1.1.1.6.1 riz
574 1.1.1.1.6.1 riz <p>Information resulting from protocol machine state transitions
575 1.1.1.1.6.1 riz is displayed using an informal set of ASCII strings called
576 1.1.1.1.6.1 riz .Lk decode.html#kiss "kiss codes" .
577 1.1.1.1.6.1 riz The original purpose was for kiss-o'-death (KoD) packets
578 1.1.1.1.6.1 riz sent by the server to advise the client of an unusual condition.
579 1.1.1.1.6.1 riz They are now displayed, when appropriate,
580 1.1.1.1.6.1 riz in the reference identifier field in various billboards.
581 1.1.1.1.6.1 riz
582 1.1.1.1.6.1 riz <h5 class="subsubsection">System Variables</h5>
583 1.1.1.1.6.1 riz
584 1.1.1.1.6.1 riz <p>The following system variables appear in the
585 1.1.1.1.6.1 riz <code>rv</code>
586 1.1.1.1.6.1 riz billboard.
587 1.1.1.1.6.1 riz Not all variables are displayed in some configurations.
588 1.1.1.1.6.1 riz <dl>
589 1.1.1.1.6.1 riz <dt>Variable<dd>Description
590 1.1.1.1.6.1 riz <br><dt><code>status</code><dd>.Lk decode.html#sys "system status word"
591 1.1.1.1.6.1 riz <br><dt><code>version</code><dd>NTP software version and build time
592 1.1.1.1.6.1 riz <br><dt><code>processor</code><dd>hardware platform and version
593 1.1.1.1.6.1 riz <br><dt><code>system</code><dd>operating system and version
594 1.1.1.1.6.1 riz <br><dt><code>leap</code><dd>leap warning indicator (0-3)
595 1.1.1.1.6.1 riz <br><dt><code>stratum</code><dd>stratum (1-15)
596 1.1.1.1.6.1 riz <br><dt><code>precision</code><dd>precision (log2 s)
597 1.1.1.1.6.1 riz <br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock
598 1.1.1.1.6.1 riz <br><dt><code>rootdisp</code><dd>total dispersion to the primary reference clock
599 1.1.1.1.6.1 riz <br><dt><code>peer</code><dd>system peer association ID
600 1.1.1.1.6.1 riz <br><dt><code>tc</code><dd>time constant and poll exponent (log2 s) (3-17)
601 1.1.1.1.6.1 riz <br><dt><code>mintc</code><dd>minimum time constant (log2 s) (3-10)
602 1.1.1.1.6.1 riz <br><dt><code>clock</code><dd>date and time of day
603 1.1.1.1.6.1 riz <br><dt><code>refid</code><dd>reference ID or
604 1.1.1.1.6.1 riz .Lk decode.html#kiss "kiss code"
605 1.1.1.1.6.1 riz <br><dt><code>reftime</code><dd>reference time
606 1.1.1.1.6.1 riz <br><dt><code>offset</code><dd>combined offset of server relative to this host
607 1.1.1.1.6.1 riz <br><dt><code>sys_jitter</code><dd>combined system jitter
608 1.1.1.1.6.1 riz <br><dt><code>frequency</code><dd>frequency offset (PPM) relative to hardware clock
609 1.1.1.1.6.1 riz <br><dt><code>clk_wander</code><dd>clock frequency wander (PPM)
610 1.1.1.1.6.1 riz <br><dt><code>clk_jitter</code><dd>clock jitter
611 1.1.1.1.6.1 riz <br><dt><code>tai</code><dd>TAI-UTC offset (s)
612 1.1.1.1.6.1 riz <br><dt><code>leapsec</code><dd>NTP seconds when the next leap second is/was inserted
613 1.1.1.1.6.1 riz <br><dt><code>expire</code><dd>NTP seconds when the NIST leapseconds file expires
614 1.1.1.1.6.1 riz </dl>
615 1.1.1.1.6.1 riz The jitter and wander statistics are exponentially-weighted RMS averages.
616 1.1.1.1.6.1 riz The system jitter is defined in the NTPv4 specification;
617 1.1.1.1.6.1 riz the clock jitter statistic is computed by the clock discipline module.
618 1.1.1.1.6.1 riz
619 1.1.1.1.6.1 riz <p>When the NTPv4 daemon is compiled with the OpenSSL software library,
620 1.1.1.1.6.1 riz additional system variables are displayed,
621 1.1.1.1.6.1 riz including some or all of the following,
622 1.1.1.1.6.1 riz depending on the particular Autokey dance:
623 1.1.1.1.6.1 riz
624 1.1.1.1.6.1 riz <dl>
625 1.1.1.1.6.1 riz <dt>Variable<dd>Description
626 1.1.1.1.6.1 riz <br><dt><code>host</code><dd>Autokey host name for this host
627 1.1.1.1.6.1 riz <br><dt><code>ident</code><dd>Autokey group name for this host
628 1.1.1.1.6.1 riz <br><dt><code>flags</code><dd>host flags (see Autokey specification)
629 1.1.1.1.6.1 riz <br><dt><code>digest</code><dd>OpenSSL message digest algorithm
630 1.1.1.1.6.1 riz <br><dt><code>signature</code><dd>OpenSSL digest/signature scheme
631 1.1.1.1.6.1 riz <br><dt><code>update</code><dd>NTP seconds at last signature update
632 1.1.1.1.6.1 riz <br><dt><code>cert</code><dd>certificate subject, issuer and certificate flags
633 1.1.1.1.6.1 riz <br><dt><code>until</code><dd>NTP seconds when the certificate expires
634 1.1.1.1.6.1 riz </dl>
635 1.1.1.1.6.1 riz
636 1.1.1.1.6.1 riz <h5 class="subsubsection">Peer Variables</h5>
637 1.1.1.1.6.1 riz
638 1.1.1.1.6.1 riz <p>The following peer variables appear in the
639 1.1.1.1.6.1 riz <code>rv</code>
640 1.1.1.1.6.1 riz billboard for each association.
641 1.1.1.1.6.1 riz Not all variables are displayed in some configurations.
642 1.1.1.1.6.1 riz
643 1.1.1.1.6.1 riz <dl>
644 1.1.1.1.6.1 riz <dt>Variable<dd>Description
645 1.1.1.1.6.1 riz <br><dt><code>associd</code><dd>association ID
646 1.1.1.1.6.1 riz <br><dt><code>status</code><dd>.Lk decode.html#peer "peer status word"
647 1.1.1.1.6.1 riz <br><dt><code>srcadr</code><dd>source (remote) IP address
648 1.1.1.1.6.1 riz <br><dt><code>srcport</code><dd>source (remote) port
649 1.1.1.1.6.1 riz <br><dt><code>dstadr</code><dd>destination (local) IP address
650 1.1.1.1.6.1 riz <br><dt><code>dstport</code><dd>destination (local) port
651 1.1.1.1.6.1 riz <br><dt><code>leap</code><dd>leap indicator (0-3)
652 1.1.1.1.6.1 riz <br><dt><code>stratum</code><dd>stratum (0-15)
653 1.1.1.1.6.1 riz <br><dt><code>precision</code><dd>precision (log2 s)
654 1.1.1.1.6.1 riz <br><dt><code>rootdelay</code><dd>total roundtrip delay to the primary reference clock
655 1.1.1.1.6.1 riz <br><dt><code>rootdisp</code><dd>total root dispersion to the primary reference clock
656 1.1.1.1.6.1 riz <br><dt><code>refid</code><dd>reference ID or
657 1.1.1.1.6.1 riz .Lk decode.html#kiss "kiss code"
658 1.1.1.1.6.1 riz <br><dt><code>reftime</code><dd>reference time
659 1.1.1.1.6.1 riz <br><dt><code>reach</code><dd>reach register (octal)
660 1.1.1.1.6.1 riz <br><dt><code>unreach</code><dd>unreach counter
661 1.1.1.1.6.1 riz <br><dt><code>hmode</code><dd>host mode (1-6)
662 1.1.1.1.6.1 riz <br><dt><code>pmode</code><dd>peer mode (1-5)
663 1.1.1.1.6.1 riz <br><dt><code>hpoll</code><dd>host poll exponent (log2 s) (3-17)
664 1.1.1.1.6.1 riz <br><dt><code>ppoll</code><dd>peer poll exponent (log2 s) (3-17)
665 1.1.1.1.6.1 riz <br><dt><code>headway</code><dd>headway (see
666 1.1.1.1.6.1 riz .Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
667 1.1.1.1.6.1 riz <br><dt><code>flash</code><dd>.Lk decode.html#flash "flash status word"
668 1.1.1.1.6.1 riz <br><dt><code>offset</code><dd>filter offset
669 1.1.1.1.6.1 riz <br><dt><code>delay</code><dd>filter delay
670 1.1.1.1.6.1 riz <br><dt><code>dispersion</code><dd>filter dispersion
671 1.1.1.1.6.1 riz <br><dt><code>jitter</code><dd>filter jitter
672 1.1.1.1.6.1 riz <br><dt><code>ident</code><dd>Autokey group name for this association
673 1.1.1.1.6.1 riz <br><dt><code>bias</code><dd>unicast/broadcast bias
674 1.1.1.1.6.1 riz <br><dt><code>xleave</code><dd>interleave delay (see
675 1.1.1.1.6.1 riz .Lk xleave.html "NTP Interleaved Modes" )
676 1.1.1.1.6.1 riz </dl>
677 1.1.1.1.6.1 riz The
678 1.1.1.1.6.1 riz <code>bias</code>
679 1.1.1.1.6.1 riz variable is calculated when the first broadcast packet is received
680 1.1.1.1.6.1 riz after the calibration volley.
681 1.1.1.1.6.1 riz It represents the offset of the broadcast subgraph relative to the unicast subgraph.
682 1.1.1.1.6.1 riz The
683 1.1.1.1.6.1 riz <code>xleave</code>
684 1.1.1.1.6.1 riz variable appears only for the interleaved symmetric and interleaved modes.
685 1.1.1.1.6.1 riz It represents the internal queuing, buffering and transmission delays
686 1.1.1.1.6.1 riz for the preceding packet.
687 1.1.1.1.6.1 riz
688 1.1.1.1.6.1 riz <p>When the NTPv4 daemon is compiled with the OpenSSL software library,
689 1.1.1.1.6.1 riz additional peer variables are displayed, including the following:
690 1.1.1.1.6.1 riz <dl>
691 1.1.1.1.6.1 riz <dt>Variable<dd>Description
692 1.1.1.1.6.1 riz <br><dt><code>flags</code><dd>peer flags (see Autokey specification)
693 1.1.1.1.6.1 riz <br><dt><code>host</code><dd>Autokey server name
694 1.1.1.1.6.1 riz <br><dt><code>flags</code><dd>peer flags (see Autokey specification)
695 1.1.1.1.6.1 riz <br><dt><code>signature</code><dd>OpenSSL digest/signature scheme
696 1.1.1.1.6.1 riz <br><dt><code>initsequence</code><dd>initial key ID
697 1.1.1.1.6.1 riz <br><dt><code>initkey</code><dd>initial key index
698 1.1.1.1.6.1 riz <br><dt><code>timestamp</code><dd>Autokey signature timestamp
699 1.1.1.1.6.1 riz </dl>
700 1.1.1.1.6.1 riz
701 1.1.1.1.6.1 riz <h5 class="subsubsection">Clock Variables</h5>
702 1.1.1.1.6.1 riz
703 1.1.1.1.6.1 riz <p>The following clock variables appear in the
704 1.1.1.1.6.1 riz <code>cv</code>
705 1.1.1.1.6.1 riz billboard for each association with a reference clock.
706 1.1.1.1.6.1 riz Not all variables are displayed in some configurations.
707 1.1.1.1.6.1 riz <dl>
708 1.1.1.1.6.1 riz <dt>Variable<dd>Description
709 1.1.1.1.6.1 riz <br><dt><code>associd</code><dd>association ID
710 1.1.1.1.6.1 riz <br><dt><code>status</code><dd>.Lk decode.html#clock "clock status word"
711 1.1.1.1.6.1 riz <br><dt><code>device</code><dd>device description
712 1.1.1.1.6.1 riz <br><dt><code>timecode</code><dd>ASCII time code string (specific to device)
713 1.1.1.1.6.1 riz <br><dt><code>poll</code><dd>poll messages sent
714 1.1.1.1.6.1 riz <br><dt><code>noreply</code><dd>no reply
715 1.1.1.1.6.1 riz <br><dt><code>badformat</code><dd>bad format
716 1.1.1.1.6.1 riz <br><dt><code>baddata</code><dd>bad date or time
717 1.1.1.1.6.1 riz <br><dt><code>fudgetime1</code><dd>fudge time 1
718 1.1.1.1.6.1 riz <br><dt><code>fudgetime2</code><dd>fudge time 2
719 1.1.1.1.6.1 riz <br><dt><code>stratum</code><dd>driver stratum
720 1.1.1.1.6.1 riz <br><dt><code>refid</code><dd>driver reference ID
721 1.1.1.1.6.1 riz <br><dt><code>flags</code><dd>driver flags
722 1.1 christos </dl>
723 1.1 christos
724 1.1 christos <p>This section was generated by <strong>AutoGen</strong>,
725 1.1 christos using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpq</code> program.
726 1.1 christos This software is released under the NTP license, <http://ntp.org/license>.
727 1.1 christos
728 1.1 christos <ul class="menu">
729 1.1 christos <li><a accesskey="1" href="#ntpq-usage">ntpq usage</a>: ntpq help/usage (<span class="option">--help</span>)
730 1.1 christos <li><a accesskey="2" href="#ntpq-ipv4">ntpq ipv4</a>: ipv4 option (-4)
731 1.1 christos <li><a accesskey="3" href="#ntpq-ipv6">ntpq ipv6</a>: ipv6 option (-6)
732 1.1 christos <li><a accesskey="4" href="#ntpq-command">ntpq command</a>: command option (-c)
733 1.1.1.1.6.1 riz <li><a accesskey="5" href="#ntpq-interactive">ntpq interactive</a>: interactive option (-i)
734 1.1.1.1.6.1 riz <li><a accesskey="6" href="#ntpq-numeric">ntpq numeric</a>: numeric option (-n)
735 1.1.1.1.6.1 riz <li><a accesskey="7" href="#ntpq-old_002drv">ntpq old-rv</a>: old-rv option
736 1.1.1.1.6.1 riz <li><a accesskey="8" href="#ntpq-peers">ntpq peers</a>: peers option (-p)
737 1.1.1.1.6.1 riz <li><a accesskey="9" href="#ntpq-wide">ntpq wide</a>: wide option (-w)
738 1.1.1.1.6.1 riz <li><a href="#ntpq-config">ntpq config</a>: presetting/configuring ntpq
739 1.1 christos <li><a href="#ntpq-exit-status">ntpq exit status</a>: exit status
740 1.1 christos </ul>
741 1.1 christos
742 1.1 christos <div class="node">
743 1.1 christos <p><hr>
744 1.1 christos <a name="ntpq-usage"></a>Next: <a rel="next" accesskey="n" href="#ntpq-ipv4">ntpq ipv4</a>,
745 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
746 1.1 christos <br>
747 1.1 christos </div>
748 1.1 christos
749 1.1 christos <h4 class="subsection">ntpq help/usage (<span class="option">--help</span>)</h4>
750 1.1 christos
751 1.1 christos <p><a name="index-ntpq-help-3"></a>
752 1.1 christos This is the automatically generated usage text for ntpq.
753 1.1 christos
754 1.1 christos <p>The text printed is the same whether selected with the <code>help</code> option
755 1.1 christos (<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>). <code>more-help</code> will print
756 1.1 christos the usage text by passing it through a pager program.
757 1.1 christos <code>more-help</code> is disabled on platforms without a working
758 1.1 christos <code>fork(2)</code> function. The <code>PAGER</code> environment variable is
759 1.1 christos used to select the program, defaulting to <span class="file">more</span>. Both will exit
760 1.1 christos with a status code of 0.
761 1.1 christos
762 1.1.1.1.6.1 riz <pre class="example">ntpq - standard NTP query program - Ver. 4.2.7p486-RC
763 1.1 christos Usage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
764 1.1 christos Flg Arg Option-Name Description
765 1.1 christos -4 no ipv4 Force IPv4 DNS name resolution
766 1.1 christos - prohibits the option 'ipv6'
767 1.1 christos -6 no ipv6 Force IPv6 DNS name resolution
768 1.1 christos - prohibits the option 'ipv4'
769 1.1 christos -c Str command run a command and exit
770 1.1 christos - may appear multiple times
771 1.1 christos -d no debug-level Increase debug verbosity level
772 1.1 christos - may appear multiple times
773 1.1 christos -D Num set-debug-level Set the debug verbosity level
774 1.1 christos - may appear multiple times
775 1.1 christos -i no interactive Force ntpq to operate in interactive mode
776 1.1 christos - prohibits these options:
777 1.1 christos command
778 1.1 christos peers
779 1.1 christos -n no numeric numeric host addresses
780 1.1 christos no old-rv Always output status line with readvar
781 1.1.1.1.6.1 riz -p no peers Print a list of the peers
782 1.1.1.1.6.1 riz - prohibits the option 'interactive'
783 1.1.1.1.6.1 riz -w no wide Display the full 'remote' value
784 1.1 christos opt version output version information and exit
785 1.1 christos -? no help display extended usage information and exit
786 1.1 christos -! no more-help extended usage information passed thru pager
787 1.1 christos -> opt save-opts save the option state to a config file
788 1.1 christos -< Str load-opts load options from a config file
789 1.1 christos - disabled as '--no-load-opts'
790 1.1 christos - may appear multiple times
791 1.1 christos
792 1.1 christos Options are specified by doubled hyphens and their name or by a single
793 1.1 christos hyphen and the flag character.
794 1.1 christos
795 1.1 christos The following option preset mechanisms are supported:
796 1.1 christos - reading file $HOME/.ntprc
797 1.1 christos - reading file ./.ntprc
798 1.1 christos - examining environment variables named NTPQ_*
799 1.1 christos
800 1.1 christos Please send bug reports to: <http://bugs.ntp.org, bugs (a] ntp.org>
801 1.1 christos </pre>
802 1.1 christos <div class="node">
803 1.1 christos <p><hr>
804 1.1 christos <a name="ntpq-ipv4"></a>Next: <a rel="next" accesskey="n" href="#ntpq-ipv6">ntpq ipv6</a>,
805 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-usage">ntpq usage</a>,
806 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
807 1.1 christos <br>
808 1.1 christos </div>
809 1.1 christos
810 1.1 christos <h4 class="subsection">ipv4 option (-4)</h4>
811 1.1 christos
812 1.1 christos <p><a name="index-ntpq_002dipv4-4"></a>
813 1.1 christos This is the “force ipv4 dns name resolution” option.
814 1.1 christos
815 1.1 christos <p class="noindent">This option has some usage constraints. It:
816 1.1 christos <ul>
817 1.1 christos <li>must not appear in combination with any of the following options:
818 1.1 christos ipv6.
819 1.1 christos </ul>
820 1.1 christos
821 1.1 christos <p>Force DNS resolution of following host names on the command line
822 1.1 christos to the IPv4 namespace.
823 1.1 christos <div class="node">
824 1.1 christos <p><hr>
825 1.1 christos <a name="ntpq-ipv6"></a>Next: <a rel="next" accesskey="n" href="#ntpq-command">ntpq command</a>,
826 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-ipv4">ntpq ipv4</a>,
827 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
828 1.1 christos <br>
829 1.1 christos </div>
830 1.1 christos
831 1.1 christos <h4 class="subsection">ipv6 option (-6)</h4>
832 1.1 christos
833 1.1 christos <p><a name="index-ntpq_002dipv6-5"></a>
834 1.1 christos This is the “force ipv6 dns name resolution” option.
835 1.1 christos
836 1.1 christos <p class="noindent">This option has some usage constraints. It:
837 1.1 christos <ul>
838 1.1 christos <li>must not appear in combination with any of the following options:
839 1.1 christos ipv4.
840 1.1 christos </ul>
841 1.1 christos
842 1.1 christos <p>Force DNS resolution of following host names on the command line
843 1.1 christos to the IPv6 namespace.
844 1.1 christos <div class="node">
845 1.1 christos <p><hr>
846 1.1.1.1.6.1 riz <a name="ntpq-command"></a>Next: <a rel="next" accesskey="n" href="#ntpq-interactive">ntpq interactive</a>,
847 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-ipv6">ntpq ipv6</a>,
848 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
849 1.1 christos <br>
850 1.1 christos </div>
851 1.1 christos
852 1.1 christos <h4 class="subsection">command option (-c)</h4>
853 1.1 christos
854 1.1 christos <p><a name="index-ntpq_002dcommand-6"></a>
855 1.1 christos This is the “run a command and exit” option.
856 1.1 christos This option takes a string argument <span class="file">cmd</span>.
857 1.1 christos
858 1.1 christos <p class="noindent">This option has some usage constraints. It:
859 1.1 christos <ul>
860 1.1 christos <li>may appear an unlimited number of times.
861 1.1 christos </ul>
862 1.1 christos
863 1.1 christos <p>The following argument is interpreted as an interactive format command
864 1.1 christos and is added to the list of commands to be executed on the specified
865 1.1 christos host(s).
866 1.1 christos <div class="node">
867 1.1 christos <p><hr>
868 1.1 christos <a name="ntpq-interactive"></a>Next: <a rel="next" accesskey="n" href="#ntpq-numeric">ntpq numeric</a>,
869 1.1.1.1.6.1 riz Previous: <a rel="previous" accesskey="p" href="#ntpq-command">ntpq command</a>,
870 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
871 1.1 christos <br>
872 1.1 christos </div>
873 1.1 christos
874 1.1 christos <h4 class="subsection">interactive option (-i)</h4>
875 1.1 christos
876 1.1.1.1.6.1 riz <p><a name="index-ntpq_002dinteractive-7"></a>
877 1.1 christos This is the “force ntpq to operate in interactive mode” option.
878 1.1 christos
879 1.1 christos <p class="noindent">This option has some usage constraints. It:
880 1.1 christos <ul>
881 1.1 christos <li>must not appear in combination with any of the following options:
882 1.1 christos command, peers.
883 1.1 christos </ul>
884 1.1 christos
885 1.1 christos <p>Force <code>ntpq</code> to operate in interactive mode.
886 1.1 christos Prompts will be written to the standard output and
887 1.1 christos commands read from the standard input.
888 1.1 christos <div class="node">
889 1.1 christos <p><hr>
890 1.1 christos <a name="ntpq-numeric"></a>Next: <a rel="next" accesskey="n" href="#ntpq-old_002drv">ntpq old-rv</a>,
891 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-interactive">ntpq interactive</a>,
892 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
893 1.1 christos <br>
894 1.1 christos </div>
895 1.1 christos
896 1.1 christos <h4 class="subsection">numeric option (-n)</h4>
897 1.1 christos
898 1.1.1.1.6.1 riz <p><a name="index-ntpq_002dnumeric-8"></a>
899 1.1 christos This is the “numeric host addresses” option.
900 1.1 christos Output all host addresses in dotted-quad numeric format rather than
901 1.1 christos converting to the canonical host names.
902 1.1 christos <div class="node">
903 1.1 christos <p><hr>
904 1.1.1.1.6.1 riz <a name="ntpq-old_002drv"></a>Next: <a rel="next" accesskey="n" href="#ntpq-peers">ntpq peers</a>,
905 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-numeric">ntpq numeric</a>,
906 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
907 1.1 christos <br>
908 1.1 christos </div>
909 1.1 christos
910 1.1 christos <h4 class="subsection">old-rv option</h4>
911 1.1 christos
912 1.1.1.1.6.1 riz <p><a name="index-ntpq_002dold_002drv-9"></a>
913 1.1 christos This is the “always output status line with readvar” option.
914 1.1 christos By default, <code>ntpq</code> now suppresses the <code>associd=...</code>
915 1.1 christos line that precedes the output of <code>readvar</code>
916 1.1 christos (alias <code>rv</code>) when a single variable is requested, such as
917 1.1 christos <code>ntpq -c "rv 0 offset"</code>.
918 1.1 christos This option causes <code>ntpq</code> to include both lines of output
919 1.1 christos for a single-variable <code>readvar</code>.
920 1.1 christos Using an environment variable to
921 1.1 christos preset this option in a script will enable both older and
922 1.1.1.1.6.1 riz newer <code>ntpq</code> to behave identically in this regard.
923 1.1.1.1.6.1 riz <div class="node">
924 1.1.1.1.6.1 riz <p><hr>
925 1.1.1.1.6.1 riz <a name="ntpq-peers"></a>Next: <a rel="next" accesskey="n" href="#ntpq-wide">ntpq wide</a>,
926 1.1.1.1.6.1 riz Previous: <a rel="previous" accesskey="p" href="#ntpq-old_002drv">ntpq old-rv</a>,
927 1.1.1.1.6.1 riz Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
928 1.1.1.1.6.1 riz <br>
929 1.1.1.1.6.1 riz </div>
930 1.1.1.1.6.1 riz
931 1.1.1.1.6.1 riz <h4 class="subsection">peers option (-p)</h4>
932 1.1.1.1.6.1 riz
933 1.1.1.1.6.1 riz <p><a name="index-ntpq_002dpeers-10"></a>
934 1.1.1.1.6.1 riz This is the “print a list of the peers” option.
935 1.1.1.1.6.1 riz
936 1.1.1.1.6.1 riz <p class="noindent">This option has some usage constraints. It:
937 1.1.1.1.6.1 riz <ul>
938 1.1.1.1.6.1 riz <li>must not appear in combination with any of the following options:
939 1.1.1.1.6.1 riz interactive.
940 1.1.1.1.6.1 riz </ul>
941 1.1.1.1.6.1 riz
942 1.1.1.1.6.1 riz <p>Print a list of the peers known to the server as well as a summary
943 1.1.1.1.6.1 riz of their state. This is equivalent to the 'peers' interactive command.
944 1.1.1.1.6.1 riz <div class="node">
945 1.1.1.1.6.1 riz <p><hr>
946 1.1.1.1.6.1 riz <a name="ntpq-wide"></a>Next: <a rel="next" accesskey="n" href="#ntpq-config">ntpq config</a>,
947 1.1.1.1.6.1 riz Previous: <a rel="previous" accesskey="p" href="#ntpq-peers">ntpq peers</a>,
948 1.1.1.1.6.1 riz Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
949 1.1.1.1.6.1 riz <br>
950 1.1.1.1.6.1 riz </div>
951 1.1.1.1.6.1 riz
952 1.1.1.1.6.1 riz <h4 class="subsection">wide option (-w)</h4>
953 1.1.1.1.6.1 riz
954 1.1.1.1.6.1 riz <p><a name="index-ntpq_002dwide-11"></a>
955 1.1.1.1.6.1 riz This is the “display the full 'remote' value” option.
956 1.1.1.1.6.1 riz Display the full value of the 'remote' value. If this requires
957 1.1.1.1.6.1 riz more than 15 characters, display the full value, emit a newline,
958 1.1.1.1.6.1 riz and continue the data display properly indented on the next line.
959 1.1 christos
960 1.1 christos <div class="node">
961 1.1 christos <p><hr>
962 1.1 christos <a name="ntpq-config"></a>Next: <a rel="next" accesskey="n" href="#ntpq-exit-status">ntpq exit status</a>,
963 1.1.1.1.6.1 riz Previous: <a rel="previous" accesskey="p" href="#ntpq-wide">ntpq wide</a>,
964 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
965 1.1 christos <br>
966 1.1 christos </div>
967 1.1 christos
968 1.1 christos <h4 class="subsection">presetting/configuring ntpq</h4>
969 1.1 christos
970 1.1 christos <p>Any option that is not marked as <i>not presettable</i> may be preset by
971 1.1 christos loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTPQ</code> and <code>NTPQ_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of
972 1.1 christos the options listed above in upper case and segmented with underscores.
973 1.1 christos The <code>NTPQ</code> variable will be tokenized and parsed like
974 1.1 christos the command line. The remaining variables are tested for existence and their
975 1.1 christos values are treated like option arguments.
976 1.1 christos
977 1.1 christos <p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
978 1.1 christos <ul>
979 1.1 christos <li>$HOME
980 1.1 christos <li>$PWD
981 1.1 christos </ul>
982 1.1 christos The environment variables <code>HOME</code>, and <code>PWD</code>
983 1.1 christos are expanded and replaced when <span class="file">ntpq</span> runs.
984 1.1 christos For any of these that are plain files, they are simply processed.
985 1.1 christos For any that are directories, then a file named <span class="file">.ntprc</span> is searched for
986 1.1 christos within that directory and processed.
987 1.1 christos
988 1.1 christos <p>Configuration files may be in a wide variety of formats.
989 1.1 christos The basic format is an option name followed by a value (argument) on the
990 1.1 christos same line. Values may be separated from the option name with a colon,
991 1.1 christos equal sign or simply white space. Values may be continued across multiple
992 1.1 christos lines by escaping the newline with a backslash.
993 1.1 christos
994 1.1 christos <p>Multiple programs may also share the same initialization file.
995 1.1 christos Common options are collected at the top, followed by program specific
996 1.1 christos segments. The segments are separated by lines like:
997 1.1 christos <pre class="example"> [NTPQ]
998 1.1 christos </pre>
999 1.1 christos <p class="noindent">or by
1000 1.1 christos <pre class="example"> <?program ntpq>
1001 1.1 christos </pre>
1002 1.1 christos <p class="noindent">Do not mix these styles within one configuration file.
1003 1.1 christos
1004 1.1 christos <p>Compound values and carefully constructed string values may also be
1005 1.1 christos specified using XML syntax:
1006 1.1 christos <pre class="example"> <option-name>
1007 1.1 christos <sub-opt>...&lt;...&gt;...</sub-opt>
1008 1.1 christos </option-name>
1009 1.1 christos </pre>
1010 1.1 christos <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
1011 1.1 christos <pre class="example"> "...<...>..."
1012 1.1 christos </pre>
1013 1.1 christos <p><code>AutoOpts</code> does not track suboptions. You simply note that it is a
1014 1.1 christos hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching
1015 1.1 christos the associated name/value pair list (see: optionFindValue).
1016 1.1 christos
1017 1.1 christos <p>The command line options relating to configuration and/or usage help are:
1018 1.1 christos
1019 1.1 christos <h5 class="subsubheading">version (-)</h5>
1020 1.1 christos
1021 1.1 christos <p>Print the program version to standard out, optionally with licensing
1022 1.1 christos information, then exit 0. The optional argument specifies how much licensing
1023 1.1 christos detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument.
1024 1.1 christos Only the first letter of the argument is examined:
1025 1.1 christos
1026 1.1 christos <dl>
1027 1.1 christos <dt><span class="samp">version</span><dd>Only print the version. This is the default.
1028 1.1 christos <br><dt><span class="samp">copyright</span><dd>Name the copyright usage licensing terms.
1029 1.1 christos <br><dt><span class="samp">verbose</span><dd>Print the full copyright usage licensing terms.
1030 1.1 christos </dl>
1031 1.1 christos
1032 1.1 christos <div class="node">
1033 1.1 christos <p><hr>
1034 1.1 christos <a name="ntpq-exit-status"></a>Previous: <a rel="previous" accesskey="p" href="#ntpq-config">ntpq config</a>,
1035 1.1 christos Up: <a rel="up" accesskey="u" href="#ntpq-Invocation">ntpq Invocation</a>
1036 1.1 christos <br>
1037 1.1 christos </div>
1038 1.1 christos
1039 1.1 christos <h4 class="subsection">ntpq exit status</h4>
1040 1.1 christos
1041 1.1 christos <p>One of the following exit values will be returned:
1042 1.1 christos <dl>
1043 1.1 christos <dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution.
1044 1.1 christos <br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid.
1045 1.1 christos <br><dt><span class="samp">66 (EX_NOINPUT)</span><dd>A specified configuration file could not be loaded.
1046 1.1 christos <br><dt><span class="samp">70 (EX_SOFTWARE)</span><dd>libopts had an internal operational error. Please report
1047 1.1 christos it to autogen-users (a] lists.sourceforge.net. Thank you.
1048 1.1 christos </dl>
1049 1.1 christos
1050 1.1 christos <div class="node">
1051 1.1 christos <p><hr>
1052 1.1 christos <a name="Usage"></a>Next: <a rel="next" accesskey="n" href="#Internal-Commands">Internal Commands</a>,
1053 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntpq-Description">ntpq Description</a>,
1054 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1055 1.1 christos <br>
1056 1.1 christos </div>
1057 1.1 christos
1058 1.1 christos <!-- node-name, next, previous, up -->
1059 1.1 christos <h3 class="section">Usage</h3>
1060 1.1 christos
1061 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="23%">What </th><th valign="top" width="23%">Default </th><th valign="top" width="5%">Flag </th><th valign="top" width="15%">Option
1062 1.1 christos <br></th></tr><tr align="left"><td valign="top" width="23%">configuration file
1063 1.1 christos </td><td valign="top" width="23%"><code>/etc/ntp.conf</code>
1064 1.1 christos </td><td valign="top" width="5%"><code>-c</code>
1065 1.1 christos </td><td valign="top" width="15%"><code>conffile</code>
1066 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">frequency file
1067 1.1 christos </td><td valign="top" width="23%">none
1068 1.1 christos </td><td valign="top" width="5%"><code>-f</code>
1069 1.1 christos </td><td valign="top" width="15%"><code>driftfile</code>
1070 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">leapseconds file
1071 1.1 christos </td><td valign="top" width="23%">none
1072 1.1 christos </td><td valign="top" width="5%">
1073 1.1 christos </td><td valign="top" width="15%"><code>leapfile</code>
1074 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">process ID file
1075 1.1 christos </td><td valign="top" width="23%">none
1076 1.1 christos </td><td valign="top" width="5%"><code>-p</code>
1077 1.1 christos </td><td valign="top" width="15%"><code>pidfile</code>
1078 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">log file
1079 1.1 christos </td><td valign="top" width="23%">system log
1080 1.1 christos </td><td valign="top" width="5%"><code>-l</code>
1081 1.1 christos </td><td valign="top" width="15%"><code>logfile</code>
1082 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">include file
1083 1.1 christos </td><td valign="top" width="23%">none
1084 1.1 christos </td><td valign="top" width="5%">none
1085 1.1 christos </td><td valign="top" width="15%"><code>includefile</code>
1086 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">statistics path
1087 1.1 christos </td><td valign="top" width="23%"><code>/var/NTP</code>
1088 1.1 christos </td><td valign="top" width="5%"><code>-s</code>
1089 1.1 christos </td><td valign="top" width="15%"><code>statsdir</code>
1090 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="23%">keys path
1091 1.1 christos </td><td valign="top" width="23%"><code>/usr/local/etc</code>
1092 1.1 christos </td><td valign="top" width="5%"><code>-k</code>
1093 1.1 christos </td><td valign="top" width="15%"><code>keysdir</code>
1094 1.1 christos <br></td></tr></table>
1095 1.1 christos
1096 1.1 christos <div class="node">
1097 1.1 christos <p><hr>
1098 1.1 christos <a name="Internal-Commands"></a>Next: <a rel="next" accesskey="n" href="#Control-Message-Commands">Control Message Commands</a>,
1099 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Usage">Usage</a>,
1100 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1101 1.1 christos <br>
1102 1.1 christos </div>
1103 1.1 christos
1104 1.1 christos <!-- node-name, next, previous, up -->
1105 1.1 christos <h3 class="section">Internal Commands</h3>
1106 1.1 christos
1107 1.1 christos <p>Interactive format commands consist of a keyword followed by zero to four arguments. Only enough characters of the full keyword to uniquely identify the command need be typed. The output of a command is normally sent to the standard output, but optionally the output of individual commands may be sent to a file by appending a <code>></code>, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the <code>ntpq</code> program itself and do not result in NTP mode-6 requests being sent to a server. These are described following.
1108 1.1 christos
1109 1.1 christos <dl>
1110 1.1 christos <dt><code><a name="help"></a> ? [</code><kbd>command_keyword</kbd><code>]</code><dt><code>help [</code><kbd>command_keyword</kbd><code>]</code><dd>A <code>?</code> by itself will print a list of all the command keywords known to <code>ntpq</code>. A <code>?</code> followed by a command keyword will print function and usage information about the command.
1111 1.1 christos
1112 1.1 christos <br><dt><code><a name="addvars"></a> >addvars </code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code>] [...]</code><dt><code>rmvars </code><kbd>name</kbd><code> [...]</code><dt><code>clearvars</dt></code><dd>The arguments to these commands consist of a list of items of the form
1113 1.1 christos <kbd>name</kbd><code> = </code><kbd>value</kbd>, where the <code>= </code><kbd>value</kbd> is ignored,
1114 1.1 christos and can be omitted in read requests.
1115 1.1 christos <code>ntpq</code> maintains an internal list in which data to be included
1116 1.1 christos in control messages can be assembled, and sent using the <code>readlist</code>
1117 1.1 christos and <code>writelist</code> commands described below.
1118 1.1 christos The <code>addvars</code> command allows variables and optional values
1119 1.1 christos to be added to the list.
1120 1.1 christos If more than one variable is to be added
1121 1.1 christos the list should be comma-separated and not contain white space.
1122 1.1 christos The <code>rmvars</code> command can be used to remove individual variables
1123 1.1 christos from the list,
1124 1.1 christos while the <code>clearlist</code> command removes all variables from the list.
1125 1.1 christos
1126 1.1 christos <br><dt><code><a name="cooked"></a> cooked</code><dd>Display server messages in prettyprint format.
1127 1.1 christos
1128 1.1 christos <br><dt><code><a name="debug"></a> debug more | less | off</code><dd>Turns internal query program debugging on and off.
1129 1.1 christos
1130 1.1 christos <br><dt><code><a name="delay"></a> delay </code><kbd>milliseconds</kbd><dd>Specify a time interval to be added to timestamps included in requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, so this command may be obsolete.
1131 1.1 christos
1132 1.1 christos <br><dt><code><a name="host"></a> host </code><kbd>name</kbd><dd>Set the host to which future queries will be sent.
1133 1.1 christos The name may be either a DNS name or a numeric address.
1134 1.1 christos
1135 1.1 christos <br><dt><code><a name="hostnames"></a> hostnames [yes | no]</code><dd>If <code>yes</code> is specified, host names are printed in information displays.
1136 1.1 christos If <code>no</code> is specified, numeric addresses are printed instead.
1137 1.1 christos The default is <code>yes</code>,
1138 1.1 christos unless modified using the command line <code>-n</code> switch.
1139 1.1 christos
1140 1.1 christos <br><dt><code><a name="keyid"></a> keyid </code><kbd>keyid</kbd><dd>This command specifies the key number to be used
1141 1.1 christos to authenticate configuration requests.
1142 1.1 christos This must correspond to a key ID configured in <code>ntp.conf</code> for this purpose.
1143 1.1 christos
1144 1.1 christos <br><dt><code><a name="keytype"></a> keytype</code><dd>Specify the digest algorithm to use for authenticated requests,
1145 1.1 christos with default <code>MD5</code>.
1146 1.1 christos If the OpenSSL library is installed,
1147 1.1 christos digest can be be any message digest algorithm supported by the library.
1148 1.1 christos The current selections are: <code>MD2</code>, <code>MD4</code>, <code>MD5</code>, <code>MDC2</code>, <code>RIPEMD160</code>, <code>SHA</code> and <code>SHA1</code>.
1149 1.1 christos
1150 1.1 christos <br><dt><code><a name="ntpversion"></a> ntpversion 1 | 2 | 3 | 4</code><dd>Sets the NTP version number which <code>ntpq</code> claims in packets.
1151 1.1 christos Defaults to 2.
1152 1.1 christos Note that mode-6 control messages (and modes, for that matter)
1153 1.1 christos didn't exist in NTP version 1.
1154 1.1 christos
1155 1.1 christos <br><dt><code><a name="passwd"></a> passwd</code><dd>This command prompts for a password to authenticate requests.
1156 1.1 christos The password must correspond to the key ID configured in <code>ntp.conf</code> for this purpose.
1157 1.1 christos
1158 1.1 christos <br><dt><code><a name="quit"></a> quit</code><dd>Exit <code>ntpq</code>.
1159 1.1 christos
1160 1.1 christos <br><dt><code><a name="raw"></a> raw</code><dd>Display server messages as received and without reformatting.
1161 1.1 christos
1162 1.1 christos <br><dt><code><a name="timeout"></a> timeout </code><kbd>millseconds</kbd><dd>Specify a timeout period for responses to server queries.
1163 1.1 christos The default is about 5000 milliseconds.
1164 1.1 christos Note that since <code>ntpq</code> retries each query once after a timeout
1165 1.1 christos the total waiting time for a timeout will be twice the timeout value set.
1166 1.1 christos
1167 1.1 christos </dl>
1168 1.1 christos
1169 1.1 christos <div class="node">
1170 1.1 christos <p><hr>
1171 1.1 christos <a name="Control-Message-Commands"></a>Next: <a rel="next" accesskey="n" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>,
1172 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Internal-Commands">Internal Commands</a>,
1173 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1174 1.1 christos <br>
1175 1.1 christos </div>
1176 1.1 christos
1177 1.1 christos <!-- node-name, next, previous, up -->
1178 1.1 christos <h3 class="section">Control Message Commands</h3>
1179 1.1 christos
1180 1.1 christos <p>Association IDs are used to identify system, peer and clock variables.
1181 1.1 christos System variables are assigned an association ID of zero and system name space,
1182 1.1 christos while each association is assigned a nonzero association ID and peer namespace.
1183 1.1 christos Most control commands send a single mode-6 message to the server
1184 1.1 christos and expect a single response message.
1185 1.1 christos The exceptions are the <code>peers</code> command,
1186 1.1 christos which sends a series of messages,
1187 1.1 christos and the <code>mreadlist</code> and <code>mreadvar</code> commands,
1188 1.1 christos which iterate over a range of associations.
1189 1.1 christos
1190 1.1 christos <p><a name="as"></a>
1191 1.1 christos <dl>
1192 1.1 christos <dt><code>associations</code><dd>Display a list of mobilized associations in the form:
1193 1.1 christos <br>
1194 1.1 christos <code>ind assid status conf reach auth condition last_event cnt</code>
1195 1.1 christos
1196 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="40%">Description
1197 1.1 christos
1198 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>ind</code>
1199 1.1 christos </td><td valign="top" width="40%">index on this list
1200 1.1 christos
1201 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>assid</code>
1202 1.1 christos </td><td valign="top" width="40%">association ID
1203 1.1 christos
1204 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
1205 1.1 christos </td><td valign="top" width="40%"><a href="decode.html#peer">peer status word</a>
1206 1.1 christos
1207 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>conf</code>
1208 1.1 christos </td><td valign="top" width="40%"><code>yes</code>: persistent, <code>no</code>: ephemeral
1209 1.1 christos
1210 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
1211 1.1 christos </td><td valign="top" width="40%"><code>yes</code>: reachable, <code>no</code>: unreachable
1212 1.1 christos
1213 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>auth</code>
1214 1.1 christos </td><td valign="top" width="40%"><code>ok</code>, <code>yes</code>, <code>bad</code> and <code>none</code>
1215 1.1 christos
1216 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>condition</code>
1217 1.1 christos </td><td valign="top" width="40%">selection status (see the <code>select</code> field of the <a href="decode.html#peer">peer status word</a>)
1218 1.1 christos
1219 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>last_event</code>
1220 1.1 christos </td><td valign="top" width="40%">event report (see the <code>event</code> field of the <a href="decode.html#peer">peer status word</a>)
1221 1.1 christos
1222 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cnt</code>
1223 1.1 christos event count (see the <code>count</code> field of the <a href="decode.html#peer">peer status word</a>)
1224 1.1 christos
1225 1.1 christos <br></td></tr></table>
1226 1.1 christos
1227 1.1 christos <br><dt><code><a name="cv"></a> clockvar </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...]] [...]]</code><dt><code>cv </code><kbd>assocID</kbd><code> [</code><kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> [...] ][...]]</code><dd>Display a list of <a href="#clock">clock variables</a> for those associations supporting a reference clock.
1228 1.1 christos
1229 1.1 christos <br><dt><code><a name="_003aconfig"></a> :config [...]</code><dd>Send the remainder of the command line, including whitespace, to the server
1230 1.1 christos as a run-time configuration command in the same format
1231 1.1 christos as the configuration file.
1232 1.1 christos This command is experimental until further notice and clarification.
1233 1.1 christos Authentication is of course required.
1234 1.1 christos
1235 1.1 christos <br><dt><code><a name="config_002dfrom_002dfile"></a> config-from-file </code><kbd>filename</kbd><dd>Send the each line of <kbd>filename</kbd> to the server as
1236 1.1 christos run-time configuration commands in the same format as the configuration file.
1237 1.1 christos This command is experimental until further notice and clarification.
1238 1.1 christos Authentication is required.
1239 1.1 christos
1240 1.1 christos <br><dt><code><a name="ifstats"></a> ifstats</code><dd>Display statistics for each local network address.
1241 1.1 christos Authentication is required.
1242 1.1 christos
1243 1.1 christos <br><dt><code><a name="iostats"></a> iostats</code><dd>Display network and reference clock I/O statistics.
1244 1.1 christos
1245 1.1 christos <br><dt><code><a name="kerninfo"></a> kerninfo</code><dd>Display kernel loop and PPS statistics.
1246 1.1 christos As with other ntpq output, times are in milliseconds.
1247 1.1 christos The precision value displayed is in milliseconds as well,
1248 1.1 christos unlike the precision system variable.
1249 1.1 christos
1250 1.1 christos <br><dt><code><a name="lassoc"></a> lassociations</code><dd>Perform the same function as the associations command,
1251 1.1 christos except display mobilized and unmobilized associations.
1252 1.1 christos
1253 1.1 christos <br><dt><code><a name="monstats"></a> monstats</code><dd>Display monitor facility statistics.
1254 1.1 christos
1255 1.1 christos <br><dt><code><a name="mrulist"></a> mrulist [limited | kod | mincount=</code><kbd>count</kbd><code> | laddr=</code><kbd>localaddr</kbd><code> | sort=</code><kbd>sortorder</kbd><code> | resany=</code><kbd>hexmask</kbd><code> | resall=</code><kbd>hexmask</kbd><code>]</code><dd>Obtain and print traffic counts collected and maintained by
1256 1.1 christos the monitor facility.
1257 1.1 christos With the exception of <code>sort=</code><kbd>sortorder</kbd>,
1258 1.1 christos the options filter the list returned by <code>ntpd</code>.
1259 1.1 christos The <code>limited</code> and <code>kod</code> options return only entries
1260 1.1 christos representing client addresses from which the last packet received
1261 1.1 christos triggered either discarding or a KoD response.
1262 1.1 christos The <code>mincount=</code><kbd>count</kbd> option filters entries representing
1263 1.1 christos less than <kbd>count</kbd> packets.
1264 1.1 christos The <code>laddr=</code><kbd>localaddr</kbd> option filters entries for packets
1265 1.1 christos received on any local address other than <kbd>localaddr</kbd>.
1266 1.1 christos <code>resany=</code><kbd>hexmask</kbd> and <code>resall=</code><kbd>hexmask</kbd>
1267 1.1 christos filter entries containing none or less than all, respectively,
1268 1.1 christos of the bits in <kbd>hexmask</kbd>, which must begin with <code>0x</code>.
1269 1.1 christos <br>
1270 1.1 christos The <kbd>sortorder</kbd> defaults to <code>lstint</code> and may be any of
1271 1.1 christos <code>addr</code>, <code>count</code>, <code>avgint</code>, <code>lstint</code>, or
1272 1.1 christos any of those preceded by a minus sign (hyphen) to reverse the sort order.
1273 1.1 christos The output columns are:
1274 1.1 christos
1275 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Column </th><th valign="top" width="40%">Description
1276 1.1 christos
1277 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>lstint</code>
1278 1.1 christos </td><td valign="top" width="40%">
1279 1.1 christos Interval in s between the receipt of the most recent packet from this
1280 1.1 christos address and the completion of the retrieval of the MRU list by <code>ntpq</code>
1281 1.1 christos
1282 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>avgint</code>
1283 1.1 christos </td><td valign="top" width="40%">
1284 1.1 christos Average interval in s between packets from this address.
1285 1.1 christos
1286 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rstr</code>
1287 1.1 christos </td><td valign="top" width="40%">
1288 1.1 christos Restriction flags associated with this address.
1289 1.1 christos Most are copied unchanged from the matching <code>restrict</code> command,
1290 1.1 christos however 0x400 (kod) and 0x20 (limited) flags are cleared unless
1291 1.1 christos the last packet from this address triggered a rate control response.
1292 1.1 christos
1293 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>r</code>
1294 1.1 christos </td><td valign="top" width="40%">
1295 1.1 christos Rate control indicator, either a period, <code>L</code> or <code>K</code> for
1296 1.1 christos no rate control response, rate limiting by discarding, or
1297 1.1 christos rate limiting with a KoD response, respectively.
1298 1.1 christos
1299 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>m</code>
1300 1.1 christos </td><td valign="top" width="40%">
1301 1.1 christos Packet mode.
1302 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>v</code>
1303 1.1 christos </td><td valign="top" width="40%">
1304 1.1 christos Packet version number.
1305 1.1 christos
1306 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>count</code>
1307 1.1 christos </td><td valign="top" width="40%">
1308 1.1 christos Packets received from this address.
1309 1.1 christos
1310 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rport</code>
1311 1.1 christos </td><td valign="top" width="40%">
1312 1.1 christos Source port of last packet from this address.
1313 1.1 christos
1314 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote address</code>
1315 1.1 christos </td><td valign="top" width="40%">
1316 1.1 christos DNS name, numeric address, or address followed by claimed DNS name which
1317 1.1 christos could not be verified in parentheses.
1318 1.1 christos
1319 1.1 christos <br></td></tr></table>
1320 1.1 christos
1321 1.1 christos <br><dt><code><a name="mreadvar"></a> mreadvar </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dt><code><a name="mrv"></a> mrv </code><kbd>assocID</kbd> <kbd>assocID</kbd><code> [ </code><kbd>variable_name</kbd><code> [ = </code><kbd>value</kbd><code>[ ... ]</code><dd>Perform the same function as the <code>readvar</code> command,
1322 1.1 christos except for a range of association IDs.
1323 1.1 christos This range is determined from the association list cached by
1324 1.1 christos the most recent <code>associations</code> command.
1325 1.1 christos
1326 1.1 christos <br><dt><code><a name="passoc"></a> passociations</code><dd>Perform the same function as the <code>associations command</code>, except that
1327 1.1 christos it uses previously stored data rather than making a new query.
1328 1.1 christos
1329 1.1 christos <br><dt><code><a name="pe"></a> peers</code><dd>Display a list of peers in the form:
1330 1.1 christos <br>
1331 1.1 christos <code>[tally]remote refid st t when pool reach delay offset jitter</code>
1332 1.1 christos
1333 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1334 1.1 christos <br></th></tr><tr align="left"><td valign="top" width="10%"><code>[tally]</code>
1335 1.1 christos </td><td valign="top" width="20%">
1336 1.1 christos single-character code indicating current value of the <code>select</code> field
1337 1.1 christos of the <a href="decode.html#peer">peer status word</a>.
1338 1.1 christos
1339 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>remote</code>
1340 1.1 christos </td><td valign="top" width="20%">
1341 1.1 christos host name (or IP number) of peer
1342 1.1 christos
1343 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
1344 1.1 christos </td><td valign="top" width="20%">
1345 1.1 christos association ID or <a href="decode.html#kiss">kiss code</a>.
1346 1.1 christos
1347 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>st</code>
1348 1.1 christos </td><td valign="top" width="20%">
1349 1.1 christos stratum
1350 1.1 christos
1351 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>t</code>
1352 1.1 christos </td><td valign="top" width="20%">
1353 1.1 christos <code>u</code>: unicast or manycast client,
1354 1.1 christos <code>b</code>: broadcast or multicast client,
1355 1.1 christos <code>l</code>: local (reference clock),
1356 1.1 christos <code>s</code>: symmetric (peer),
1357 1.1 christos <code>A</code>: manycast server,
1358 1.1 christos <code>B</code>: broadcast server,
1359 1.1 christos <code>M</code>: multicast server.
1360 1.1 christos
1361 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>when</code>
1362 1.1 christos </td><td valign="top" width="20%">
1363 1.1 christos sec/min/hr since last received packet
1364 1.1 christos
1365 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code>
1366 1.1 christos </td><td valign="top" width="20%">
1367 1.1 christos poll interval (log(2) s)
1368 1.1 christos
1369 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
1370 1.1 christos </td><td valign="top" width="20%">
1371 1.1 christos reach shift register (octal)
1372 1.1 christos
1373 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code>
1374 1.1 christos </td><td valign="top" width="20%">
1375 1.1 christos roundtrip delay
1376 1.1 christos
1377 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
1378 1.1 christos </td><td valign="top" width="20%">
1379 1.1 christos offset of server relative to this host
1380 1.1 christos
1381 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code>
1382 1.1 christos </td><td valign="top" width="20%">
1383 1.1 christos jitter
1384 1.1 christos
1385 1.1 christos <br></td></tr></table>
1386 1.1 christos
1387 1.1 christos <br><dt><code><a name="rv"></a> readvar </code><kbd>assocID</kbd> <kbd>name</kbd><code> [ = </code><kbd>value</kbd><code> ] [,...]</code><dt><code>rv </code><kbd>assocID</kbd><code> [ </code><kbd>name</kbd><code> ] [,...]</code><dd>Display the specified variables.
1388 1.1 christos If <kbd>assocID</kbd> is zero,
1389 1.1 christos the variables are from the <a href="#system">system variables</a> name space,
1390 1.1 christos otherwise they are from the <a href="#peer">peer variables</a> name space.
1391 1.1 christos The <kbd>assocID</kbd> is required, as the same name can occur in both spaces.
1392 1.1 christos If no <kbd>name</kbd> is included,
1393 1.1 christos all operative variables in the name space are displayed.
1394 1.1 christos In this case only, if the <kbd>assocID</kbd> is omitted, it is assumed zero.
1395 1.1 christos Multiple names are specified with comma separators and without whitespace.
1396 1.1 christos Note that time values are represented in milliseconds and
1397 1.1 christos frequency values in parts-per-million (PPM).
1398 1.1 christos Some NTP timestamps are represented in the format YYYYMMDDTTTT,
1399 1.1 christos where YYYY is the year, MM the month of year, DD the day of month and
1400 1.1 christos TTTT the time of day.
1401 1.1 christos
1402 1.1 christos <br><dt><code><a name="saveconfig"></a> saveconfig </code><kbd>filename</kbd><dd>Write the current configuration, including any runtime modifications
1403 1.1 christos given with <code>:config</code> or <code>config-from-file</code>,
1404 1.1 christos to the ntpd host's file <kbd>filename</kbd>.
1405 1.1 christos This command will be rejected by the server unless
1406 1.1 christos <a href="miscopt.html#saveconfigdir">saveconfigdir</a>
1407 1.1 christos appears in the <code>ntpd</code> configuration file.
1408 1.1 christos <kbd>filename</kbd> can use <code>strftime()</code> format specifiers
1409 1.1 christos to substitute the current date and time, for example,
1410 1.1 christos <code>saveconfig ntp-%Y%m%d-%H%M%S.conf</code>.
1411 1.1 christos The filename used is stored in system variable <code>savedconfig</code>.
1412 1.1 christos Authentication is required.
1413 1.1 christos
1414 1.1 christos <br><dt><code><a name="writevar"></a> writevar </code><kbd>assocID</kbd> <kbd>name</kbd><code> = </code><kbd>value</kbd><code> [,...]</code><dd>Write the specified variables.
1415 1.1 christos If the <kbd>assocID</kbd> is zero, the variables are from the
1416 1.1 christos <a href="#system">system variables</a> name space, otherwise they are from the
1417 1.1 christos <a href="#peer">peer variables</a> name space.
1418 1.1 christos The <kbd>assocID</kbd> is required,
1419 1.1 christos as the same name can occur in both spaces.
1420 1.1 christos
1421 1.1 christos <br><dt><code><a name="sysinfo"></a> sysinfo</code><dd>Display operational summary.
1422 1.1 christos
1423 1.1 christos <br><dt><code><a name="sysstats"></a> sysstats</code><dd>Print statistics counters maintained in the protocol module.
1424 1.1 christos
1425 1.1 christos </dl>
1426 1.1 christos
1427 1.1 christos <div class="node">
1428 1.1 christos <p><hr>
1429 1.1 christos <a name="Status-Words-and-Kiss-Codes"></a>Next: <a rel="next" accesskey="n" href="#System-Variables">System Variables</a>,
1430 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Control-Message-Commands">Control Message Commands</a>,
1431 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1432 1.1 christos <br>
1433 1.1 christos </div>
1434 1.1 christos
1435 1.1 christos <!-- node-name, next, previous, up -->
1436 1.1 christos <h3 class="section">Status Words and Kiss Codes</h3>
1437 1.1 christos
1438 1.1 christos <p>The current state of the operating program is shown
1439 1.1 christos in a set of status words maintained by the system
1440 1.1 christos and each association separately.
1441 1.1 christos These words are displayed in the <code>rv</code> and <code>as</code> commands
1442 1.1 christos both in hexadecimal and decoded short tip strings.
1443 1.1 christos The codes, tips and short explanations are on the
1444 1.1 christos <a href="decode.html">Event Messages and Status Words</a> page.
1445 1.1 christos The page also includes a list of system and peer messages,
1446 1.1 christos the code for the latest of which is included in the status word.
1447 1.1 christos
1448 1.1 christos <p>Information resulting from protocol machine state transitions
1449 1.1 christos is displayed using an informal set of ASCII strings called
1450 1.1 christos <a href="decode.html#kiss">kiss codes</a>.
1451 1.1 christos The original purpose was for kiss-o'-death (KoD) packets sent
1452 1.1 christos by the server to advise the client of an unusual condition.
1453 1.1 christos They are now displayed, when appropriate,
1454 1.1 christos in the reference identifier field in various billboards.
1455 1.1 christos
1456 1.1 christos <div class="node">
1457 1.1 christos <p><hr>
1458 1.1 christos <a name="System-Variables"></a>Next: <a rel="next" accesskey="n" href="#Peer-Variables">Peer Variables</a>,
1459 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Status-Words-and-Kiss-Codes">Status Words and Kiss Codes</a>,
1460 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1461 1.1 christos <br>
1462 1.1 christos </div>
1463 1.1 christos
1464 1.1 christos <!-- node-name, next, previous, up -->
1465 1.1 christos <h3 class="section">System Variables</h3>
1466 1.1 christos
1467 1.1 christos <p>The following system variables appear in the <code>rv</code> billboard.
1468 1.1 christos Not all variables are displayed in some configurations.
1469 1.1 christos
1470 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1471 1.1 christos
1472 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
1473 1.1 christos </td><td valign="top" width="20%">
1474 1.1 christos <a href="decode.html#sys">system status word</a>
1475 1.1 christos
1476 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>version</code>
1477 1.1 christos </td><td valign="top" width="20%">
1478 1.1 christos NTP software version and build time
1479 1.1 christos
1480 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>processor</code>
1481 1.1 christos </td><td valign="top" width="20%">
1482 1.1 christos hardware platform and version
1483 1.1 christos
1484 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>system</code>
1485 1.1 christos </td><td valign="top" width="20%">
1486 1.1 christos operating system and version
1487 1.1 christos
1488 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code>
1489 1.1 christos </td><td valign="top" width="20%">
1490 1.1 christos leap warning indicator (0-3)
1491 1.1 christos
1492 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
1493 1.1 christos </td><td valign="top" width="20%">
1494 1.1 christos stratum (1-15)
1495 1.1 christos
1496 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code>
1497 1.1 christos </td><td valign="top" width="20%">
1498 1.1 christos precision (log(2) s)
1499 1.1 christos
1500 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code>
1501 1.1 christos </td><td valign="top" width="20%">
1502 1.1 christos total roundtrip delay to the primary reference clock
1503 1.1 christos
1504 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code>
1505 1.1 christos </td><td valign="top" width="20%">
1506 1.1 christos total dispersion to the primary reference clock
1507 1.1 christos
1508 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>peer</code>
1509 1.1 christos </td><td valign="top" width="20%">
1510 1.1 christos system peer association ID
1511 1.1 christos
1512 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tc</code>
1513 1.1 christos time constant and poll exponent (log(2) s) (3-17)
1514 1.1 christos
1515 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>mintc</code>
1516 1.1 christos minimum time constant (log(2) s) (3-10)
1517 1.1 christos
1518 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clock</code>
1519 1.1 christos </td><td valign="top" width="20%">
1520 1.1 christos date and time of day
1521 1.1 christos
1522 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
1523 1.1 christos reference ID or <a href="decode.html#kiss">kiss code</a>
1524 1.1 christos
1525 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code>
1526 1.1 christos </td><td valign="top" width="20%">
1527 1.1 christos reference time
1528 1.1 christos
1529 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
1530 1.1 christos </td><td valign="top" width="20%">
1531 1.1 christos combined offset of server relative to this host
1532 1.1 christos
1533 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>sys_jitter</code>
1534 1.1 christos </td><td valign="top" width="20%">
1535 1.1 christos combined system jitter
1536 1.1 christos
1537 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>frequency</code>
1538 1.1 christos </td><td valign="top" width="20%">
1539 1.1 christos frequency offset (PPM) relative to hardware clock
1540 1.1 christos
1541 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_wander</code>
1542 1.1 christos </td><td valign="top" width="20%">
1543 1.1 christos clock frequency wander (PPM)
1544 1.1 christos
1545 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>clk_jitter</code>
1546 1.1 christos </td><td valign="top" width="20%">
1547 1.1 christos clock jitter
1548 1.1 christos
1549 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>tai</code>
1550 1.1 christos </td><td valign="top" width="20%">
1551 1.1 christos TAI-UTC offset (s)
1552 1.1 christos
1553 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leapsec</code>
1554 1.1 christos </td><td valign="top" width="20%">
1555 1.1 christos NTP seconds when the next leap second is/was inserted
1556 1.1 christos
1557 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>expire</code>
1558 1.1 christos </td><td valign="top" width="20%">
1559 1.1 christos NTP seconds when the NIST leapseconds file expires
1560 1.1 christos
1561 1.1 christos <br></td></tr></table>
1562 1.1 christos
1563 1.1 christos <p>The jitter and wander statistics are exponentially-weighted RMS averages.
1564 1.1 christos The system jitter is defined in the NTPv4 specification;
1565 1.1 christos the clock jitter statistic is computed by the clock discipline module.
1566 1.1 christos
1567 1.1 christos <p>When the NTPv4 daemon is compiled with the OpenSSL software library,
1568 1.1 christos additional system variables are displayed, including some or all of the
1569 1.1 christos following, depending on the particular Autokey dance:
1570 1.1 christos
1571 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1572 1.1 christos
1573 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>host</code>
1574 1.1 christos </td><td valign="top" width="20%">
1575 1.1 christos Autokey host name for this host
1576 1.1 christos
1577 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code>
1578 1.1 christos </td><td valign="top" width="20%">
1579 1.1 christos Autokey group name for this host
1580 1.1 christos
1581 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
1582 1.1 christos </td><td valign="top" width="20%">
1583 1.1 christos host flags (see Autokey specification)
1584 1.1 christos
1585 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>digest</code>
1586 1.1 christos </td><td valign="top" width="20%">
1587 1.1 christos OpenSSL message digest algorithm
1588 1.1 christos
1589 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code>
1590 1.1 christos </td><td valign="top" width="20%">
1591 1.1 christos OpenSSL digest/signature scheme
1592 1.1 christos
1593 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>update</code>
1594 1.1 christos </td><td valign="top" width="20%">
1595 1.1 christos NTP seconds at last signature update
1596 1.1 christos
1597 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>cert</code>
1598 1.1 christos </td><td valign="top" width="20%">
1599 1.1 christos certificate subject, issuer and certificate flags
1600 1.1 christos
1601 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>until</code>
1602 1.1 christos </td><td valign="top" width="20%">
1603 1.1 christos NTP seconds when the certificate expires
1604 1.1 christos
1605 1.1 christos <br></td></tr></table>
1606 1.1 christos
1607 1.1 christos <div class="node">
1608 1.1 christos <p><hr>
1609 1.1 christos <a name="Peer-Variables"></a>Next: <a rel="next" accesskey="n" href="#Clock-Variables">Clock Variables</a>,
1610 1.1 christos Previous: <a rel="previous" accesskey="p" href="#System-Variables">System Variables</a>,
1611 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1612 1.1 christos <br>
1613 1.1 christos </div>
1614 1.1 christos
1615 1.1 christos <!-- node-name, next, previous, up -->
1616 1.1 christos <h3 class="section">Peer Variables</h3>
1617 1.1 christos
1618 1.1 christos <p>The following peer variables appear in the <code>rv</code> billboard
1619 1.1 christos for each association.
1620 1.1 christos Not all variables are displayed in some configurations.
1621 1.1 christos
1622 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1623 1.1 christos
1624 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code>
1625 1.1 christos </td><td valign="top" width="20%">
1626 1.1 christos association ID
1627 1.1 christos
1628 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
1629 1.1 christos </td><td valign="top" width="20%">
1630 1.1 christos <a href="decode.html#peer">peer status word</a>
1631 1.1 christos
1632 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcadr</code>
1633 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>srcport</code>
1634 1.1 christos </td><td valign="top" width="20%">
1635 1.1 christos source (remote) IP address and port
1636 1.1 christos
1637 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstadr</code>
1638 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>dstport</code>
1639 1.1 christos </td><td valign="top" width="20%">
1640 1.1 christos destination (local) IP address and port
1641 1.1 christos
1642 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>leap</code>
1643 1.1 christos </td><td valign="top" width="20%">
1644 1.1 christos leap indicator (0-3)
1645 1.1 christos
1646 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
1647 1.1 christos </td><td valign="top" width="20%">
1648 1.1 christos stratum (0-15)
1649 1.1 christos
1650 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>precision</code>
1651 1.1 christos </td><td valign="top" width="20%">
1652 1.1 christos precision (log(2) s)
1653 1.1 christos
1654 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdelay</code>
1655 1.1 christos </td><td valign="top" width="20%">
1656 1.1 christos total roundtrip delay to the primary reference clock
1657 1.1 christos
1658 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>rootdisp</code>
1659 1.1 christos </td><td valign="top" width="20%">total root dispersion to the primary reference clock
1660 1.1 christos
1661 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
1662 1.1 christos </td><td valign="top" width="20%">
1663 1.1 christos reference ID or <a href="decode.html#kiss">kiss code</a>
1664 1.1 christos
1665 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reftime</code>
1666 1.1 christos </td><td valign="top" width="20%">
1667 1.1 christos reference time
1668 1.1 christos
1669 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>reach</code>
1670 1.1 christos </td><td valign="top" width="20%">
1671 1.1 christos reach register (octal)
1672 1.1 christos
1673 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>unreach</code>
1674 1.1 christos </td><td valign="top" width="20%">
1675 1.1 christos unreach counter
1676 1.1 christos
1677 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hmode</code>
1678 1.1 christos </td><td valign="top" width="20%">
1679 1.1 christos host mode (1-6)
1680 1.1 christos
1681 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>pmode</code>
1682 1.1 christos </td><td valign="top" width="20%">
1683 1.1 christos peer mode (1-5)
1684 1.1 christos
1685 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>hpoll</code>
1686 1.1 christos </td><td valign="top" width="20%">
1687 1.1 christos host poll exponent (log(2) s) (3-17)
1688 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>ppoll</code>
1689 1.1 christos </td><td valign="top" width="20%">
1690 1.1 christos peer poll exponent (log(2) s) (3-17)
1691 1.1 christos
1692 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>headway</code>
1693 1.1 christos </td><td valign="top" width="20%">
1694 1.1 christos headway (see <a href="rate.html">Rate Management and the Kiss-o'-Death Packet</a>)
1695 1.1 christos
1696 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flash</code>
1697 1.1 christos </td><td valign="top" width="20%">
1698 1.1 christos <a href="decode.html#flash">flash status word</a>
1699 1.1 christos
1700 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>offset</code>
1701 1.1 christos </td><td valign="top" width="20%">
1702 1.1 christos filter offset
1703 1.1 christos
1704 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>delay</code>
1705 1.1 christos </td><td valign="top" width="20%">
1706 1.1 christos filter delay
1707 1.1 christos
1708 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>dispersion</code>
1709 1.1 christos </td><td valign="top" width="20%">
1710 1.1 christos filter dispersion
1711 1.1 christos
1712 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>jitter</code>
1713 1.1 christos </td><td valign="top" width="20%">
1714 1.1 christos filter jitter
1715 1.1 christos
1716 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>ident</code>
1717 1.1 christos </td><td valign="top" width="20%">
1718 1.1 christos Autokey group name for this association
1719 1.1 christos
1720 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>bias</code>
1721 1.1 christos </td><td valign="top" width="20%">
1722 1.1 christos unicast/broadcast bias
1723 1.1 christos
1724 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>xleave</code>
1725 1.1 christos </td><td valign="top" width="20%">
1726 1.1 christos interleave delay (see <a href="xleave.html">NTP Interleaved Modes</a>)
1727 1.1 christos
1728 1.1 christos <br></td></tr></table>
1729 1.1 christos
1730 1.1 christos <p>The bias variable is calculated when the first broadcast packet is received
1731 1.1 christos after the calibration volley. It represents the offset of the broadcast
1732 1.1 christos subgraph relative to the unicast subgraph. The xleave variable appears
1733 1.1 christos only the interleaved symmetric and interleaved modes. It represents
1734 1.1 christos the internal queuing, buffering and transmission delays for the preceding
1735 1.1 christos packet.
1736 1.1 christos
1737 1.1 christos <p>When the NTPv4 daemon is compiled with the OpenSSL software library,
1738 1.1 christos additional peer variables are displayed, including the following:
1739 1.1 christos
1740 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1741 1.1 christos
1742 1.1 christos <p><br></th></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
1743 1.1 christos </td><td valign="top" width="20%">
1744 1.1 christos peer flags (see Autokey specification)
1745 1.1 christos
1746 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>host</code>
1747 1.1 christos </td><td valign="top" width="20%">
1748 1.1 christos Autokey server name
1749 1.1 christos
1750 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
1751 1.1 christos </td><td valign="top" width="20%">
1752 1.1 christos peer flags (see Autokey specification)
1753 1.1 christos
1754 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>signature</code>
1755 1.1 christos </td><td valign="top" width="20%">
1756 1.1 christos OpenSSL digest/signature scheme
1757 1.1 christos
1758 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initsequence</code>
1759 1.1 christos </td><td valign="top" width="20%">
1760 1.1 christos initial key ID
1761 1.1 christos
1762 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>initkey</code>
1763 1.1 christos </td><td valign="top" width="20%">
1764 1.1 christos initial key index
1765 1.1 christos
1766 1.1 christos <p><br></td></tr><tr align="left"><td valign="top" width="10%"><code>timestamp</code>
1767 1.1 christos </td><td valign="top" width="20%">
1768 1.1 christos Autokey signature timestamp
1769 1.1 christos
1770 1.1 christos <br></td></tr></table>
1771 1.1 christos
1772 1.1 christos <div class="node">
1773 1.1 christos <p><hr>
1774 1.1 christos <a name="Clock-Variables"></a>Previous: <a rel="previous" accesskey="p" href="#Peer-Variables">Peer Variables</a>,
1775 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a>
1776 1.1 christos <br>
1777 1.1 christos </div>
1778 1.1 christos
1779 1.1 christos <!-- node-name, next, previous, up -->
1780 1.1 christos <h3 class="section">Clock Variables</h3>
1781 1.1 christos
1782 1.1 christos <p>The following clock variables appear in the <code>cv</code> billboard for each association with a reference clock. Not all variables are displayed in some configurations.
1783 1.1 christos
1784 1.1 christos <p><table summary=""><tr align="left"><th valign="top" width="10%">Variable </th><th valign="top" width="20%">Description
1785 1.1 christos <br></th></tr><tr align="left"><td valign="top" width="10%"><code>associd</code>
1786 1.1 christos </td><td valign="top" width="20%">association ID
1787 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>status</code>
1788 1.1 christos </td><td valign="top" width="20%"><a href="decode.html#clock">clock status word</a>
1789 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>device</code>
1790 1.1 christos </td><td valign="top" width="20%">device description
1791 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>timecode</code>
1792 1.1 christos </td><td valign="top" width="20%">ASCII time code string (specific to device)
1793 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>poll</code>
1794 1.1 christos </td><td valign="top" width="20%">poll messages sent
1795 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>noreply</code>
1796 1.1 christos </td><td valign="top" width="20%">no reply
1797 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>badformat</code>
1798 1.1 christos </td><td valign="top" width="20%">bad format
1799 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>baddata</code>
1800 1.1 christos </td><td valign="top" width="20%">bad date or time
1801 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime1</code>
1802 1.1 christos </td><td valign="top" width="20%">fudge time 1
1803 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>fudgetime2</code>
1804 1.1 christos </td><td valign="top" width="20%">fudge time 2
1805 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>stratum</code>
1806 1.1 christos </td><td valign="top" width="20%">driver stratum
1807 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>refid</code>
1808 1.1 christos </td><td valign="top" width="20%">driver reference ID
1809 1.1 christos <br></td></tr><tr align="left"><td valign="top" width="10%"><code>flags</code>
1810 1.1 christos </td><td valign="top" width="20%">driver flags
1811 1.1 christos <br></td></tr></table>
1812 1.1 christos
1813 1.1 christos </body></html>
1814 1.1 christos
1815