]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/ntp/ntpq/ntpq-opts.def
MFV r282150
[FreeBSD/FreeBSD.git] / contrib / ntp / ntpq / ntpq-opts.def
1 /* -*- Mode: Text -*- */
2
3 autogen definitions options;
4
5 #include copyright.def
6 #include homerc.def
7 #include autogen-version.def
8
9 prog-name      = "ntpq";
10 prog-title     = "standard NTP query program";
11 argument       = '[ host ...]';
12
13 flag = {
14     name      = ipv4;
15     flags-cant = ipv6;
16     value     = 4;
17     descrip   = "Force IPv4 DNS name resolution";
18     doc = <<-  _EndOfDoc_
19         Force DNS resolution of following host names on the command line
20         to the IPv4 namespace.
21         _EndOfDoc_;
22 };
23
24 flag = {
25     name      = ipv6;
26     flags-cant = ipv4;
27     value     = 6;
28     descrip   = "Force IPv6 DNS name resolution";
29     doc = <<-  _EndOfDoc_
30         Force DNS resolution of following host names on the command line
31         to the IPv6 namespace.
32         _EndOfDoc_;
33 };
34
35 flag = {
36     name      = command;
37     value     = c;
38     arg-type  = string;
39     descrip   = "run a command and exit";
40     max       = NOLIMIT;
41     arg-name  = cmd;
42     call-proc = ntpq_custom_opt_handler;
43     doc = <<-  _EndOfDoc_
44         The following argument is interpreted as an interactive format command
45         and is added to the list of commands to be executed on the specified
46         host(s).
47         _EndOfDoc_;
48 };
49
50 #include debug-opt.def
51
52 flag = {
53     name      = interactive;
54     value     = i;
55     flags-cant = command, peers;
56     descrip   = "Force ntpq to operate in interactive mode";
57     doc = <<-  _EndOfDoc_
58         Force @code{ntpq} to operate in interactive mode.
59         Prompts will be written to the standard output and
60         commands read from the standard input.
61         _EndOfDoc_;
62 };
63
64 flag = {
65     name      = numeric;
66     value     = n;
67     descrip   = "numeric host addresses";
68     doc = <<-  _EndOfDoc_
69         Output all host addresses in dotted-quad numeric format rather than
70         converting to the canonical host names. 
71         _EndOfDoc_;
72 };
73
74 flag = {
75     name      = old-rv;
76     descrip   = "Always output status line with readvar";
77     doc = <<-  _EndOfDoc_
78         By default, @code{ntpq} now suppresses the @code{associd=...}
79         line that precedes the output of @code{readvar}
80         (alias @code{rv}) when a single variable is requested, such as
81         @code{ntpq -c "rv 0 offset"}.
82         This option causes @code{ntpq} to include both lines of output
83         for a single-variable @code{readvar}.
84         Using an environment variable to
85         preset this option in a script will enable both older and
86         newer @code{ntpq} to behave identically in this regard.
87         _EndOfDoc_;
88 };
89
90 flag = {
91     name      = peers;
92     value     = p;
93     descrip   = "Print a list of the peers";
94     flags-cant = interactive;
95     call-proc = ntpq_custom_opt_handler;
96     doc = <<-  _EndOfDoc_
97         Print a list of the peers known to the server as well as a summary
98         of their state. This is equivalent to the 'peers' interactive command.
99         _EndOfDoc_;
100 };
101
102 flag = {
103     name      = wide;
104     value     = w;
105     descrip   = "Display the full 'remote' value";
106     doc = <<-  _EndOfDoc_
107         Display the full value of the 'remote' value.  If this requires
108         more than 15 characters, display the full value, emit a newline,
109         and continue the data display properly indented on the next line.
110         _EndOfDoc_;
111 };
112
113 doc-section     = {
114   ds-type       = 'DESCRIPTION';
115   ds-format     = 'mdoc';
116   ds-text       = <<-  _END_PROG_MDOC_DESCRIP
117
118 The
119 .Nm
120 utility program is used to query NTP servers which
121 implement the standard NTP mode 6 control message formats defined
122 in Appendix B of the NTPv3 specification RFC1305, requesting
123 information about current state and/or changes in that state.
124 The same formats are used in NTPv4, although some of the
125 variables have changed and new ones added. The description on this
126 page is for the NTPv4 variables.
127 The program may be run either in interactive mode or controlled using
128 command line arguments.
129 Requests to read and write arbitrary
130 variables can be assembled, with raw and pretty-printed output
131 options being available.
132 The
133 .Nm
134 utility can also obtain and print a
135 list of peers in a common format by sending multiple queries to the
136 server.
137
138 If one or more request options is included on the command line
139 when
140 .Nm
141 is executed, each of the requests will be sent
142 to the NTP servers running on each of the hosts given as command
143 line arguments, or on localhost by default.
144 If no request options
145 are given,
146 .Nm
147 will attempt to read commands from the
148 standard input and execute these on the NTP server running on the
149 first host given on the command line, again defaulting to localhost
150 when no other host is specified.
151 The
152 .Nm
153 utility will prompt for
154 commands if the standard input is a terminal device.
155
156 .Nm
157 uses NTP mode 6 packets to communicate with the
158 NTP server, and hence can be used to query any compatible server on
159 the network which permits it.
160 Note that since NTP is a UDP protocol
161 this communication will be somewhat unreliable, especially over
162 large distances in terms of network topology.
163 The
164 .Nm
165 utility makes
166 one attempt to retransmit requests, and will time requests out if
167 the remote host is not heard from within a suitable timeout
168 time.
169
170 Specifying a
171 command line option other than
172 .Fl i
173 or
174 .Fl n
175 will
176 cause the specified query (queries) to be sent to the indicated
177 host(s) immediately.
178 Otherwise,
179 .Nm
180 will attempt to read
181 interactive format commands from the standard input.
182 .Ss "Internal Commands"
183 Interactive format commands consist of a keyword followed by zero
184 to four arguments.
185 Only enough characters of the full keyword to
186 uniquely identify the command need be typed.
187
188 A
189 number of interactive format commands are executed entirely within
190 the
191 .Nm
192 utility itself and do not result in NTP mode 6
193 requests being sent to a server.
194 These are described following.
195 .Bl -tag -width "? [command_keyword]" -compact -offset indent
196 .It Ic ? Op  Ar command_keyword
197 .It Ic help Op Ar command_keyword
198 A
199 .Ql \&?
200 by itself will print a list of all the command
201 keywords known to this incarnation of
202 .Nm .
203 A
204 .Ql \&?
205 followed by a command keyword will print function and usage
206 information about the command.
207 This command is probably a better
208 source of information about
209 .Nm
210 than this manual
211 page.
212 .It Ic addvars Ar variable_name Ns Xo Op Ic =value
213 .Ic ...
214 .Xc
215 .It Ic rmvars Ar variable_name Ic ...
216 .It Ic clearvars
217 .It Ic showvars
218 The data carried by NTP mode 6 messages consists of a list of
219 items of the form
220 .Ql variable_name=value ,
221 where the
222 .Ql =value
223 is ignored, and can be omitted,
224 in requests to the server to read variables.
225 The
226 .Nm
227 utility maintains an internal list in which data to be included in control
228 messages can be assembled, and sent using the
229 .Ic readlist
230 and
231 .Ic writelist
232 commands described below.
233 The
234 .Ic addvars
235 command allows variables and their optional values to be added to
236 the list.
237 If more than one variable is to be added, the list should
238 be comma-separated and not contain white space.
239 The
240 .Ic rmvars
241 command can be used to remove individual variables from the list,
242 while the
243 .Ic clearlist
244 command removes all variables from the
245 list.
246 The
247 .Ic showvars
248 command displays the current list of optional variables.
249 .It Ic authenticate Op yes | no
250 Normally
251 .Nm
252 does not authenticate requests unless
253 they are write requests.
254 The command
255 .Ql authenticate yes
256 causes
257 .Nm
258 to send authentication with all requests it
259 makes.
260 Authenticated requests causes some servers to handle
261 requests slightly differently, and can occasionally melt the CPU in
262 fuzzballs if you turn authentication on before doing a
263 .Ic peer
264 display.
265 The command
266 .Ql authenticate
267 causes
268 .Nm
269 to display whether or not
270 .Nm
271 is currently autheinticating requests.
272 .It Ic cooked
273 Causes output from query commands to be "cooked", so that
274 variables which are recognized by
275 .Nm
276 will have their
277 values reformatted for human consumption.
278 Variables which
279 .Nm
280 thinks should have a decodable value but didn't are
281 marked with a trailing
282 .Ql \&? .
283 .It Xo
284 .Ic debug
285 .Oo
286 .Cm more |
287 .Cm less |
288 .Cm off
289 .Oc
290 .Xc
291 With no argument, displays the current debug level.
292 Otherwise, the debug level is changed to the indicated level.
293 .It Ic delay Ar milliseconds
294 Specify a time interval to be added to timestamps included in
295 requests which require authentication.
296 This is used to enable
297 (unreliable) server reconfiguration over long delay network paths
298 or between machines whose clocks are unsynchronized.
299 Actually the
300 server does not now require timestamps in authenticated requests,
301 so this command may be obsolete.
302 .It Ic exit
303 Exit
304 .Nm .
305 .It Ic host Ar hostname
306 Set the host to which future queries will be sent.
307 .Ar hostname
308 may be either a host name or a numeric address.
309 .It Ic hostnames Op Cm yes | Cm no
310 If
311 .Cm yes
312 is specified, host names are printed in
313 information displays.
314 If
315 .Cm no
316 is specified, numeric
317 addresses are printed instead.
318 The default is
319 .Cm yes ,
320 unless
321 modified using the command line
322 .Fl n
323 switch.
324 .It Ic keyid Ar keyid
325 This command allows the specification of a key number to be
326 used to authenticate configuration requests.
327 This must correspond
328 to a key number the server has been configured to use for this
329 purpose.
330 .It Ic keytype Xo Oo
331 .Cm md5 |
332 .Cm OpenSSLDigestType
333 .Oc
334 .Xc
335 Specify the type of key to use for authenticating requests.
336 .Cm md5
337 is alway supported.
338 If
339 .Nm
340 was built with OpenSSL support,
341 any digest type supported by OpenSSL can also be provided.
342 If no argument is given, the current
343 .Ic keytype
344 is displayed.
345 .It Ic ntpversion Xo Oo
346 .Cm 1 |
347 .Cm 2 |
348 .Cm 3 |
349 .Cm 4
350 .Oc
351 .Xc
352 Sets the NTP version number which
353 .Nm
354 claims in
355 packets.
356 Defaults to 3, and note that mode 6 control messages (and
357 modes, for that matter) didn't exist in NTP version 1.
358 There appear
359 to be no servers left which demand version 1.
360 With no argument, displays the current NTP version that will be used
361 when communicating with servers.
362 .It Ic passwd
363 This command prompts you to type in a password (which will not
364 be echoed) which will be used to authenticate configuration
365 requests.
366 The password must correspond to the key configured for
367 use by the NTP server for this purpose if such requests are to be
368 successful.
369 .\" Not yet implemented.
370 .\" .It Ic poll
371 .\" .Op Ar n
372 .\" .Op Ic verbose
373 .\" Poll an NTP server in client mode
374 .\" .Ar n
375 .\" times.
376 .It Ic quit
377 Exit
378 .Nm .
379 .It Ic raw
380 Causes all output from query commands is printed as received
381 from the remote server.
382 The only formating/interpretation done on
383 the data is to transform nonascii data into a printable (but barely
384 understandable) form.
385 .It Ic timeout Ar milliseconds
386 Specify a timeout period for responses to server queries.
387 The
388 default is about 5000 milliseconds.
389 Note that since
390 .Nm
391 retries each query once after a timeout, the total waiting time for
392 a timeout will be twice the timeout value set.
393 .It Ic version
394 Print the version of the
395 .Nm
396 program.
397 .El
398
399 .Ss "Control Message Commands"
400 Association IDs are used to identify system, peer and clock variables.
401 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.
402 Most control commands send a single mode-6 message to the server and expect a single response message.
403 The exceptions are the
404 .Li peers
405 command, which sends a series of messages,
406 and the
407 .Li mreadlist
408 and
409 .Li mreadvar
410 commands, which iterate over a range of associations.
411 .Bl -tag -width "something" -compact -offset indent
412 .It Cm associations
413 Display a list of mobilized associations in the form:
414 .Dl ind assid status conf reach auth condition last_event cnt
415 .Bl -column -offset indent ".Sy Variable" ".Sy Description"
416 .It Sy String Ta Sy Description
417 .It Li ind Ta index on this list
418 .It Li assid Ta association ID
419 .It Li status Ta peer status word
420 .It Li conf Ta Li yes : persistent, Li no : ephemeral
421 .It Li reach Ta Li yes : reachable, Li no : unreachable
422 .It Li auth Ta Li ok , Li yes , Li bad and Li none
423 .It Li condition Ta selection status (see the Li select field of the peer status word)
424 .It Li last_event Ta event report (see the Li event field of the peer status word)
425 .It Li cnt Ta event count (see the Li count field of the peer status word)
426 .El
427 .It Cm authinfo
428 Display the authentication statistics.
429 .It Cm clockvar Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
430 .It Cm cv Ar assocID Oo Ar name Ns Oo Cm = Ns Ar value Oc Oc Op ...
431 Display a list of clock variables for those associations supporting a reference clock.
432 .It Cm :config Op ...
433 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.
434 .It Cm config-from-file Ar filename
435 Send the each line of
436 .Ar filename
437 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.
438 .It Ic ifstats
439 Display statistics for each local network address. Authentication is required.
440 .It Ic iostats
441 Display network and reference clock I/O statistics.
442 .It Ic kerninfo
443 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.
444 .It Ic lassociations
445 Perform the same function as the associations command, except display mobilized and unmobilized associations.
446 .It Ic lopeers Xo
447 .Oo Ic -4 |
448 .Ic -6
449 .Oc
450 .Xc
451 Obtain and print a list of all peers and clients showing
452 .Ar dstadr
453 (associated with any given IP version).
454 .It Ic lpeers Xo
455 .Oo Ic -4 |
456 .Ic -6
457 .Oc
458 .Xc
459 Print a peer spreadsheet for the appropriate IP version(s).
460 .Ar dstadr
461 (associated with any given IP version).
462 .It Ic monstats
463 Display monitor facility statistics.
464 .It Ic mrulist Oo Ic limited | Ic kod | Ic mincount Ns = Ns Ar count | Ic laddr Ns = Ns Ar localaddr | Ic sort Ns = Ns Ar sortorder | Ic resany Ns = Ns Ar hexmask | Ic resall Ns = Ns Ar hexmask Oc
465 Obtain and print traffic counts collected and maintained by the monitor facility.
466 With the exception of
467 .Cm sort Ns = Ns Ar sortorder ,
468 the options filter the list returned by
469 .Cm ntpd.
470 The
471 .Cm limited
472 and
473 .Cm kod
474 options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
475 The
476 .Cm mincount Ns = Ns Ar count
477 option filters entries representing less than
478 .Ar count
479 packets.
480 The
481 .Cm laddr Ns = Ns Ar localaddr
482 option filters entries for packets received on any local address other than
483 .Ar localaddr .
484 .Cm resany Ns = Ns Ar hexmask
485 and
486 .Cm resall Ns = Ns Ar hexmask
487 filter entries containing none or less than all, respectively, of the bits in
488 .Ar hexmask ,
489 which must begin with
490 .Cm 0x .
491 The
492 .Ar sortorder
493 defaults to
494 .Cm lstint
495 and may be any of
496 .Cm addr ,
497 .Cm count ,
498 .Cm avgint ,
499 .Cm lstint ,
500 or any of those preceded by a minus sign (hyphen) to reverse the sort order.
501 The output columns are:
502 .Bl -tag -width "something" -compact -offset indent
503 .It Column
504 Description
505 .It Ic lstint
506 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
507 .Nm .
508 .It Ic avgint
509 Average interval in s between packets from this address.
510 .It Ic rstr
511 Restriction flags associated with this address.
512 Most are copied unchanged from the matching
513 .Ic restrict
514 command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
515 .It Ic r
516 Rate control indicator, either
517 a period,
518 .Ic L
519 or
520 .Ic K
521 for no rate control response,
522 rate limiting by discarding, or rate limiting with a KoD response, respectively.
523 .It Ic m
524 Packet mode.
525 .It Ic v
526 Packet version number.
527 .It Ic count
528 Packets received from this address.
529 .It Ic rport
530 Source port of last packet from this address.
531 .It Ic remote address
532 DNS name, numeric address, or address followed by
533 claimed DNS name which could not be verified in parentheses.
534 .El
535 .It Ic mreadvar assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
536 .It Ic mrv assocID assocID Oo Ar variable_name Ns Oo = Ns Ar value Oc Oc ...
537 Perform the same function as the
538 .Ic readvar
539 command, except for a range of association IDs.
540 This range is determined from the association list cached by the most recent
541 .Ic associations
542 command.
543 .It Ic opeers Xo
544 .Oo Ic -4 |
545 .Ic -6
546 .Oc
547 .Xc
548 Obtain and print the old-style list of all peers and clients showing
549 .Ar dstadr
550 (associated with any given IP version),
551 rather than the
552 .Ar refid .
553 .It Ic passociations
554 Perform the same function as the
555 .Ic associations
556 command,
557 except that it uses previously stored data rather than making a new query.
558 .It Ic peers
559 Display a list of peers in the form:
560 .Dl [tally]remote refid st t when pool reach delay offset jitter
561 .Bl -tag -width "something" -compact -offset indent
562 .It Variable
563 Description
564 .It Ic [tally]
565 single-character code indicating current value of the
566 .Ic select
567 field of the
568 .Lk decode.html#peer "peer status word"
569 .It Ic remote
570 host name (or IP number) of peer.
571 The value displayed will be truncated to 15 characters  unless the
572 .Fl w
573 flag is given, in which case the full value will be displayed
574 on the first line,
575 and the remaining data is displayed on the next line.
576 .It Ic refid
577 association ID or
578 .Lk decode.html#kiss "'kiss code"
579 .It Ic st
580 stratum
581 .It Ic t
582 .Ic u :
583 unicast or manycast client,
584 .Ic b :
585 broadcast or multicast client,
586 .Ic l :
587 local (reference clock),
588 .Ic s :
589 symmetric (peer),
590 .Ic A :
591 manycast server,
592 .Ic B :
593 broadcast server,
594 .Ic M :
595 multicast server
596 .It Ic when
597 sec/min/hr since last received packet
598 .It Ic poll
599 poll interval (log2 s)
600 .It Ic reach
601 reach shift register (octal)
602 .It Ic delay
603 roundtrip delay
604 .It Ic offset
605 offset of server relative to this host
606 .It Ic jitter
607 jitter
608 .El
609 .It Ic pstats Ar assocID
610 Show the statistics for the peer with the given
611 .Ar assocID .
612 .It Ic readlist Ar assocID
613 .It Ic rl Ar assocID
614 Read the system or peer variables included in the variable list.
615 .It Ic readvar Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc  Oo , ... Oc
616 .It Ic rv Ar assocID Ar name Ns Oo Ns = Ns Ar value Oc  Oo , ... Oc
617 Display the specified variables.
618 If
619 .Ar assocID
620 is zero, the variables are from the
621 .Sx System Variables
622 name space, otherwise they are from the
623 .Sx Peer Variables
624 name space.
625 The
626 .Ar assocID
627 is required, as the same name can occur in both spaces.
628 If no
629 .Ar name
630 is included, all operative variables in the name space are displayed.
631
632 In this case only, if the
633 .Ar assocID
634 is omitted, it is assumed zero.
635 Multiple names are specified with comma separators and without whitespace.
636 Note that time values are represented in milliseconds
637 and frequency values in parts-per-million (PPM).
638 Some NTP timestamps are represented in the format
639 YYYYMMDDTTTT ,
640 where YYYY is the year,
641 MM the month of year,
642 DD the day of month and
643 TTTT the time of day.
644 .It Ic reslist
645 Show the access control (restrict) list for
646 .Nm .
647
648 .It Ic saveconfig Ar filename
649 Write the current configuration,
650 including any runtime modifications given with
651 .Ic :config
652 or
653 .Ic config-from-file ,
654 to the ntpd host's file
655 .Ar filename .
656 This command will be rejected by the server unless
657 .Lk miscopt.html#saveconfigdir "saveconfigdir"
658 appears in the
659 .Ic ntpd
660 configuration file.
661 .Ar filename
662 can use
663 .Xr strftime
664 format specifies to substitute the current date and time, for example,
665 .Ic q]saveconfig ntp-%Y%m%d-%H%M%S.confq] .
666 The filename used is stored in system variable
667 .Ic savedconfig .
668 Authentication is required.
669 .It Ic timerstats
670 Display interval timer counters.
671 .It Ic writelist Ar assocID
672 Write the system or peer variables included in the variable list.
673 .It Ic writevar Ar assocID Ar name Ns = Ns Ar value Op , ...
674 Write the specified variables.
675 If the
676 .Ar assocID
677 is zero, the variables are from the
678 .Sx System Variables
679 name space, otherwise they are from the
680 .Sx Peer Variables
681 name space.
682 The
683 .Ar assocID
684 is required, as the same name can occur in both spaces.
685 .It Ic sysinfo
686 Display operational summary.
687 .It Ic sysstats
688 Print statistics counters maintained in the protocol module.
689 .El
690
691 .Ss Status Words and Kiss Codes
692
693 The current state of the operating program is shown
694 in a set of status words
695 maintained by the system.
696 Status information is also available on a per-association basis.
697 These words are displayed in the
698 .Ic rv
699 and
700 .Ic as
701 commands both in hexadecimal and in decoded short tip strings.
702 The codes, tips and short explanations are documented on the
703 .Lk decode.html "Event Messages and Status Words"
704 page.
705 The page also includes a list of system and peer messages,
706 the code for the latest of which is included in the status word.
707 .Pp
708 Information resulting from protocol machine state transitions
709 is displayed using an informal set of ASCII strings called
710 .Lk decode.html#kiss "kiss codes" .
711 The original purpose was for kiss-o'-death (KoD) packets
712 sent by the server to advise the client of an unusual condition.
713 They are now displayed, when appropriate,
714 in the reference identifier field in various billboards.
715
716 .Ss System Variables
717 The following system variables appear in the
718 .Ic rv
719 billboard.
720 Not all variables are displayed in some configurations.
721 .Bl -tag -width "something" -compact -offset indent
722 .It Variable
723 Description
724 .It Ic status
725 .Lk decode.html#sys "system status word"
726 .It Ic version
727 NTP software version and build time
728 .It Ic processor
729 hardware platform and version
730 .It Ic system
731 operating system and version
732 .It Ic leap
733 leap warning indicator (0-3)
734 .It Ic stratum
735 stratum (1-15)
736 .It Ic precision
737 precision (log2 s)
738 .It Ic rootdelay
739 total roundtrip delay to the primary reference clock
740 .It Ic rootdisp
741 total dispersion to the primary reference clock
742 .It Ic peer
743 system peer association ID
744 .It Ic tc
745 time constant and poll exponent (log2 s) (3-17)
746 .It Ic mintc
747 minimum time constant (log2 s) (3-10)
748 .It Ic clock
749 date and time of day
750 .It Ic refid
751 reference ID or
752 .Lk decode.html#kiss "kiss code"
753 .It Ic reftime
754 reference time
755 .It Ic offset
756 combined  offset of server relative to this host
757 .It Ic sys_jitter
758 combined system jitter
759 .It Ic frequency
760 frequency offset (PPM) relative to hardware clock
761 .It Ic clk_wander
762 clock frequency wander (PPM)
763 .It Ic clk_jitter
764 clock jitter
765 .It Ic tai
766 TAI-UTC offset (s)
767 .It Ic leapsec
768 NTP seconds when the next leap second is/was inserted
769 .It Ic expire
770 NTP seconds when the NIST leapseconds file expires
771 .El
772 The jitter and wander statistics are exponentially-weighted RMS averages.
773 The system jitter is defined in the NTPv4 specification;
774 the clock jitter statistic is computed by the clock discipline module.
775 .Pp
776 When the NTPv4 daemon is compiled with the OpenSSL software library,
777 additional system variables are displayed,
778 including some or all of the following,
779 depending on the particular Autokey dance:
780
781 .Bl -tag -width "something" -compact -offset indent
782 .It Variable
783 Description
784 .It Ic host
785 Autokey host name for this host
786 .It Ic ident
787 Autokey group name for this host
788 .It Ic flags
789 host flags  (see Autokey specification)
790 .It Ic digest
791 OpenSSL message digest algorithm
792 .It Ic signature
793 OpenSSL digest/signature scheme
794 .It Ic update
795 NTP seconds at last signature update
796 .It Ic cert
797 certificate subject, issuer and certificate flags
798 .It Ic until
799 NTP seconds when the certificate expires
800 .El
801 .Ss Peer Variables
802 The following peer variables appear in the
803 .Ic rv
804 billboard for each association.
805 Not all variables are displayed in some configurations.
806
807 .Bl -tag -width "something" -compact -offset indent
808 .It Variable
809 Description
810 .It Ic associd
811 association ID
812 .It Ic status
813 .Lk decode.html#peer "peer status word"
814 .It Ic srcadr
815 source (remote) IP address
816 .It Ic srcport
817 source (remote) port
818 .It Ic dstadr
819 destination (local) IP address
820 .It Ic dstport
821 destination (local) port
822 .It Ic leap
823 leap indicator (0-3)
824 .It Ic stratum
825 stratum (0-15)
826 .It Ic precision
827 precision (log2 s)
828 .It Ic rootdelay
829 total roundtrip delay to the primary reference clock
830 .It Ic rootdisp
831 total root dispersion to the primary reference clock
832 .It Ic refid
833 reference ID or
834 .Lk decode.html#kiss "kiss code"
835 .It Ic reftime
836 reference time
837 .It Ic reach
838 reach register (octal)
839 .It Ic unreach
840 unreach counter
841 .It Ic hmode
842 host mode (1-6)
843 .It Ic pmode
844 peer mode (1-5)
845 .It Ic hpoll
846 host poll exponent (log2 s) (3-17)
847 .It Ic ppoll
848 peer poll exponent (log2 s) (3-17)
849 .It Ic headway
850 headway (see
851 .Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
852 .It Ic flash
853 .Lk decode.html#flash "flash status word"
854 .It Ic offset
855 filter offset
856 .It Ic delay
857 filter delay
858 .It Ic dispersion
859 filter dispersion
860 .It Ic jitter
861 filter jitter
862 .It Ic ident
863 Autokey group name for this association
864 .It Ic bias
865 unicast/broadcast bias
866 .It Ic xleave
867 interleave delay (see
868 .Lk xleave.html "NTP Interleaved Modes" )
869 .El
870 The
871 .Ic bias
872 variable is calculated when the first broadcast packet is received
873 after the calibration volley.
874 It represents the offset of the broadcast subgraph relative to the unicast subgraph.
875 The
876 .Ic xleave
877 variable appears only for the interleaved symmetric and interleaved modes.
878 It represents the internal queuing, buffering and transmission delays
879 for the preceding packet.
880 .Pp
881 When the NTPv4 daemon is compiled with the OpenSSL software library,
882 additional peer variables are displayed, including the following:
883 .Bl -tag -width "something" -compact -offset indent
884 .It Variable
885 Description
886 .It Ic flags
887 peer flags (see Autokey specification)
888 .It Ic host
889 Autokey server name
890 .It Ic flags
891 peer flags (see Autokey specification)
892 .It Ic signature
893 OpenSSL digest/signature scheme
894 .It Ic initsequence
895 initial key ID
896 .It Ic initkey
897 initial key index
898 .It Ic timestamp
899 Autokey signature timestamp
900 .El
901
902 .Ss Clock Variables
903 The following clock variables appear in the
904 .Ic cv
905 billboard for each association with a reference clock.
906 Not all variables are displayed in some configurations.
907 .Bl -tag -width "something" -compact -offset indent
908 .It Variable
909 Description
910 .It Ic associd
911 association ID
912 .It Ic status
913 .Lk decode.html#clock "clock status word"
914 .It Ic device
915 device description
916 .It Ic timecode
917 ASCII time code string (specific to device)
918 .It Ic poll
919 poll messages sent
920 .It Ic noreply
921 no reply
922 .It Ic badformat
923 bad format
924 .It Ic baddata
925 bad date or time
926 .It Ic fudgetime1
927 fudge time 1
928 .It Ic fudgetime2
929 fudge time 2
930 .It Ic stratum
931 driver stratum
932 .It Ic refid
933 driver reference ID
934 .It Ic flags
935 driver flags
936 .El
937         _END_PROG_MDOC_DESCRIP;
938 };