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