ntpq.man.in revision 293650
155714Skris.de1 NOP 255714Skris. it 1 an-trap 355714Skris. if \\n[.$] \,\\$*\/ 455714Skris.. 555714Skris.ie t \ 655714Skris.ds B-Font [CB] 755714Skris.ds I-Font [CI] 8296341Sdelphij.ds R-Font [CR] 955714Skris.el \ 1055714Skris.ds B-Font B 1155714Skris.ds I-Font I 1255714Skris.ds R-Font R 1355714Skris.TH ntpq @NTPQ_MS@ "07 Jan 2016" "4.2.8p5" "User Commands" 1455714Skris.\" 15296341Sdelphij.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-4VaaKt/ag-eWa4It) 1655714Skris.\" 1755714Skris.\" It has been AutoGen-ed January 7, 2016 at 11:31:55 PM by AutoGen 5.18.5 1855714Skris.\" From the definitions ntpq-opts.def 1955714Skris.\" and the template file agman-cmd.tpl 2055714Skris.SH NAME 2155714Skris\f\*[B-Font]ntpq\fP 22296341Sdelphij\- standard NTP query program 2355714Skris.SH SYNOPSIS 2455714Skris\f\*[B-Font]ntpq\fP 2555714Skris.\" Mixture of short (flag) options and long options 2655714Skris[\f\*[B-Font]\-flags\f[]] 2755714Skris[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 2855714Skris[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 2955714Skris[ host ...] 3055714Skris.sp \n(Ppu 3155714Skris.ne 2 3255714Skris 3355714Skris.SH DESCRIPTION 3455714SkrisThe 3555714Skris\f\*[B-Font]ntpq\fP 3655714Skrisutility program is used to query NTP servers which 37296341Sdelphijimplement the standard NTP mode 6 control message formats defined 3855714Skrisin Appendix B of the NTPv3 specification RFC1305, requesting 3955714Skrisinformation about current state and/or changes in that state. 40296341SdelphijThe same formats are used in NTPv4, although some of the 4155714Skrisvariables have changed and new ones added. The description on this 4255714Skrispage is for the NTPv4 variables. 4355714SkrisThe program may be run either in interactive mode or controlled using 4455714Skriscommand line arguments. 4555714SkrisRequests to read and write arbitrary 4655714Skrisvariables can be assembled, with raw and pretty-printed output 4755714Skrisoptions being available. 4855714SkrisThe 4955714Skris\f\*[B-Font]ntpq\fP 5055714Skrisutility can also obtain and print a 5155714Skrislist of peers in a common format by sending multiple queries to the 52296341Sdelphijserver. 5355714SkrisIf one or more request options is included on the command line 5455714Skriswhen 5555714Skris\f\*[B-Font]ntpq\fP 5655714Skrisis executed, each of the requests will be sent 5755714Skristo the NTP servers running on each of the hosts given as command 58238405Sjkimline arguments, or on localhost by default. 59238405SjkimIf no request options 60238405Sjkimare given, 61238405Sjkim\f\*[B-Font]ntpq\fP 62238405Sjkimwill attempt to read commands from the 63238405Sjkimstandard input and execute these on the NTP server running on the 64238405Sjkimfirst host given on the command line, again defaulting to localhost 65238405Sjkimwhen no other host is specified. 66238405SjkimThe 67238405Sjkim\f\*[B-Font]ntpq\fP 68238405Sjkimutility will prompt for 69238405Sjkimcommands if the standard input is a terminal device. 70238405Sjkim\f\*[B-Font]ntpq\fP 71238405Sjkimuses NTP mode 6 packets to communicate with the 72238405SjkimNTP server, and hence can be used to query any compatible server on 73238405Sjkimthe network which permits it. 74238405SjkimNote that since NTP is a UDP protocol 75238405Sjkimthis communication will be somewhat unreliable, especially over 76238405Sjkimlarge distances in terms of network topology. 77238405SjkimThe 78238405Sjkim\f\*[B-Font]ntpq\fP 79238405Sjkimutility makes 80238405Sjkimone attempt to retransmit requests, and will time requests out if 81238405Sjkimthe remote host is not heard from within a suitable timeout 82238405Sjkimtime. 83238405SjkimSpecifying a 8455714Skriscommand line option other than 8555714Skris\f\*[B-Font]\-i\f[] 8655714Skrisor 87109998Smarkm\f\*[B-Font]\-n\f[] 8855714Skriswill 8955714Skriscause the specified query (queries) to be sent to the indicated 9059191Skrishost(s) immediately. 9155714SkrisOtherwise, 92296341Sdelphij\f\*[B-Font]ntpq\fP 93296341Sdelphijwill attempt to read 94296341Sdelphijinteractive format commands from the standard input. 95296341Sdelphij.SS "Internal Commands" 96296341SdelphijInteractive format commands consist of a keyword followed by zero 97296341Sdelphijto four arguments. 98296341SdelphijOnly enough characters of the full keyword to 99296341Sdelphijuniquely identify the command need be typed. 100296341SdelphijA 101109998Smarkmnumber of interactive format commands are executed entirely within 102296341Sdelphijthe 103296341Sdelphij\f\*[B-Font]ntpq\fP 104296341Sdelphijutility itself and do not result in NTP mode 6 105296341Sdelphijrequests being sent to a server. 106296341SdelphijThese are described following. 107194206Ssimon.TP 20 108296341Sdelphij.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command_keyword\f[]] 109296341Sdelphij.br 110296341Sdelphij.ns 111296341Sdelphij.TP 20 112238405Sjkim.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command_keyword\f[]] 113296341SdelphijA 114296341Sdelphij\[oq]\&?\[cq] 115296341Sdelphijby itself will print a list of all the command 116238405Sjkimkeywords known to this incarnation of 117296341Sdelphij\f\*[B-Font]ntpq\fP. 118296341SdelphijA 119296341Sdelphij\[oq]\&?\[cq] 12055714Skrisfollowed by a command keyword will print function and usage 12155714Skrisinformation about the command. 122296341SdelphijThis command is probably a better 12355714Skrissource of information about 124296341Sdelphij\f\*[B-Font]ntpq\fP 125296341Sdelphijthan this manual 126296341Sdelphijpage. 127194206Ssimon.br 128296341Sdelphij.ns 129296341Sdelphij.TP 20 130194206Ssimon.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]variable_name\f[][\f\*[B-Font]=value\f[]] \f\*[B-Font]...\f[] 131205128Ssimon.br 132296341Sdelphij.ns 133296341Sdelphij.TP 20 134205128Ssimon.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]variable_name\f[] \f\*[B-Font]...\f[] 135238405Sjkim.br 136296341Sdelphij.ns 137238405Sjkim.TP 20 138296341Sdelphij.NOP \f\*[B-Font]clearvars\f[] 139296341Sdelphij.br 140296341Sdelphij.ns 14155714Skris.TP 20 142296341Sdelphij.NOP \f\*[B-Font]showvars\f[] 143296341SdelphijThe data carried by NTP mode 6 messages consists of a list of 14455714Skrisitems of the form 145296341Sdelphij\[oq]variable_name=value\[cq], 146296341Sdelphijwhere the 147296341Sdelphij\[oq]=value\[cq] 148296341Sdelphijis ignored, and can be omitted, 149296341Sdelphijin requests to the server to read variables. 150296341SdelphijThe 151296341Sdelphij\f\*[B-Font]ntpq\fP 152296341Sdelphijutility maintains an internal list in which data to be included in control 153296341Sdelphijmessages can be assembled, and sent using the 154296341Sdelphij\f\*[B-Font]readlist\f[] 15555714Skrisand 156296341Sdelphij\f\*[B-Font]writelist\f[] 157296341Sdelphijcommands described below. 158296341SdelphijThe 159296341Sdelphij\f\*[B-Font]addvars\f[] 16055714Skriscommand allows variables and their optional values to be added to 161296341Sdelphijthe list. 162296341SdelphijIf more than one variable is to be added, the list should 16355714Skrisbe comma-separated and not contain white space. 164296341SdelphijThe 165296341Sdelphij\f\*[B-Font]rmvars\f[] 166296341Sdelphijcommand can be used to remove individual variables from the list, 167296341Sdelphijwhile the 168296341Sdelphij\f\*[B-Font]clearlist\f[] 169296341Sdelphijcommand removes all variables from the 170296341Sdelphijlist. 171296341SdelphijThe 172296341Sdelphij\f\*[B-Font]showvars\f[] 173296341Sdelphijcommand displays the current list of optional variables. 174296341Sdelphij.br 175296341Sdelphij.ns 176296341Sdelphij.TP 20 177296341Sdelphij.NOP \f\*[B-Font]authenticate\f[] [yes | no] 17855714SkrisNormally 179205128Ssimon\f\*[B-Font]ntpq\fP 180296341Sdelphijdoes not authenticate requests unless 181296341Sdelphijthey are write requests. 182296341SdelphijThe command 183296341Sdelphij\[oq]authenticate yes\[cq] 184296341Sdelphijcauses 185296341Sdelphij\f\*[B-Font]ntpq\fP 186205128Ssimonto send authentication with all requests it 187205128Ssimonmakes. 188296341SdelphijAuthenticated requests causes some servers to handle 189296341Sdelphijrequests slightly differently, and can occasionally melt the CPU in 190296341Sdelphijfuzzballs if you turn authentication on before doing a 19155714Skris\f\*[B-Font]peer\f[] 192296341Sdelphijdisplay. 193296341SdelphijThe command 194296341Sdelphij\[oq]authenticate\[cq] 19555714Skriscauses 196296341Sdelphij\f\*[B-Font]ntpq\fP 197296341Sdelphijto display whether or not 198296341Sdelphij\f\*[B-Font]ntpq\fP 19955714Skrisis currently autheinticating requests. 200296341Sdelphij.br 201296341Sdelphij.ns 202296341Sdelphij.TP 20 20355714Skris.NOP \f\*[B-Font]cooked\f[] 204109998SmarkmCauses output from query commands to be "cooked", so that 205296341Sdelphijvariables which are recognized by 206296341Sdelphij\f\*[B-Font]ntpq\fP 207296341Sdelphijwill have their 208296341Sdelphijvalues reformatted for human consumption. 209296341SdelphijVariables which 210296341Sdelphij\f\*[B-Font]ntpq\fP 211238405Sjkimthinks should have a decodable value but didn't are 212296341Sdelphijmarked with a trailing 213296341Sdelphij\[oq]\&?\[cq]. 214296341Sdelphij.br 215296341Sdelphij.ns 216296341Sdelphij.TP 20 217296341Sdelphij.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[] | \f\*[B-Font]less\f[] | \f\*[B-Font]off\f[]] 21855714SkrisWith no argument, displays the current debug level. 219296341SdelphijOtherwise, the debug level is changed to the indicated level. 220296341Sdelphij.br 221296341Sdelphij.ns 222296341Sdelphij.TP 20 223296341Sdelphij.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] 224296341SdelphijSpecify a time interval to be added to timestamps included in 22555714Skrisrequests which require authentication. 226296341SdelphijThis is used to enable 227296341Sdelphij(unreliable) server reconfiguration over long delay network paths 228296341Sdelphijor between machines whose clocks are unsynchronized. 229296341SdelphijActually the 230296341Sdelphijserver does not now require timestamps in authenticated requests, 231296341Sdelphijso this command may be obsolete. 232194206Ssimon.br 233296341Sdelphij.ns 234296341Sdelphij.TP 20 235296341Sdelphij.NOP \f\*[B-Font]exit\f[] 236296341SdelphijExit 237296341Sdelphij\f\*[B-Font]ntpq\fP. 238296341Sdelphij.br 239296341Sdelphij.ns 240296341Sdelphij.TP 20 241296341Sdelphij.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] 242296341SdelphijSet the host to which future queries will be sent. 243296341Sdelphij\f\*[I-Font]hostname\f[] 244296341Sdelphijmay be either a host name or a numeric address. 245296341Sdelphij.br 246296341Sdelphij.ns 247296341Sdelphij.TP 20 248296341Sdelphij.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] 249296341SdelphijIf 250296341Sdelphij\f\*[B-Font]yes\f[] 251238405Sjkimis specified, host names are printed in 252296341Sdelphijinformation displays. 253296341SdelphijIf 254296341Sdelphij\f\*[B-Font]no\f[] 255296341Sdelphijis specified, numeric 256296341Sdelphijaddresses are printed instead. 257296341SdelphijThe default is 258296341Sdelphij\f\*[B-Font]yes\f[], 259296341Sdelphijunless 260296341Sdelphijmodified using the command line 261296341Sdelphij\f\*[B-Font]\-n\f[] 262296341Sdelphijswitch. 263238405Sjkim.br 264296341Sdelphij.ns 265296341Sdelphij.TP 20 266296341Sdelphij.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] 267296341SdelphijThis command allows the specification of a key number to be 268296341Sdelphijused to authenticate configuration requests. 269296341SdelphijThis must correspond 270238405Sjkimto the 271296341Sdelphij\f\*[B-Font]controlkey\f[] 272296341Sdelphijkey number the server has been configured to use for this 273296341Sdelphijpurpose. 274296341Sdelphij.br 275296341Sdelphij.ns 276109998Smarkm.TP 20 277296341Sdelphij.NOP \f\*[B-Font]keytype\f[] [\f\*[B-Font]md5\f[] | \f\*[B-Font]OpenSSLDigestType\f[]] 278296341SdelphijSpecify the type of key to use for authenticating requests. 279296341Sdelphij\f\*[B-Font]md5\f[] 280296341Sdelphijis alway supported. 281296341SdelphijIf 282296341Sdelphij\f\*[B-Font]ntpq\fP 283296341Sdelphijwas built with OpenSSL support, 284296341Sdelphijany digest type supported by OpenSSL can also be provided. 285296341SdelphijIf no argument is given, the current 286296341Sdelphij\f\*[B-Font]keytype\f[] 287296341Sdelphijis displayed. 288296341Sdelphij.br 289296341Sdelphij.ns 290296341Sdelphij.TP 20 291296341Sdelphij.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[]] 29255714SkrisSets the NTP version number which 293194206Ssimon\f\*[B-Font]ntpq\fP 294296341Sdelphijclaims in 295296341Sdelphijpackets. 296296341SdelphijDefaults to 3, and note that mode 6 control messages (and 297296341Sdelphijmodes, for that matter) didn't exist in NTP version 1. 298296341SdelphijThere appear 299296341Sdelphijto be no servers left which demand version 1. 300296341SdelphijWith no argument, displays the current NTP version that will be used 301296341Sdelphijwhen communicating with servers. 302296341Sdelphij.br 303296341Sdelphij.ns 304296341Sdelphij.TP 20 305296341Sdelphij.NOP \f\*[B-Font]passwd\f[] 306296341SdelphijThis command prompts you to type in a password (which will not 307296341Sdelphijbe echoed) which will be used to authenticate configuration 308238405Sjkimrequests. 309296341SdelphijThe password must correspond to the key configured for 310296341Sdelphijuse by the NTP server for this purpose if such requests are to be 311296341Sdelphijsuccessful. 312296341Sdelphij.\" Not yet implemented. 313296341Sdelphij.\" .It Ic poll 314296341Sdelphij.\" .Op Ar n 315296341Sdelphij.\" .Op Ic verbose 316238405Sjkim.\" Poll an NTP server in client mode 317296341Sdelphij.\" .Ar n 318296341Sdelphij.\" times. 319296341Sdelphij.br 320296341Sdelphij.ns 321238405Sjkim.TP 20 322296341Sdelphij.NOP \f\*[B-Font]quit\f[] 32355714SkrisExit 324296341Sdelphij\f\*[B-Font]ntpq\fP. 325296341Sdelphij.br 326296341Sdelphij.ns 327296341Sdelphij.TP 20 328296341Sdelphij.NOP \f\*[B-Font]raw\f[] 329109998SmarkmCauses all output from query commands is printed as received 330296341Sdelphijfrom the remote server. 331296341SdelphijThe only formating/interpretation done on 332296341Sdelphijthe data is to transform nonascii data into a printable (but barely 333296341Sdelphijunderstandable) form. 334296341Sdelphij.br 335296341Sdelphij.ns 336296341Sdelphij.TP 20 337296341Sdelphij.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] 338296341SdelphijSpecify a timeout period for responses to server queries. 339296341SdelphijThe 340296341Sdelphijdefault is about 5000 milliseconds. 341296341SdelphijNote that since 342296341Sdelphij\f\*[B-Font]ntpq\fP 343296341Sdelphijretries each query once after a timeout, the total waiting time for 344296341Sdelphija timeout will be twice the timeout value set. 345194206Ssimon.br 346296341Sdelphij.ns 347296341Sdelphij.TP 20 348296341Sdelphij.NOP \f\*[B-Font]version\f[] 349296341SdelphijPrint the version of the 350238405Sjkim\f\*[B-Font]ntpq\fP 351296341Sdelphijprogram. 352296341Sdelphij.PP 353296341Sdelphij.SS "Control Message Commands" 354296341SdelphijAssociation IDs are used to identify system, peer and clock variables. 355296341SdelphijSystem variables are assigned an association ID of zero and system name space, while each association is assigned a nonzero association ID and peer namespace. 356296341SdelphijMost control commands send a single mode-6 message to the server and expect a single response message. 357296341SdelphijThe exceptions are the 358238405Sjkim\f[C]peers\f[] 359296341Sdelphijcommand, which sends a series of messages, 360296341Sdelphijand the 361296341Sdelphij\f[C]mreadlist\f[] 362296341Sdelphijand 363296341Sdelphij\f[C]mreadvar\f[] 364296341Sdelphijcommands, which iterate over a range of associations. 365296341Sdelphij.TP 10 366205128Ssimon.NOP \f\*[B-Font]associations\f[] 367296341SdelphijDisplay a list of mobilized associations in the form: 368296341Sdelphij.Dl ind assid status conf reach auth condition last_event cnt 369205128Ssimon.RS 370238405Sjkim.IP \fB\(bu\fP 2 371296341Sdelphij.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[] 372296341Sdelphij.IP \fB\(bu\fP 2 \f[C]assid\f[] \f[C]Ta\f[] \f[C]association\f[] \f[C]ID\f[] 373296341Sdelphij.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[] 374296341Sdelphij.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[] 375296341Sdelphij.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[] 376296341Sdelphij.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[] 37755714Skris.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[] 378160814Ssimon.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[] 379296341Sdelphij.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[] 380296341Sdelphij.RE 381296341Sdelphij.br 382296341Sdelphij.ns 383296341Sdelphij.TP 10 384296341Sdelphij.NOP \f\*[B-Font]authinfo\f[] 385296341SdelphijDisplay the authentication statistics. 38655714Skris.br 387296341Sdelphij.ns 388296341Sdelphij.TP 10 38955714Skris.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[]] [] ...] 390296341Sdelphij.br 391296341Sdelphij.ns 39255714Skris.TP 10 393296341Sdelphij.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[]] [] ...] 394296341SdelphijDisplay a list of clock variables for those associations supporting a reference clock. 395296341Sdelphij.br 396296341Sdelphij.ns 397296341Sdelphij.TP 10 398296341Sdelphij.NOP \f\*[B-Font]:config\f[] [...] 399296341SdelphijSend 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. 400296341Sdelphij.br 40155714Skris.ns 402296341Sdelphij.TP 10 403296341Sdelphij.NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[] 404296341SdelphijSend the each line of 405296341Sdelphij\f\*[I-Font]filename\f[] 406296341Sdelphijto 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. 407296341Sdelphij.br 408296341Sdelphij.ns 409296341Sdelphij.TP 10 410296341Sdelphij.NOP \f\*[B-Font]ifstats\f[] 41155714SkrisDisplay statistics for each local network address. Authentication is required. 412296341Sdelphij.br 413296341Sdelphij.ns 414296341Sdelphij.TP 10 415296341Sdelphij.NOP \f\*[B-Font]iostats\f[] 416296341SdelphijDisplay network and reference clock I/O statistics. 417296341Sdelphij.br 418296341Sdelphij.ns 419296341Sdelphij.TP 10 420296341Sdelphij.NOP \f\*[B-Font]kerninfo\f[] 421296341SdelphijDisplay 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. 422296341Sdelphij.br 423296341Sdelphij.ns 424296341Sdelphij.TP 10 425296341Sdelphij.NOP \f\*[B-Font]lassociations\f[] 426296341SdelphijPerform the same function as the associations command, except display mobilized and unmobilized associations. 427296341Sdelphij.br 428296341Sdelphij.ns 429296341Sdelphij.TP 10 430296341Sdelphij.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]] 431296341SdelphijObtain and print a list of all peers and clients showing 432296341Sdelphij\f\*[I-Font]dstadr\f[] 433296341Sdelphij(associated with any given IP version). 434296341Sdelphij.br 435296341Sdelphij.ns 436296341Sdelphij.TP 10 437296341Sdelphij.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]] 438296341SdelphijPrint a peer spreadsheet for the appropriate IP version(s). 43955714Skris\f\*[I-Font]dstadr\f[] 440296341Sdelphij(associated with any given IP version). 441296341Sdelphij.br 44255714Skris.ns 443296341Sdelphij.TP 10 444296341Sdelphij.NOP \f\*[B-Font]monstats\f[] 445296341SdelphijDisplay monitor facility statistics. 446296341Sdelphij.br 447296341Sdelphij.ns 44855714Skris.TP 10 449296341Sdelphij.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[]] 450296341SdelphijObtain and print traffic counts collected and maintained by the monitor facility. 451296341SdelphijWith the exception of 452296341Sdelphij\f\*[B-Font]sort\f[]=\f\*[I-Font]sortorder\f[], 45355714Skristhe options filter the list returned by 454296341Sdelphij\f\*[B-Font]ntpd.\f[] 455296341SdelphijThe 456296341Sdelphij\f\*[B-Font]limited\f[] 45755714Skrisand 458296341Sdelphij\f\*[B-Font]kod\f[] 459296341Sdelphijoptions return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response. 460296341SdelphijThe 461296341Sdelphij\f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[] 462296341Sdelphijoption filters entries representing less than 463296341Sdelphij\f\*[I-Font]count\f[] 464109998Smarkmpackets. 465296341SdelphijThe 466296341Sdelphij\f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[] 467109998Smarkmoption filters entries for packets received on any local address other than 468296341Sdelphij\f\*[I-Font]localaddr\f[]. 469296341Sdelphij\f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[] 470296341Sdelphijand 471296341Sdelphij\f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[] 472296341Sdelphijfilter entries containing none or less than all, respectively, of the bits in 473296341Sdelphij\f\*[I-Font]hexmask\f[], 474296341Sdelphijwhich must begin with 475296341Sdelphij\f\*[B-Font]0x\f[]. 476296341SdelphijThe 477296341Sdelphij\f\*[I-Font]sortorder\f[] 478296341Sdelphijdefaults to 479296341Sdelphij\f\*[B-Font]lstint\f[] 480296341Sdelphijand may be any of 481296341Sdelphij\f\*[B-Font]addr\f[], 482109998Smarkm\f\*[B-Font]count\f[], 483296341Sdelphij\f\*[B-Font]avgint\f[], 484296341Sdelphij\f\*[B-Font]lstint\f[], 485296341Sdelphijor any of those preceded by a minus sign (hyphen) to reverse the sort order. 486296341SdelphijThe output columns are: 487296341Sdelphij.RS 488296341Sdelphij.TP 10 489296341Sdelphij.NOP Column 490296341SdelphijDescription 491296341Sdelphij.br 49255714Skris.ns 493296341Sdelphij.TP 10 494296341Sdelphij.NOP \f\*[B-Font]lstint\f[] 495296341SdelphijInterval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by 496296341Sdelphij\f\*[B-Font]ntpq\fP. 497296341Sdelphij.br 498296341Sdelphij.ns 499296341Sdelphij.TP 10 500296341Sdelphij.NOP \f\*[B-Font]avgint\f[] 501296341SdelphijAverage interval in s between packets from this address. 50255714Skris.br 503296341Sdelphij.ns 504296341Sdelphij.TP 10 505296341Sdelphij.NOP \f\*[B-Font]rstr\f[] 506296341SdelphijRestriction flags associated with this address. 507296341SdelphijMost are copied unchanged from the matching 508296341Sdelphij\f\*[B-Font]restrict\f[] 509296341Sdelphijcommand, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response. 510296341Sdelphij.br 511296341Sdelphij.ns 51255714Skris.TP 10 513296341Sdelphij.NOP \f\*[B-Font]r\f[] 514296341SdelphijRate control indicator, either 515296341Sdelphija period, 516296341Sdelphij\f\*[B-Font]L\f[] 517296341Sdelphijor 51855714Skris\f\*[B-Font]K\f[] 519296341Sdelphijfor no rate control response, 520296341Sdelphijrate limiting by discarding, or rate limiting with a KoD response, respectively. 521296341Sdelphij.br 52255714Skris.ns 523296341Sdelphij.TP 10 524296341Sdelphij.NOP \f\*[B-Font]m\f[] 525296341SdelphijPacket mode. 526296341Sdelphij.br 527296341Sdelphij.ns 528296341Sdelphij.TP 10 529296341Sdelphij.NOP \f\*[B-Font]v\f[] 530296341SdelphijPacket version number. 531296341Sdelphij.br 532296341Sdelphij.ns 533296341Sdelphij.TP 10 534296341Sdelphij.NOP \f\*[B-Font]count\f[] 535296341SdelphijPackets received from this address. 536296341Sdelphij.br 53755714Skris.ns 538296341Sdelphij.TP 10 539296341Sdelphij.NOP \f\*[B-Font]rport\f[] 540296341SdelphijSource port of last packet from this address. 541296341Sdelphij.br 542296341Sdelphij.ns 543296341Sdelphij.TP 10 544296341Sdelphij.NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[] 545296341SdelphijDNS name, numeric address, or address followed by 546296341Sdelphijclaimed DNS name which could not be verified in parentheses. 54759191Skris.RE 548194206Ssimon.br 549296341Sdelphij.ns 550296341Sdelphij.TP 10 551296341Sdelphij.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[]]] ... 552296341Sdelphij.br 553296341Sdelphij.ns 554296341Sdelphij.TP 10 555296341Sdelphij.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[]]] ... 556296341SdelphijPerform the same function as the 557296341Sdelphij\f\*[B-Font]readvar\f[] 558296341Sdelphijcommand, except for a range of association IDs. 559296341SdelphijThis range is determined from the association list cached by the most recent 560238405Sjkim\f\*[B-Font]associations\f[] 561238405Sjkimcommand. 562296341Sdelphij.br 563296341Sdelphij.ns 564296341Sdelphij.TP 10 565296341Sdelphij.NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]] 566296341SdelphijObtain and print the old-style list of all peers and clients showing 567296341Sdelphij\f\*[I-Font]dstadr\f[] 568296341Sdelphij(associated with any given IP version), 569296341Sdelphijrather than the 570296341Sdelphij\f\*[I-Font]refid\f[]. 571296341Sdelphij.br 572238405Sjkim.ns 573296341Sdelphij.TP 10 574296341Sdelphij.NOP \f\*[B-Font]passociations\f[] 575296341SdelphijPerform the same function as the 576296341Sdelphij\f\*[B-Font]associations\f[] 577296341Sdelphijcommand, 578296341Sdelphijexcept that it uses previously stored data rather than making a new query. 579296341Sdelphij.br 580296341Sdelphij.ns 581296341Sdelphij.TP 10 582296341Sdelphij.NOP \f\*[B-Font]peers\f[] 583296341SdelphijDisplay a list of peers in the form: 584238405Sjkim.Dl [tally]remote refid st t when pool reach delay offset jitter 585238405Sjkim.RS 586296341Sdelphij.TP 10 587296341Sdelphij.NOP Variable 588296341SdelphijDescription 589296341Sdelphij.br 590296341Sdelphij.ns 591296341Sdelphij.TP 10 592296341Sdelphij.NOP \f\*[B-Font][tally]\f[] 593296341Sdelphijsingle-character code indicating current value of the 594296341Sdelphij\f\*[B-Font]select\f[] 595296341Sdelphijfield of the 596296341Sdelphij.Lk decode.html#peer "peer status word" 597296341Sdelphij.br 598296341Sdelphij.ns 599296341Sdelphij.TP 10 600296341Sdelphij.NOP \f\*[B-Font]remote\f[] 601296341Sdelphijhost name (or IP number) of peer. 602296341SdelphijThe value displayed will be truncated to 15 characters unless the 603296341Sdelphij\f\*[B-Font]\-w\f[] 604296341Sdelphijflag is given, in which case the full value will be displayed 605296341Sdelphijon the first line, 606296341Sdelphijand the remaining data is displayed on the next line. 607296341Sdelphij.br 608205128Ssimon.ns 609296341Sdelphij.TP 10 610296341Sdelphij.NOP \f\*[B-Font]refid\f[] 611296341Sdelphijassociation ID or 612296341Sdelphij.Lk decode.html#kiss "'kiss code" 613296341Sdelphij.br 614296341Sdelphij.ns 615296341Sdelphij.TP 10 616296341Sdelphij.NOP \f\*[B-Font]st\f[] 617205128Ssimonstratum 618194206Ssimon.br 619238405Sjkim.ns 620296341Sdelphij.TP 10 621296341Sdelphij.NOP \f\*[B-Font]t\f[] 622296341Sdelphij\f\*[B-Font]u\f[]: 623296341Sdelphijunicast or manycast client, 624296341Sdelphij\f\*[B-Font]b\f[]: 625296341Sdelphijbroadcast or multicast client, 626296341Sdelphij\f\*[B-Font]l\f[]: 627296341Sdelphijlocal (reference clock), 628296341Sdelphij\f\*[B-Font]s\f[]: 629296341Sdelphijsymmetric (peer), 630296341Sdelphij\f\*[B-Font]A\f[]: 631238405Sjkimmanycast server, 632296341Sdelphij\f\*[B-Font]B\f[]: 633296341Sdelphijbroadcast server, 634\f\*[B-Font]M\f[]: 635multicast server 636.br 637.ns 638.TP 10 639.NOP \f\*[B-Font]when\f[] 640sec/min/hr since last received packet 641.br 642.ns 643.TP 10 644.NOP \f\*[B-Font]poll\f[] 645poll interval (log2 s) 646.br 647.ns 648.TP 10 649.NOP \f\*[B-Font]reach\f[] 650reach shift register (octal) 651.br 652.ns 653.TP 10 654.NOP \f\*[B-Font]delay\f[] 655roundtrip delay 656.br 657.ns 658.TP 10 659.NOP \f\*[B-Font]offset\f[] 660offset of server relative to this host 661.br 662.ns 663.TP 10 664.NOP \f\*[B-Font]jitter\f[] 665jitter 666.RE 667.br 668.ns 669.TP 10 670.NOP \f\*[B-Font]apeers\f[] 671Display a list of peers in the form: 672.Dl [tally]remote refid assid st t when pool reach delay offset jitter 673where the output is just like the 674\f\*[B-Font]peers\f[] 675command except that the 676\f\*[B-Font]refid\f[] 677is displayed in hex format and the association number is also displayed. 678.br 679.ns 680.TP 10 681.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]assocID\f[] 682Show the statistics for the peer with the given 683\f\*[I-Font]assocID\f[]. 684.br 685.ns 686.TP 10 687.NOP \f\*[B-Font]readlist\f[] \f\*[I-Font]assocID\f[] 688.br 689.ns 690.TP 10 691.NOP \f\*[B-Font]rl\f[] \f\*[I-Font]assocID\f[] 692Read the system or peer variables included in the variable list. 693.br 694.ns 695.TP 10 696.NOP \f\*[B-Font]readvar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...] 697.br 698.ns 699.TP 10 700.NOP \f\*[B-Font]rv\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...] 701Display the specified variables. 702If 703\f\*[I-Font]assocID\f[] 704is zero, the variables are from the 705\fISystem\f[] \fIVariables\f[] 706name space, otherwise they are from the 707\fIPeer\f[] \fIVariables\f[] 708name space. 709The 710\f\*[I-Font]assocID\f[] 711is required, as the same name can occur in both spaces. 712If no 713\f\*[I-Font]name\f[] 714is included, all operative variables in the name space are displayed. 715In this case only, if the 716\f\*[I-Font]assocID\f[] 717is omitted, it is assumed zero. 718Multiple names are specified with comma separators and without whitespace. 719Note that time values are represented in milliseconds 720and frequency values in parts-per-million (PPM). 721Some NTP timestamps are represented in the format 722YYYYMMDDTTTT , 723where YYYY is the year, 724MM the month of year, 725DD the day of month and 726TTTT the time of day. 727.br 728.ns 729.TP 10 730.NOP \f\*[B-Font]reslist\f[] 731Show the access control (restrict) list for 732\f\*[B-Font]ntpq\fP. 733.br 734.ns 735.TP 10 736.NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[] 737Write the current configuration, 738including any runtime modifications given with 739\f\*[B-Font]:config\f[] 740or 741\f\*[B-Font]config-from-file\f[], 742to the ntpd host's file 743\f\*[I-Font]filename\f[]. 744This command will be rejected by the server unless 745.Lk miscopt.html#saveconfigdir "saveconfigdir" 746appears in the 747\f\*[B-Font]ntpd\f[] 748configuration file. 749\f\*[I-Font]filename\f[] 750can use 751\fCstrftime\f[]\fR()\f[] 752format specifies to substitute the current date and time, for example, 753\f\*[B-Font]q]saveconfig\f[] \f\*[B-Font]ntp-%Y%m%d-%H%M%S.confq]\f[]. 754The filename used is stored in system variable 755\f\*[B-Font]savedconfig\f[]. 756Authentication is required. 757.br 758.ns 759.TP 10 760.NOP \f\*[B-Font]timerstats\f[] 761Display interval timer counters. 762.br 763.ns 764.TP 10 765.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]assocID\f[] 766Write the system or peer variables included in the variable list. 767.br 768.ns 769.TP 10 770.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]assocID\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...] 771Write the specified variables. 772If the 773\f\*[I-Font]assocID\f[] 774is zero, the variables are from the 775\fISystem\f[] \fIVariables\f[] 776name space, otherwise they are from the 777\fIPeer\f[] \fIVariables\f[] 778name space. 779The 780\f\*[I-Font]assocID\f[] 781is required, as the same name can occur in both spaces. 782.br 783.ns 784.TP 10 785.NOP \f\*[B-Font]sysinfo\f[] 786Display operational summary. 787.br 788.ns 789.TP 10 790.NOP \f\*[B-Font]sysstats\f[] 791Print statistics counters maintained in the protocol module. 792.PP 793.SS Status Words and Kiss Codes 794The current state of the operating program is shown 795in a set of status words 796maintained by the system. 797Status information is also available on a per-association basis. 798These words are displayed in the 799\f\*[B-Font]rv\f[] 800and 801\f\*[B-Font]as\f[] 802commands both in hexadecimal and in decoded short tip strings. 803The codes, tips and short explanations are documented on the 804.Lk decode.html "Event Messages and Status Words" 805page. 806The page also includes a list of system and peer messages, 807the code for the latest of which is included in the status word. 808.sp \n(Ppu 809.ne 2 810 811Information resulting from protocol machine state transitions 812is displayed using an informal set of ASCII strings called 813.Lk decode.html#kiss "kiss codes" . 814The original purpose was for kiss-o'-death (KoD) packets 815sent by the server to advise the client of an unusual condition. 816They are now displayed, when appropriate, 817in the reference identifier field in various billboards. 818.SS System Variables 819The following system variables appear in the 820\f\*[B-Font]rv\f[] 821billboard. 822Not all variables are displayed in some configurations. 823.TP 10 824.NOP Variable 825Description 826.br 827.ns 828.TP 10 829.NOP \f\*[B-Font]status\f[] 830.Lk decode.html#sys "system status word" 831.br 832.ns 833.TP 10 834.NOP \f\*[B-Font]version\f[] 835NTP software version and build time 836.br 837.ns 838.TP 10 839.NOP \f\*[B-Font]processor\f[] 840hardware platform and version 841.br 842.ns 843.TP 10 844.NOP \f\*[B-Font]system\f[] 845operating system and version 846.br 847.ns 848.TP 10 849.NOP \f\*[B-Font]leap\f[] 850leap warning indicator (0-3) 851.br 852.ns 853.TP 10 854.NOP \f\*[B-Font]stratum\f[] 855stratum (1-15) 856.br 857.ns 858.TP 10 859.NOP \f\*[B-Font]precision\f[] 860precision (log2 s) 861.br 862.ns 863.TP 10 864.NOP \f\*[B-Font]rootdelay\f[] 865total roundtrip delay to the primary reference clock 866.br 867.ns 868.TP 10 869.NOP \f\*[B-Font]rootdisp\f[] 870total dispersion to the primary reference clock 871.br 872.ns 873.TP 10 874.NOP \f\*[B-Font]peer\f[] 875system peer association ID 876.br 877.ns 878.TP 10 879.NOP \f\*[B-Font]tc\f[] 880time constant and poll exponent (log2 s) (3-17) 881.br 882.ns 883.TP 10 884.NOP \f\*[B-Font]mintc\f[] 885minimum time constant (log2 s) (3-10) 886.br 887.ns 888.TP 10 889.NOP \f\*[B-Font]clock\f[] 890date and time of day 891.br 892.ns 893.TP 10 894.NOP \f\*[B-Font]refid\f[] 895reference ID or 896.Lk decode.html#kiss "kiss code" 897.br 898.ns 899.TP 10 900.NOP \f\*[B-Font]reftime\f[] 901reference time 902.br 903.ns 904.TP 10 905.NOP \f\*[B-Font]offset\f[] 906combined offset of server relative to this host 907.br 908.ns 909.TP 10 910.NOP \f\*[B-Font]sys_jitter\f[] 911combined system jitter 912.br 913.ns 914.TP 10 915.NOP \f\*[B-Font]frequency\f[] 916frequency offset (PPM) relative to hardware clock 917.br 918.ns 919.TP 10 920.NOP \f\*[B-Font]clk_wander\f[] 921clock frequency wander (PPM) 922.br 923.ns 924.TP 10 925.NOP \f\*[B-Font]clk_jitter\f[] 926clock jitter 927.br 928.ns 929.TP 10 930.NOP \f\*[B-Font]tai\f[] 931TAI-UTC offset (s) 932.br 933.ns 934.TP 10 935.NOP \f\*[B-Font]leapsec\f[] 936NTP seconds when the next leap second is/was inserted 937.br 938.ns 939.TP 10 940.NOP \f\*[B-Font]expire\f[] 941NTP seconds when the NIST leapseconds file expires 942.PP 943The jitter and wander statistics are exponentially-weighted RMS averages. 944The system jitter is defined in the NTPv4 specification; 945the clock jitter statistic is computed by the clock discipline module. 946.sp \n(Ppu 947.ne 2 948 949When the NTPv4 daemon is compiled with the OpenSSL software library, 950additional system variables are displayed, 951including some or all of the following, 952depending on the particular Autokey dance: 953.TP 10 954.NOP Variable 955Description 956.br 957.ns 958.TP 10 959.NOP \f\*[B-Font]host\f[] 960Autokey host name for this host 961.br 962.ns 963.TP 10 964.NOP \f\*[B-Font]ident\f[] 965Autokey group name for this host 966.br 967.ns 968.TP 10 969.NOP \f\*[B-Font]flags\f[] 970host flags (see Autokey specification) 971.br 972.ns 973.TP 10 974.NOP \f\*[B-Font]digest\f[] 975OpenSSL message digest algorithm 976.br 977.ns 978.TP 10 979.NOP \f\*[B-Font]signature\f[] 980OpenSSL digest/signature scheme 981.br 982.ns 983.TP 10 984.NOP \f\*[B-Font]update\f[] 985NTP seconds at last signature update 986.br 987.ns 988.TP 10 989.NOP \f\*[B-Font]cert\f[] 990certificate subject, issuer and certificate flags 991.br 992.ns 993.TP 10 994.NOP \f\*[B-Font]until\f[] 995NTP seconds when the certificate expires 996.PP 997.SS Peer Variables 998The following peer variables appear in the 999\f\*[B-Font]rv\f[] 1000billboard for each association. 1001Not all variables are displayed in some configurations. 1002.TP 10 1003.NOP Variable 1004Description 1005.br 1006.ns 1007.TP 10 1008.NOP \f\*[B-Font]associd\f[] 1009association ID 1010.br 1011.ns 1012.TP 10 1013.NOP \f\*[B-Font]status\f[] 1014.Lk decode.html#peer "peer status word" 1015.br 1016.ns 1017.TP 10 1018.NOP \f\*[B-Font]srcadr\f[] 1019source (remote) IP address 1020.br 1021.ns 1022.TP 10 1023.NOP \f\*[B-Font]srcport\f[] 1024source (remote) port 1025.br 1026.ns 1027.TP 10 1028.NOP \f\*[B-Font]dstadr\f[] 1029destination (local) IP address 1030.br 1031.ns 1032.TP 10 1033.NOP \f\*[B-Font]dstport\f[] 1034destination (local) port 1035.br 1036.ns 1037.TP 10 1038.NOP \f\*[B-Font]leap\f[] 1039leap indicator (0-3) 1040.br 1041.ns 1042.TP 10 1043.NOP \f\*[B-Font]stratum\f[] 1044stratum (0-15) 1045.br 1046.ns 1047.TP 10 1048.NOP \f\*[B-Font]precision\f[] 1049precision (log2 s) 1050.br 1051.ns 1052.TP 10 1053.NOP \f\*[B-Font]rootdelay\f[] 1054total roundtrip delay to the primary reference clock 1055.br 1056.ns 1057.TP 10 1058.NOP \f\*[B-Font]rootdisp\f[] 1059total root dispersion to the primary reference clock 1060.br 1061.ns 1062.TP 10 1063.NOP \f\*[B-Font]refid\f[] 1064reference ID or 1065.Lk decode.html#kiss "kiss code" 1066.br 1067.ns 1068.TP 10 1069.NOP \f\*[B-Font]reftime\f[] 1070reference time 1071.br 1072.ns 1073.TP 10 1074.NOP \f\*[B-Font]reach\f[] 1075reach register (octal) 1076.br 1077.ns 1078.TP 10 1079.NOP \f\*[B-Font]unreach\f[] 1080unreach counter 1081.br 1082.ns 1083.TP 10 1084.NOP \f\*[B-Font]hmode\f[] 1085host mode (1-6) 1086.br 1087.ns 1088.TP 10 1089.NOP \f\*[B-Font]pmode\f[] 1090peer mode (1-5) 1091.br 1092.ns 1093.TP 10 1094.NOP \f\*[B-Font]hpoll\f[] 1095host poll exponent (log2 s) (3-17) 1096.br 1097.ns 1098.TP 10 1099.NOP \f\*[B-Font]ppoll\f[] 1100peer poll exponent (log2 s) (3-17) 1101.br 1102.ns 1103.TP 10 1104.NOP \f\*[B-Font]headway\f[] 1105headway (see 1106.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" ) 1107.br 1108.ns 1109.TP 10 1110.NOP \f\*[B-Font]flash\f[] 1111.Lk decode.html#flash "flash status word" 1112.br 1113.ns 1114.TP 10 1115.NOP \f\*[B-Font]offset\f[] 1116filter offset 1117.br 1118.ns 1119.TP 10 1120.NOP \f\*[B-Font]delay\f[] 1121filter delay 1122.br 1123.ns 1124.TP 10 1125.NOP \f\*[B-Font]dispersion\f[] 1126filter dispersion 1127.br 1128.ns 1129.TP 10 1130.NOP \f\*[B-Font]jitter\f[] 1131filter jitter 1132.br 1133.ns 1134.TP 10 1135.NOP \f\*[B-Font]ident\f[] 1136Autokey group name for this association 1137.br 1138.ns 1139.TP 10 1140.NOP \f\*[B-Font]bias\f[] 1141unicast/broadcast bias 1142.br 1143.ns 1144.TP 10 1145.NOP \f\*[B-Font]xleave\f[] 1146interleave delay (see 1147.Lk xleave.html "NTP Interleaved Modes" ) 1148.PP 1149The 1150\f\*[B-Font]bias\f[] 1151variable is calculated when the first broadcast packet is received 1152after the calibration volley. 1153It represents the offset of the broadcast subgraph relative to the unicast subgraph. 1154The 1155\f\*[B-Font]xleave\f[] 1156variable appears only for the interleaved symmetric and interleaved modes. 1157It represents the internal queuing, buffering and transmission delays 1158for the preceding packet. 1159.sp \n(Ppu 1160.ne 2 1161 1162When the NTPv4 daemon is compiled with the OpenSSL software library, 1163additional peer variables are displayed, including the following: 1164.TP 10 1165.NOP Variable 1166Description 1167.br 1168.ns 1169.TP 10 1170.NOP \f\*[B-Font]flags\f[] 1171peer flags (see Autokey specification) 1172.br 1173.ns 1174.TP 10 1175.NOP \f\*[B-Font]host\f[] 1176Autokey server name 1177.br 1178.ns 1179.TP 10 1180.NOP \f\*[B-Font]flags\f[] 1181peer flags (see Autokey specification) 1182.br 1183.ns 1184.TP 10 1185.NOP \f\*[B-Font]signature\f[] 1186OpenSSL digest/signature scheme 1187.br 1188.ns 1189.TP 10 1190.NOP \f\*[B-Font]initsequence\f[] 1191initial key ID 1192.br 1193.ns 1194.TP 10 1195.NOP \f\*[B-Font]initkey\f[] 1196initial key index 1197.br 1198.ns 1199.TP 10 1200.NOP \f\*[B-Font]timestamp\f[] 1201Autokey signature timestamp 1202.PP 1203.SS Clock Variables 1204The following clock variables appear in the 1205\f\*[B-Font]cv\f[] 1206billboard for each association with a reference clock. 1207Not all variables are displayed in some configurations. 1208.TP 10 1209.NOP Variable 1210Description 1211.br 1212.ns 1213.TP 10 1214.NOP \f\*[B-Font]associd\f[] 1215association ID 1216.br 1217.ns 1218.TP 10 1219.NOP \f\*[B-Font]status\f[] 1220.Lk decode.html#clock "clock status word" 1221.br 1222.ns 1223.TP 10 1224.NOP \f\*[B-Font]device\f[] 1225device description 1226.br 1227.ns 1228.TP 10 1229.NOP \f\*[B-Font]timecode\f[] 1230ASCII time code string (specific to device) 1231.br 1232.ns 1233.TP 10 1234.NOP \f\*[B-Font]poll\f[] 1235poll messages sent 1236.br 1237.ns 1238.TP 10 1239.NOP \f\*[B-Font]noreply\f[] 1240no reply 1241.br 1242.ns 1243.TP 10 1244.NOP \f\*[B-Font]badformat\f[] 1245bad format 1246.br 1247.ns 1248.TP 10 1249.NOP \f\*[B-Font]baddata\f[] 1250bad date or time 1251.br 1252.ns 1253.TP 10 1254.NOP \f\*[B-Font]fudgetime1\f[] 1255fudge time 1 1256.br 1257.ns 1258.TP 10 1259.NOP \f\*[B-Font]fudgetime2\f[] 1260fudge time 2 1261.br 1262.ns 1263.TP 10 1264.NOP \f\*[B-Font]stratum\f[] 1265driver stratum 1266.br 1267.ns 1268.TP 10 1269.NOP \f\*[B-Font]refid\f[] 1270driver reference ID 1271.br 1272.ns 1273.TP 10 1274.NOP \f\*[B-Font]flags\f[] 1275driver flags 1276.PP 1277.SH "OPTIONS" 1278.TP 1279.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 1280Force IPv4 DNS name resolution. 1281This option must not appear in combination with any of the following options: 1282ipv6. 1283.sp 1284Force DNS resolution of following host names on the command line 1285to the IPv4 namespace. 1286.TP 1287.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 1288Force IPv6 DNS name resolution. 1289This option must not appear in combination with any of the following options: 1290ipv4. 1291.sp 1292Force DNS resolution of following host names on the command line 1293to the IPv6 namespace. 1294.TP 1295.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 1296run a command and exit. 1297This option may appear an unlimited number of times. 1298.sp 1299The following argument is interpreted as an interactive format command 1300and is added to the list of commands to be executed on the specified 1301host(s). 1302.TP 1303.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 1304Increase debug verbosity level. 1305This option may appear an unlimited number of times. 1306.sp 1307.TP 1308.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 1309Set the debug verbosity level. 1310This option may appear an unlimited number of times. 1311This option takes an integer number as its argument. 1312.sp 1313.TP 1314.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 1315Force ntpq to operate in interactive mode. 1316This option must not appear in combination with any of the following options: 1317command, peers. 1318.sp 1319Force \fBntpq\fP to operate in interactive mode. 1320Prompts will be written to the standard output and 1321commands read from the standard input. 1322.TP 1323.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 1324numeric host addresses. 1325.sp 1326Output all host addresses in dotted-quad numeric format rather than 1327converting to the canonical host names. 1328.TP 1329.NOP \f\*[B-Font]\-\-old\-rv\f[] 1330Always output status line with readvar. 1331.sp 1332By default, \fBntpq\fP now suppresses the \fBassocid=...\fP 1333line that precedes the output of \fBreadvar\fP 1334(alias \fBrv\fP) when a single variable is requested, such as 1335\fBntpq \-c "rv 0 offset"\fP. 1336This option causes \fBntpq\fP to include both lines of output 1337for a single-variable \fBreadvar\fP. 1338Using an environment variable to 1339preset this option in a script will enable both older and 1340newer \fBntpq\fP to behave identically in this regard. 1341.TP 1342.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 1343Print a list of the peers. 1344This option must not appear in combination with any of the following options: 1345interactive. 1346.sp 1347Print a list of the peers known to the server as well as a summary 1348of their state. This is equivalent to the 'peers' interactive command. 1349.TP 1350.NOP \f\*[B-Font]\-w\f[], \f\*[B-Font]\-\-wide\f[] 1351Display the full 'remote' value. 1352.sp 1353Display the full value of the 'remote' value. If this requires 1354more than 15 characters, display the full value, emit a newline, 1355and continue the data display properly indented on the next line. 1356.TP 1357.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 1358Display usage information and exit. 1359.TP 1360.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 1361Pass the extended usage information through a pager. 1362.TP 1363.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 1364Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP 1365configuration file listed in the \fBOPTION PRESETS\fP section, below. 1366The command will exit after updating the config file. 1367.TP 1368.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[] 1369Load options from \fIcfgfile\fP. 1370The \fIno-load-opts\fP form will disable the loading 1371of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 1372out of order. 1373.TP 1374.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 1375Output version of program and exit. The default mode is `v', a simple 1376version. The `c' mode will print copyright information and `n' will 1377print the full copyright notice. 1378.PP 1379.SH "OPTION PRESETS" 1380Any option that is not marked as \fInot presettable\fP may be preset 1381by loading values from configuration ("RC" or ".INI") file(s) and values from 1382environment variables named: 1383.nf 1384 \fBNTPQ_<option-name>\fP or \fBNTPQ\fP 1385.fi 1386.ad 1387The environmental presets take precedence (are processed later than) 1388the configuration files. 1389The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 1390If any of these are directories, then the file \fI.ntprc\fP 1391is searched for within those directories. 1392.SH "ENVIRONMENT" 1393See \fBOPTION PRESETS\fP for configuration environment variables. 1394.SH "FILES" 1395See \fBOPTION PRESETS\fP for configuration files. 1396.SH "EXIT STATUS" 1397One of the following exit values will be returned: 1398.TP 1399.NOP 0 " (EXIT_SUCCESS)" 1400Successful program execution. 1401.TP 1402.NOP 1 " (EXIT_FAILURE)" 1403The operation failed or the command syntax was not valid. 1404.TP 1405.NOP 66 " (EX_NOINPUT)" 1406A specified configuration file could not be loaded. 1407.TP 1408.NOP 70 " (EX_SOFTWARE)" 1409libopts had an internal operational error. Please report 1410it to autogen-users@lists.sourceforge.net. Thank you. 1411.PP 1412.SH "AUTHORS" 1413The University of Delaware and Network Time Foundation 1414.SH "COPYRIGHT" 1415Copyright (C) 1992-2015 The University of Delaware and Network Time Foundation all rights reserved. 1416This program is released under the terms of the NTP license, <http://ntp.org/license>. 1417.SH "BUGS" 1418Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org 1419.SH "NOTES" 1420This manual page was \fIAutoGen\fP-erated from the \fBntpq\fP 1421option definitions. 1422