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