13 .TH ntpq 1ntpqman "07 Apr 2015" "4.2.8p2" "User Commands"
15 .\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-SOays6/ag-4Oaqr6)
17 .\" It has been AutoGen-ed April 7, 2015 at 04:27:03 AM by AutoGen 5.18.5pre4
18 .\" From the definitions ntpq-opts.def
19 .\" and the template file agman-cmd.tpl
22 \- standard NTP query program
25 .\" Mixture of short (flag) options and long options
26 [\f\*[B-Font]\-flags\f[]]
27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
36 utility program is used to query NTP servers which
37 implement the standard NTP mode 6 control message formats defined
38 in Appendix B of the NTPv3 specification RFC1305, requesting
39 information about current state and/or changes in that state.
40 The same formats are used in NTPv4, although some of the
41 variables have changed and new ones added. The description on this
42 page is for the NTPv4 variables.
43 The program may be run either in interactive mode or controlled using
44 command line arguments.
45 Requests to read and write arbitrary
46 variables can be assembled, with raw and pretty-printed output
47 options being available.
50 utility can also obtain and print a
51 list of peers in a common format by sending multiple queries to the
53 If one or more request options is included on the command line
56 is executed, each of the requests will be sent
57 to the NTP servers running on each of the hosts given as command
58 line arguments, or on localhost by default.
62 will attempt to read commands from the
63 standard input and execute these on the NTP server running on the
64 first host given on the command line, again defaulting to localhost
65 when no other host is specified.
68 utility will prompt for
69 commands if the standard input is a terminal device.
71 uses NTP mode 6 packets to communicate with the
72 NTP server, and hence can be used to query any compatible server on
73 the network which permits it.
74 Note that since NTP is a UDP protocol
75 this communication will be somewhat unreliable, especially over
76 large distances in terms of network topology.
80 one attempt to retransmit requests, and will time requests out if
81 the remote host is not heard from within a suitable timeout
84 command line option other than
89 cause the specified query (queries) to be sent to the indicated
94 interactive format commands from the standard input.
95 .SS "Internal Commands"
96 Interactive format commands consist of a keyword followed by zero
98 Only enough characters of the full keyword to
99 uniquely identify the command need be typed.
101 number of interactive format commands are executed entirely within
104 utility itself and do not result in NTP mode 6
105 requests being sent to a server.
106 These are described following.
108 .NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command_keyword\f[]]
112 .NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command_keyword\f[]]
115 by itself will print a list of all the command
116 keywords known to this incarnation of
120 followed by a command keyword will print function and usage
121 information about the command.
122 This command is probably a better
123 source of information about
130 .NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]variable_name\f[][\f\*[B-Font]=value\f[]] \f\*[B-Font]...\f[]
134 .NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]variable_name\f[] \f\*[B-Font]...\f[]
138 .NOP \f\*[B-Font]clearvars\f[]
142 .NOP \f\*[B-Font]showvars\f[]
143 The data carried by NTP mode 6 messages consists of a list of
145 \[oq]variable_name=value\[cq],
148 is ignored, and can be omitted,
149 in requests to the server to read variables.
152 utility maintains an internal list in which data to be included in control
153 messages can be assembled, and sent using the
154 \f\*[B-Font]readlist\f[]
156 \f\*[B-Font]writelist\f[]
157 commands described below.
159 \f\*[B-Font]addvars\f[]
160 command allows variables and their optional values to be added to
162 If more than one variable is to be added, the list should
163 be comma-separated and not contain white space.
165 \f\*[B-Font]rmvars\f[]
166 command can be used to remove individual variables from the list,
168 \f\*[B-Font]clearlist\f[]
169 command removes all variables from the
172 \f\*[B-Font]showvars\f[]
173 command displays the current list of optional variables.
177 .NOP \f\*[B-Font]authenticate\f[] [yes | no]
180 does not authenticate requests unless
181 they are write requests.
183 \[oq]authenticate yes\[cq]
186 to send authentication with all requests it
188 Authenticated requests causes some servers to handle
189 requests slightly differently, and can occasionally melt the CPU in
190 fuzzballs if you turn authentication on before doing a
194 \[oq]authenticate\[cq]
197 to display whether or not
199 is currently autheinticating requests.
203 .NOP \f\*[B-Font]cooked\f[]
204 Causes output from query commands to be "cooked", so that
205 variables which are recognized by
208 values reformatted for human consumption.
211 thinks should have a decodable value but didn't are
212 marked with a trailing
217 .NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[] | \f\*[B-Font]less\f[] | \f\*[B-Font]off\f[]]
218 With no argument, displays the current debug level.
219 Otherwise, the debug level is changed to the indicated level.
223 .NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[]
224 Specify a time interval to be added to timestamps included in
225 requests which require authentication.
226 This is used to enable
227 (unreliable) server reconfiguration over long delay network paths
228 or between machines whose clocks are unsynchronized.
230 server does not now require timestamps in authenticated requests,
231 so this command may be obsolete.
235 .NOP \f\*[B-Font]exit\f[]
241 .NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[]
242 Set the host to which future queries will be sent.
243 \f\*[I-Font]hostname\f[]
244 may be either a host name or a numeric address.
248 .NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]]
251 is specified, host names are printed in
252 information displays.
255 is specified, numeric
256 addresses are printed instead.
260 modified using the command line
266 .NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[]
267 This command allows the specification of a key number to be
268 used to authenticate configuration requests.
270 to a key number the server has been configured to use for this
275 .NOP \f\*[B-Font]keytype\f[] [\f\*[B-Font]md5\f[] | \f\*[B-Font]OpenSSLDigestType\f[]]
276 Specify the type of key to use for authenticating requests.
281 was built with OpenSSL support,
282 any digest type supported by OpenSSL can also be provided.
283 If no argument is given, the current
284 \f\*[B-Font]keytype\f[]
289 .NOP \f\*[B-Font]ntpversion\f[] [\f\*[B-Font]1\f[] | \f\*[B-Font]2\f[] | \f\*[B-Font]3\f[] | \f\*[B-Font]4\f[]]
290 Sets the NTP version number which
294 Defaults to 3, and note that mode 6 control messages (and
295 modes, for that matter) didn't exist in NTP version 1.
297 to be no servers left which demand version 1.
298 With no argument, displays the current NTP version that will be used
299 when communicating with servers.
303 .NOP \f\*[B-Font]passwd\f[]
304 This command prompts you to type in a password (which will not
305 be echoed) which will be used to authenticate configuration
307 The password must correspond to the key configured for
308 use by the NTP server for this purpose if such requests are to be
310 .\" Not yet implemented.
314 .\" Poll an NTP server in client mode
320 .NOP \f\*[B-Font]quit\f[]
326 .NOP \f\*[B-Font]raw\f[]
327 Causes all output from query commands is printed as received
328 from the remote server.
329 The only formating/interpretation done on
330 the data is to transform nonascii data into a printable (but barely
331 understandable) form.
335 .NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[]
336 Specify a timeout period for responses to server queries.
338 default is about 5000 milliseconds.
341 retries each query once after a timeout, the total waiting time for
342 a timeout will be twice the timeout value set.
346 .NOP \f\*[B-Font]version\f[]
347 Print the version of the
351 .SS "Control Message Commands"
352 Association IDs are used to identify system, peer and clock variables.
353 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.
354 Most control commands send a single mode-6 message to the server and expect a single response message.
355 The exceptions are the
357 command, which sends a series of messages,
362 commands, which iterate over a range of associations.
364 .NOP \f\*[B-Font]associations\f[]
365 Display a list of mobilized associations in the form:
366 .Dl ind assid status conf reach auth condition last_event cnt
369 .IP \fB\(bu\fP 2 \f[C]ind\f[] \f[C]Ta\f[] \f[C]index\f[] \f[C]on\f[] \f[C]this\f[] \f[C]list\f[]
370 .IP \fB\(bu\fP 2 \f[C]assid\f[] \f[C]Ta\f[] \f[C]association\f[] \f[C]ID\f[]
371 .IP \fB\(bu\fP 2 \f[C]status\f[] \f[C]Ta\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word\f[]
372 .IP \fB\(bu\fP 2 \f[C]conf\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]persistent,\f[] \f[C]no\f[]: \f[C]ephemeral\f[]
373 .IP \fB\(bu\fP 2 \f[C]reach\f[] \f[C]Ta\f[] \f[C]yes\f[]: \f[C]reachable,\f[] \f[C]no\f[]: \f[C]unreachable\f[]
374 .IP \fB\(bu\fP 2 \f[C]auth\f[] \f[C]Ta\f[] \f[C]ok\f[], \f[C]yes\f[], \f[C]bad\f[] \f[C]and\f[] \f[C]none\f[]
375 .IP \fB\(bu\fP 2 \f[C]condition\f[] \f[C]Ta\f[] \f[C]selection\f[] \f[C]status\f[] \f[C](see\f[] \f[C]the\f[] \f[C]select\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
376 .IP \fB\(bu\fP 2 \f[C]last_event\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]report\f[] \f[C](see\f[] \f[C]the\f[] \f[C]event\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
377 .IP \fB\(bu\fP 2 \f[C]cnt\f[] \f[C]Ta\f[] \f[C]event\f[] \f[C]count\f[] \f[C](see\f[] \f[C]the\f[] \f[C]count\f[] \f[C]field\f[] \f[C]of\f[] \f[C]the\f[] \f[C]peer\f[] \f[C]status\f[] \f[C]word)\f[]
382 .NOP \f\*[B-Font]authinfo\f[]
383 Display the authentication statistics.
387 .NOP \f\*[B-Font]clockvar\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
391 .NOP \f\*[B-Font]cv\f[] \f\*[I-Font]assocID\f[] [\f\*[I-Font]name\f[][\f\*[B-Font]=\f[]\f\*[I-Font]value\f[]] [] ...]
392 Display a list of clock variables for those associations supporting a reference clock.
396 .NOP \f\*[B-Font]:config\f[] [...]
397 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.
401 .NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[]
402 Send the each line of
403 \f\*[I-Font]filename\f[]
404 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.
408 .NOP \f\*[B-Font]ifstats\f[]
409 Display statistics for each local network address. Authentication is required.
413 .NOP \f\*[B-Font]iostats\f[]
414 Display network and reference clock I/O statistics.
418 .NOP \f\*[B-Font]kerninfo\f[]
419 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.
423 .NOP \f\*[B-Font]lassociations\f[]
424 Perform the same function as the associations command, except display mobilized and unmobilized associations.
428 .NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
429 Obtain and print a list of all peers and clients showing
430 \f\*[I-Font]dstadr\f[]
431 (associated with any given IP version).
435 .NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
436 Print a peer spreadsheet for the appropriate IP version(s).
437 \f\*[I-Font]dstadr\f[]
438 (associated with any given IP version).
442 .NOP \f\*[B-Font]monstats\f[]
443 Display monitor facility statistics.
447 .NOP \f\*[B-Font]mrulist\f[] [\f\*[B-Font]limited\f[] | \f\*[B-Font]kod\f[] | \f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[] | \f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[] | \f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[] | \f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[] | \f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[]]
448 Obtain and print traffic counts collected and maintained by the monitor facility.
449 With the exception of
450 \f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[],
451 the options filter the list returned by
452 \f\*[B-Font]ntpd.\f[]
454 \f\*[B-Font]limited\f[]
457 options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
459 \f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[]
460 option filters entries representing less than
461 \f\*[I-Font]count\f[]
464 \f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[]
465 option filters entries for packets received on any local address other than
466 \f\*[I-Font]localaddr\f[].
467 \f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[]
469 \f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[]
470 filter entries containing none or less than all, respectively, of the bits in
471 \f\*[I-Font]hexmask\f[],
472 which must begin with
475 \f\*[I-Font]sortorder\f[]
477 \f\*[B-Font]lstint\f[]
479 \f\*[B-Font]addr\f[],
480 \f\*[B-Font]count\f[],
481 \f\*[B-Font]avgint\f[],
482 \f\*[B-Font]lstint\f[],
483 or any of those preceded by a minus sign (hyphen) to reverse the sort order.
484 The output columns are:
492 .NOP \f\*[B-Font]lstint\f[]
493 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
498 .NOP \f\*[B-Font]avgint\f[]
499 Average interval in s between packets from this address.
503 .NOP \f\*[B-Font]rstr\f[]
504 Restriction flags associated with this address.
505 Most are copied unchanged from the matching
506 \f\*[B-Font]restrict\f[]
507 command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
511 .NOP \f\*[B-Font]r\f[]
512 Rate control indicator, either
517 for no rate control response,
518 rate limiting by discarding, or rate limiting with a KoD response, respectively.
522 .NOP \f\*[B-Font]m\f[]
527 .NOP \f\*[B-Font]v\f[]
528 Packet version number.
532 .NOP \f\*[B-Font]count\f[]
533 Packets received from this address.
537 .NOP \f\*[B-Font]rport\f[]
538 Source port of last packet from this address.
542 .NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[]
543 DNS name, numeric address, or address followed by
544 claimed DNS name which could not be verified in parentheses.
549 .NOP \f\*[B-Font]mreadvar\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
553 .NOP \f\*[B-Font]mrv\f[] \f\*[B-Font]assocID\f[] \f\*[B-Font]assocID\f[] [\f\*[I-Font]variable_name\f[][=\f\*[I-Font]value\f[]]] ...
554 Perform the same function as the
555 \f\*[B-Font]readvar\f[]
556 command, except for a range of association IDs.
557 This range is determined from the association list cached by the most recent
558 \f\*[B-Font]associations\f[]
563 .NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]]
564 Obtain and print the old-style list of all peers and clients showing
565 \f\*[I-Font]dstadr\f[]
566 (associated with any given IP version),
568 \f\*[I-Font]refid\f[].
572 .NOP \f\*[B-Font]passociations\f[]
573 Perform the same function as the
574 \f\*[B-Font]associations\f[]
576 except that it uses previously stored data rather than making a new query.
580 .NOP \f\*[B-Font]peers\f[]
581 Display a list of peers in the form:
582 .Dl [tally]remote refid st t when pool reach delay offset jitter
590 .NOP \f\*[B-Font][tally]\f[]
591 single-character code indicating current value of the
592 \f\*[B-Font]select\f[]
594 .Lk decode.html#peer "peer status word"
598 .NOP \f\*[B-Font]remote\f[]
599 host name (or IP number) of peer.
600 The value displayed will be truncated to 15 characters unless the
602 flag is given, in which case the full value will be displayed
604 and the remaining data is displayed on the next line.
608 .NOP \f\*[B-Font]refid\f[]
610 .Lk decode.html#kiss "'kiss code"
614 .NOP \f\*[B-Font]st\f[]
619 .NOP \f\*[B-Font]t\f[]
621 unicast or manycast client,
623 broadcast or multicast client,
625 local (reference clock),
637 .NOP \f\*[B-Font]when\f[]
638 sec/min/hr since last received packet
642 .NOP \f\*[B-Font]poll\f[]
643 poll interval (log2 s)
647 .NOP \f\*[B-Font]reach\f[]
648 reach shift register (octal)
652 .NOP \f\*[B-Font]delay\f[]
657 .NOP \f\*[B-Font]offset\f[]
658 offset of server relative to this host
662 .NOP \f\*[B-Font]jitter\f[]
668 .NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]assocID\f[]
669 Show the statistics for the peer with the given
670 \f\*[I-Font]assocID\f[].
674 .NOP \f\*[B-Font]readlist\f[] \f\*[I-Font]assocID\f[]
678 .NOP \f\*[B-Font]rl\f[] \f\*[I-Font]assocID\f[]
679 Read the system or peer variables included in the variable list.
683 .NOP \f\*[B-Font]readvar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
687 .NOP \f\*[B-Font]rv\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]
688 Display the specified variables.
690 \f\*[I-Font]assocID\f[]
691 is zero, the variables are from the
692 \fISystem\f[] \fIVariables\f[]
693 name space, otherwise they are from the
694 \fIPeer\f[] \fIVariables\f[]
697 \f\*[I-Font]assocID\f[]
698 is required, as the same name can occur in both spaces.
701 is included, all operative variables in the name space are displayed.
702 In this case only, if the
703 \f\*[I-Font]assocID\f[]
704 is omitted, it is assumed zero.
705 Multiple names are specified with comma separators and without whitespace.
706 Note that time values are represented in milliseconds
707 and frequency values in parts-per-million (PPM).
708 Some NTP timestamps are represented in the format
710 where YYYY is the year,
711 MM the month of year,
712 DD the day of month and
713 TTTT the time of day.
717 .NOP \f\*[B-Font]reslist\f[]
718 Show the access control (restrict) list for
723 .NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[]
724 Write the current configuration,
725 including any runtime modifications given with
726 \f\*[B-Font]:config\f[]
728 \f\*[B-Font]config-from-file\f[],
729 to the ntpd host's file
730 \f\*[I-Font]filename\f[].
731 This command will be rejected by the server unless
732 .Lk miscopt.html#saveconfigdir "saveconfigdir"
736 \f\*[I-Font]filename\f[]
739 format specifies to substitute the current date and time, for example,
740 \f\*[B-Font]q]saveconfig\f[] \f\*[B-Font]ntp-%Y%m%d-%H%M%S.confq]\f[].
741 The filename used is stored in system variable
742 \f\*[B-Font]savedconfig\f[].
743 Authentication is required.
747 .NOP \f\*[B-Font]timerstats\f[]
748 Display interval timer counters.
752 .NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]assocID\f[]
753 Write the system or peer variables included in the variable list.
757 .NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...]
758 Write the specified variables.
760 \f\*[I-Font]assocID\f[]
761 is zero, the variables are from the
762 \fISystem\f[] \fIVariables\f[]
763 name space, otherwise they are from the
764 \fIPeer\f[] \fIVariables\f[]
767 \f\*[I-Font]assocID\f[]
768 is required, as the same name can occur in both spaces.
772 .NOP \f\*[B-Font]sysinfo\f[]
773 Display operational summary.
777 .NOP \f\*[B-Font]sysstats\f[]
778 Print statistics counters maintained in the protocol module.
780 .SS Status Words and Kiss Codes
781 The current state of the operating program is shown
782 in a set of status words
783 maintained by the system.
784 Status information is also available on a per-association basis.
785 These words are displayed in the
789 commands both in hexadecimal and in decoded short tip strings.
790 The codes, tips and short explanations are documented on the
791 .Lk decode.html "Event Messages and Status Words"
793 The page also includes a list of system and peer messages,
794 the code for the latest of which is included in the status word.
798 Information resulting from protocol machine state transitions
799 is displayed using an informal set of ASCII strings called
800 .Lk decode.html#kiss "kiss codes" .
801 The original purpose was for kiss-o'-death (KoD) packets
802 sent by the server to advise the client of an unusual condition.
803 They are now displayed, when appropriate,
804 in the reference identifier field in various billboards.
806 The following system variables appear in the
809 Not all variables are displayed in some configurations.
816 .NOP \f\*[B-Font]status\f[]
817 .Lk decode.html#sys "system status word"
821 .NOP \f\*[B-Font]version\f[]
822 NTP software version and build time
826 .NOP \f\*[B-Font]processor\f[]
827 hardware platform and version
831 .NOP \f\*[B-Font]system\f[]
832 operating system and version
836 .NOP \f\*[B-Font]leap\f[]
837 leap warning indicator (0-3)
841 .NOP \f\*[B-Font]stratum\f[]
846 .NOP \f\*[B-Font]precision\f[]
851 .NOP \f\*[B-Font]rootdelay\f[]
852 total roundtrip delay to the primary reference clock
856 .NOP \f\*[B-Font]rootdisp\f[]
857 total dispersion to the primary reference clock
861 .NOP \f\*[B-Font]peer\f[]
862 system peer association ID
866 .NOP \f\*[B-Font]tc\f[]
867 time constant and poll exponent (log2 s) (3-17)
871 .NOP \f\*[B-Font]mintc\f[]
872 minimum time constant (log2 s) (3-10)
876 .NOP \f\*[B-Font]clock\f[]
881 .NOP \f\*[B-Font]refid\f[]
883 .Lk decode.html#kiss "kiss code"
887 .NOP \f\*[B-Font]reftime\f[]
892 .NOP \f\*[B-Font]offset\f[]
893 combined offset of server relative to this host
897 .NOP \f\*[B-Font]sys_jitter\f[]
898 combined system jitter
902 .NOP \f\*[B-Font]frequency\f[]
903 frequency offset (PPM) relative to hardware clock
907 .NOP \f\*[B-Font]clk_wander\f[]
908 clock frequency wander (PPM)
912 .NOP \f\*[B-Font]clk_jitter\f[]
917 .NOP \f\*[B-Font]tai\f[]
922 .NOP \f\*[B-Font]leapsec\f[]
923 NTP seconds when the next leap second is/was inserted
927 .NOP \f\*[B-Font]expire\f[]
928 NTP seconds when the NIST leapseconds file expires
930 The jitter and wander statistics are exponentially-weighted RMS averages.
931 The system jitter is defined in the NTPv4 specification;
932 the clock jitter statistic is computed by the clock discipline module.
936 When the NTPv4 daemon is compiled with the OpenSSL software library,
937 additional system variables are displayed,
938 including some or all of the following,
939 depending on the particular Autokey dance:
946 .NOP \f\*[B-Font]host\f[]
947 Autokey host name for this host
951 .NOP \f\*[B-Font]ident\f[]
952 Autokey group name for this host
956 .NOP \f\*[B-Font]flags\f[]
957 host flags (see Autokey specification)
961 .NOP \f\*[B-Font]digest\f[]
962 OpenSSL message digest algorithm
966 .NOP \f\*[B-Font]signature\f[]
967 OpenSSL digest/signature scheme
971 .NOP \f\*[B-Font]update\f[]
972 NTP seconds at last signature update
976 .NOP \f\*[B-Font]cert\f[]
977 certificate subject, issuer and certificate flags
981 .NOP \f\*[B-Font]until\f[]
982 NTP seconds when the certificate expires
985 The following peer variables appear in the
987 billboard for each association.
988 Not all variables are displayed in some configurations.
995 .NOP \f\*[B-Font]associd\f[]
1000 .NOP \f\*[B-Font]status\f[]
1001 .Lk decode.html#peer "peer status word"
1005 .NOP \f\*[B-Font]srcadr\f[]
1006 source (remote) IP address
1010 .NOP \f\*[B-Font]srcport\f[]
1011 source (remote) port
1015 .NOP \f\*[B-Font]dstadr\f[]
1016 destination (local) IP address
1020 .NOP \f\*[B-Font]dstport\f[]
1021 destination (local) port
1025 .NOP \f\*[B-Font]leap\f[]
1026 leap indicator (0-3)
1030 .NOP \f\*[B-Font]stratum\f[]
1035 .NOP \f\*[B-Font]precision\f[]
1040 .NOP \f\*[B-Font]rootdelay\f[]
1041 total roundtrip delay to the primary reference clock
1045 .NOP \f\*[B-Font]rootdisp\f[]
1046 total root dispersion to the primary reference clock
1050 .NOP \f\*[B-Font]refid\f[]
1052 .Lk decode.html#kiss "kiss code"
1056 .NOP \f\*[B-Font]reftime\f[]
1061 .NOP \f\*[B-Font]reach\f[]
1062 reach register (octal)
1066 .NOP \f\*[B-Font]unreach\f[]
1071 .NOP \f\*[B-Font]hmode\f[]
1076 .NOP \f\*[B-Font]pmode\f[]
1081 .NOP \f\*[B-Font]hpoll\f[]
1082 host poll exponent (log2 s) (3-17)
1086 .NOP \f\*[B-Font]ppoll\f[]
1087 peer poll exponent (log2 s) (3-17)
1091 .NOP \f\*[B-Font]headway\f[]
1093 .Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
1097 .NOP \f\*[B-Font]flash\f[]
1098 .Lk decode.html#flash "flash status word"
1102 .NOP \f\*[B-Font]offset\f[]
1107 .NOP \f\*[B-Font]delay\f[]
1112 .NOP \f\*[B-Font]dispersion\f[]
1117 .NOP \f\*[B-Font]jitter\f[]
1122 .NOP \f\*[B-Font]ident\f[]
1123 Autokey group name for this association
1127 .NOP \f\*[B-Font]bias\f[]
1128 unicast/broadcast bias
1132 .NOP \f\*[B-Font]xleave\f[]
1133 interleave delay (see
1134 .Lk xleave.html "NTP Interleaved Modes" )
1137 \f\*[B-Font]bias\f[]
1138 variable is calculated when the first broadcast packet is received
1139 after the calibration volley.
1140 It represents the offset of the broadcast subgraph relative to the unicast subgraph.
1142 \f\*[B-Font]xleave\f[]
1143 variable appears only for the interleaved symmetric and interleaved modes.
1144 It represents the internal queuing, buffering and transmission delays
1145 for the preceding packet.
1149 When the NTPv4 daemon is compiled with the OpenSSL software library,
1150 additional peer variables are displayed, including the following:
1157 .NOP \f\*[B-Font]flags\f[]
1158 peer flags (see Autokey specification)
1162 .NOP \f\*[B-Font]host\f[]
1167 .NOP \f\*[B-Font]flags\f[]
1168 peer flags (see Autokey specification)
1172 .NOP \f\*[B-Font]signature\f[]
1173 OpenSSL digest/signature scheme
1177 .NOP \f\*[B-Font]initsequence\f[]
1182 .NOP \f\*[B-Font]initkey\f[]
1187 .NOP \f\*[B-Font]timestamp\f[]
1188 Autokey signature timestamp
1191 The following clock variables appear in the
1193 billboard for each association with a reference clock.
1194 Not all variables are displayed in some configurations.
1201 .NOP \f\*[B-Font]associd\f[]
1206 .NOP \f\*[B-Font]status\f[]
1207 .Lk decode.html#clock "clock status word"
1211 .NOP \f\*[B-Font]device\f[]
1216 .NOP \f\*[B-Font]timecode\f[]
1217 ASCII time code string (specific to device)
1221 .NOP \f\*[B-Font]poll\f[]
1226 .NOP \f\*[B-Font]noreply\f[]
1231 .NOP \f\*[B-Font]badformat\f[]
1236 .NOP \f\*[B-Font]baddata\f[]
1241 .NOP \f\*[B-Font]fudgetime1\f[]
1246 .NOP \f\*[B-Font]fudgetime2\f[]
1251 .NOP \f\*[B-Font]stratum\f[]
1256 .NOP \f\*[B-Font]refid\f[]
1261 .NOP \f\*[B-Font]flags\f[]
1266 .NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[]
1267 Force IPv4 DNS name resolution.
1268 This option must not appear in combination with any of the following options:
1271 Force DNS resolution of following host names on the command line
1272 to the IPv4 namespace.
1274 .NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[]
1275 Force IPv6 DNS name resolution.
1276 This option must not appear in combination with any of the following options:
1279 Force DNS resolution of following host names on the command line
1280 to the IPv6 namespace.
1282 .NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[]
1283 run a command and exit.
1284 This option may appear an unlimited number of times.
1286 The following argument is interpreted as an interactive format command
1287 and is added to the list of commands to be executed on the specified
1290 .NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[]
1291 Increase debug verbosity level.
1292 This option may appear an unlimited number of times.
1295 .NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[]
1296 Set the debug verbosity level.
1297 This option may appear an unlimited number of times.
1298 This option takes an integer number as its argument.
1301 .NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[]
1302 Force ntpq to operate in interactive mode.
1303 This option must not appear in combination with any of the following options:
1306 Force \fBntpq\fP to operate in interactive mode.
1307 Prompts will be written to the standard output and
1308 commands read from the standard input.
1310 .NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[]
1311 numeric host addresses.
1313 Output all host addresses in dotted-quad numeric format rather than
1314 converting to the canonical host names.
1316 .NOP \f\*[B-Font]\-\-old\-rv\f[]
1317 Always output status line with readvar.
1319 By default, \fBntpq\fP now suppresses the \fBassocid=...\fP
1320 line that precedes the output of \fBreadvar\fP
1321 (alias \fBrv\fP) when a single variable is requested, such as
1322 \fBntpq \-c "rv 0 offset"\fP.
1323 This option causes \fBntpq\fP to include both lines of output
1324 for a single-variable \fBreadvar\fP.
1325 Using an environment variable to
1326 preset this option in a script will enable both older and
1327 newer \fBntpq\fP to behave identically in this regard.
1329 .NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[]
1330 Print a list of the peers.
1331 This option must not appear in combination with any of the following options:
1334 Print a list of the peers known to the server as well as a summary
1335 of their state. This is equivalent to the 'peers' interactive command.
1337 .NOP \f\*[B-Font]\-w\f[], \f\*[B-Font]\-\-wide\f[]
1338 Display the full 'remote' value.
1340 Display the full value of the 'remote' value. If this requires
1341 more than 15 characters, display the full value, emit a newline,
1342 and continue the data display properly indented on the next line.
1344 .NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
1345 Display usage information and exit.
1347 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
1348 Pass the extended usage information through a pager.
1350 .NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
1351 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
1352 configuration file listed in the \fBOPTION PRESETS\fP section, below.
1353 The command will exit after updating the config file.
1355 .NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[]
1356 Load options from \fIcfgfile\fP.
1357 The \fIno-load-opts\fP form will disable the loading
1358 of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
1361 .NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]
1362 Output version of program and exit. The default mode is `v', a simple
1363 version. The `c' mode will print copyright information and `n' will
1364 print the full copyright notice.
1366 .SH "OPTION PRESETS"
1367 Any option that is not marked as \fInot presettable\fP may be preset
1368 by loading values from configuration ("RC" or ".INI") file(s) and values from
1369 environment variables named:
1371 \fBNTPQ_<option-name>\fP or \fBNTPQ\fP
1374 The environmental presets take precedence (are processed later than)
1375 the configuration files.
1376 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
1377 If any of these are directories, then the file \fI.ntprc\fP
1378 is searched for within those directories.
1380 See \fBOPTION PRESETS\fP for configuration environment variables.
1382 See \fBOPTION PRESETS\fP for configuration files.
1384 One of the following exit values will be returned:
1386 .NOP 0 " (EXIT_SUCCESS)"
1387 Successful program execution.
1389 .NOP 1 " (EXIT_FAILURE)"
1390 The operation failed or the command syntax was not valid.
1392 .NOP 66 " (EX_NOINPUT)"
1393 A specified configuration file could not be loaded.
1395 .NOP 70 " (EX_SOFTWARE)"
1396 libopts had an internal operational error. Please report
1397 it to autogen-users@lists.sourceforge.net. Thank you.
1400 The University of Delaware and Network Time Foundation
1402 Copyright (C) 1992-2015 The University of Delaware and Network Time Foundation all rights reserved.
1403 This program is released under the terms of the NTP license, <http://ntp.org/license>.
1405 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
1407 This manual page was \fIAutoGen\fP-erated from the \fBntpq\fP