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