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