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