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