ntpq.1ntpqman revision 338530
1218912Slstewart.de1 NOP 2218912Slstewart. it 1 an-trap 3218912Slstewart. if \\n[.$] \,\\$*\/ 4218912Slstewart.. 5218912Slstewart.ie t \ 6218912Slstewart.ds B-Font [CB] 7220560Slstewart.ds I-Font [CI] 8220560Slstewart.ds R-Font [CR] 9218912Slstewart.el \ 10218912Slstewart.ds B-Font B 11218912Slstewart.ds I-Font I 12218912Slstewart.ds R-Font R 13218912Slstewart.TH ntpq 1ntpqman "14 Aug 2018" "4.2.8p12" "User Commands" 14218912Slstewart.\" 15218912Slstewart.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-_XaWRE/ag-lYaOQE) 16218912Slstewart.\" 17218912Slstewart.\" It has been AutoGen-ed August 14, 2018 at 08:29:58 AM by AutoGen 5.18.5 18218912Slstewart.\" From the definitions ntpq-opts.def 19218912Slstewart.\" and the template file agman-cmd.tpl 20218912Slstewart.SH NAME 21218912Slstewart\f\*[B-Font]ntpq\fP 22218912Slstewart\- standard NTP query program 23218912Slstewart.SH SYNOPSIS 24218912Slstewart\f\*[B-Font]ntpq\fP 25218912Slstewart.\" Mixture of short (flag) options and long options 26218912Slstewart[\f\*[B-Font]\-flags\f[]] 27218912Slstewart[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 28218912Slstewart[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 29218912Slstewart[ host ...] 30218912Slstewart.sp \n(Ppu 31218912Slstewart.ne 2 32218912Slstewart 33218912Slstewart.SH DESCRIPTION 34225583Slstewart.sp \n(Ppu 35225583Slstewart.ne 2 36218912Slstewart 37218912SlstewartThe 38225583Slstewart\f\*[B-Font]ntpq\fP 39218912Slstewartutility program is used to query NTP servers to monitor NTP operations 40218912Slstewartand performance, requesting 41218912Slstewartinformation about current state and/or changes in that state. 42218912SlstewartThe program may be run either in interactive mode or controlled using 43218912Slstewartcommand line arguments. 44218912SlstewartRequests to read and write arbitrary 45218912Slstewartvariables can be assembled, with raw and pretty-printed output 46218912Slstewartoptions being available. 47218912SlstewartThe 48218912Slstewart\f\*[B-Font]ntpq\fP 49218912Slstewartutility can also obtain and print a 50218912Slstewartlist of peers in a common format by sending multiple queries to the 51218912Slstewartserver. 52218912Slstewart.sp \n(Ppu 53218912Slstewart.ne 2 54218912Slstewart 55218912SlstewartIf one or more request options is included on the command line 56225583Slstewartwhen 57218912Slstewart\f\*[B-Font]ntpq\fP 58218912Slstewartis executed, each of the requests will be sent 59218912Slstewartto the NTP servers running on each of the hosts given as command 60218912Slstewartline arguments, or on localhost by default. 61218912SlstewartIf no request options 62218912Slstewartare given, 63218912Slstewart\f\*[B-Font]ntpq\fP 64218912Slstewartwill attempt to read commands from the 65218912Slstewartstandard input and execute these on the NTP server running on the 66218912Slstewartfirst host given on the command line, again defaulting to localhost 67218912Slstewartwhen no other host is specified. 68218912SlstewartThe 69218912Slstewart\f\*[B-Font]ntpq\fP 70218912Slstewartutility will prompt for 71218912Slstewartcommands if the standard input is a terminal device. 72218912Slstewart.sp \n(Ppu 73218912Slstewart.ne 2 74218912Slstewart 75218912Slstewart\f\*[B-Font]ntpq\fP 76218912Slstewartuses NTP mode 6 packets to communicate with the 77218912SlstewartNTP server, and hence can be used to query any compatible server on 78218912Slstewartthe network which permits it. 79218912SlstewartNote that since NTP is a UDP protocol 80218912Slstewartthis communication will be somewhat unreliable, especially over 81218912Slstewartlarge distances in terms of network topology. 82218912SlstewartThe 83218912Slstewart\f\*[B-Font]ntpq\fP 84218912Slstewartutility makes 85218912Slstewartone attempt to retransmit requests, and will time requests out if 86218912Slstewartthe remote host is not heard from within a suitable timeout 87218912Slstewarttime. 88218912Slstewart.sp \n(Ppu 89218912Slstewart.ne 2 90218912Slstewart 91218912SlstewartNote that in contexts where a host name is expected, a 92218912Slstewart\f\*[B-Font]\-4\f[] 93218912Slstewartqualifier preceding the host name forces resolution to the IPv4 94218912Slstewartnamespace, while a 95218912Slstewart\f\*[B-Font]\-6\f[] 96218912Slstewartqualifier forces resolution to the IPv6 namespace. 97218912SlstewartFor examples and usage, see the 98218912Slstewart\*[Lq]NTP Debugging Techniques\*[Rq] 99218912Slstewartpage. 100218912Slstewart.sp \n(Ppu 101218912Slstewart.ne 2 102218912Slstewart 103218912SlstewartSpecifying a 104218912Slstewartcommand line option other than 105218912Slstewart\f\*[B-Font]\-i\f[] 106218912Slstewartor 107218912Slstewart\f\*[B-Font]\-n\f[] 108218912Slstewartwill 109218912Slstewartcause the specified query (queries) to be sent to the indicated 110218912Slstewarthost(s) immediately. 111218912SlstewartOtherwise, 112218912Slstewart\f\*[B-Font]ntpq\fP 113218912Slstewartwill attempt to read 114218912Slstewartinteractive format commands from the standard input. 115218912Slstewart.SS "Internal Commands" 116218912Slstewart.sp \n(Ppu 117218912Slstewart.ne 2 118218912Slstewart 119218912SlstewartInteractive format commands consist of a keyword followed by zero 120218912Slstewartto four arguments. 121218912SlstewartOnly enough characters of the full keyword to 122218912Slstewartuniquely identify the command need be typed. 123218912Slstewart.sp \n(Ppu 124218912Slstewart.ne 2 125218912Slstewart 126218912SlstewartA 127218912Slstewartnumber of interactive format commands are executed entirely within 128218912Slstewartthe 129218912Slstewart\f\*[B-Font]ntpq\fP 130218912Slstewartutility itself and do not result in NTP 131218912Slstewartrequests being sent to a server. 132218912SlstewartThese are described following. 133218912Slstewart.TP 15 134218912Slstewart.NOP \f\*[B-Font]?\f[] [\f\*[I-Font]command\f[]] 135218912Slstewart.br 136218912Slstewart.ns 137218912Slstewart.TP 15 138218912Slstewart.NOP \f\*[B-Font]help\f[] [\f\*[I-Font]command\f[]] 139218912SlstewartA 140218912Slstewart\[oq]\&?\[cq] 141218912Slstewartby itself will print a list of all the commands 142218912Slstewartknown to 143218912Slstewart\f\*[B-Font]ntpq\fP. 144218912SlstewartA 145218912Slstewart\[oq]\&?\[cq] 146218912Slstewartfollowed by a command name will print function and usage 147218912Slstewartinformation about the command. 148218912Slstewart.br 149218912Slstewart.ns 150218912Slstewart.TP 15 151218912Slstewart.NOP \f\*[B-Font]addvars\f[] \f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][,...] 152218912Slstewart.br 153218912Slstewart.ns 154218912Slstewart.TP 15 155218912Slstewart.NOP \f\*[B-Font]rmvars\f[] \f\*[I-Font]name\f[][,...] 156218912Slstewart.br 157218912Slstewart.ns 158218912Slstewart.TP 15 159218912Slstewart.NOP \f\*[B-Font]clearvars\f[] 160218912Slstewart.br 161218912Slstewart.ns 162218912Slstewart.TP 15 163218912Slstewart.NOP \f\*[B-Font]showvars\f[] 164218912SlstewartThe arguments to this command consist of a list of 165218912Slstewartitems of the form 166218912Slstewart\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]], 167218912Slstewartwhere the 168218912Slstewart.NOP \&=\f\*[I-Font]value\f[] 169218912Slstewartis ignored, and can be omitted, 170218912Slstewartin requests to the server to read variables. 171218912SlstewartThe 172218912Slstewart\f\*[B-Font]ntpq\fP 173218912Slstewartutility maintains an internal list in which data to be included in 174218912Slstewartmessages can be assembled, and displayed or set using the 175218912Slstewart\f\*[B-Font]readlist\f[] 176218912Slstewartand 177218912Slstewart\f\*[B-Font]writelist\f[] 178218912Slstewartcommands described below. 179218912SlstewartThe 180218912Slstewart\f\*[B-Font]addvars\f[] 181218912Slstewartcommand allows variables and their optional values to be added to 182218912Slstewartthe list. 183218912SlstewartIf more than one variable is to be added, the list should 184218912Slstewartbe comma-separated and not contain white space. 185218912SlstewartThe 186218912Slstewart\f\*[B-Font]rmvars\f[] 187218912Slstewartcommand can be used to remove individual variables from the list, 188218912Slstewartwhile the 189218912Slstewart\f\*[B-Font]clearvars\f[] 190218912Slstewartcommand removes all variables from the 191218912Slstewartlist. 192218912SlstewartThe 193218912Slstewart\f\*[B-Font]showvars\f[] 194218912Slstewartcommand displays the current list of optional variables. 195218912Slstewart.br 196218912Slstewart.ns 197218912Slstewart.TP 15 198218912Slstewart.NOP \f\*[B-Font]authenticate\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]] 199218912SlstewartNormally 200218912Slstewart\f\*[B-Font]ntpq\fP 201218912Slstewartdoes not authenticate requests unless 202218912Slstewartthey are write requests. 203218912SlstewartThe command 204218912Slstewart\f\*[B-Font]authenticate\f[] \f\*[B-Font]yes\f[] 205218912Slstewartcauses 206218912Slstewart\f\*[B-Font]ntpq\fP 207218912Slstewartto send authentication with all requests it 208218912Slstewartmakes. 209218912SlstewartAuthenticated requests causes some servers to handle 210218912Slstewartrequests slightly differently. 211218912SlstewartThe command 212218912Slstewart\f\*[B-Font]authenticate\f[] 213218912Slstewartcauses 214218912Slstewart\f\*[B-Font]ntpq\fP 215218912Slstewartto display whether or not 216218912Slstewartit is currently authenticating requests. 217218912Slstewart.br 218218912Slstewart.ns 219218912Slstewart.TP 15 220218912Slstewart.NOP \f\*[B-Font]cooked\f[] 221218912SlstewartCauses output from query commands to be "cooked", so that 222218912Slstewartvariables which are recognized by 223218912Slstewart\f\*[B-Font]ntpq\fP 224218912Slstewartwill have their 225218912Slstewartvalues reformatted for human consumption. 226218912SlstewartVariables which 227218912Slstewart\f\*[B-Font]ntpq\fP 228218912Slstewartcould not decode completely are 229218912Slstewartmarked with a trailing 230218912Slstewart\[oq]\&?\[cq]. 231218912Slstewart.br 232218912Slstewart.ns 233218912Slstewart.TP 15 234218912Slstewart.NOP \f\*[B-Font]debug\f[] [\f\*[B-Font]more\f[]|\f\*[B-Font]less\f[]|\f\*[B-Font]off\f[]] 235218912SlstewartWith no argument, displays the current debug level. 236218912SlstewartOtherwise, the debugging level is changed as indicated. 237218912Slstewart.br 238218912Slstewart.ns 239218912Slstewart.TP 15 240218912Slstewart.NOP \f\*[B-Font]delay\f[] [\f\*[I-Font]milliseconds\f[]] 241218912SlstewartSpecify a time interval to be added to timestamps included in 242218912Slstewartrequests which require authentication. 243218912SlstewartThis is used to enable 244218912Slstewart(unreliable) server reconfiguration over long delay network paths 245218912Slstewartor between machines whose clocks are unsynchronized. 246218912SlstewartActually the 247218912Slstewartserver does not now require timestamps in authenticated requests, 248218912Slstewartso this command may be obsolete. 249218912SlstewartWithout any arguments, displays the current delay. 250218912Slstewart.br 251218912Slstewart.ns 252218912Slstewart.TP 15 253218912Slstewart.NOP \f\*[B-Font]drefid\f[] [\f\*[B-Font]hash\f[]|\f\*[B-Font]ipv4\f[]] 254218912SlstewartDisplay refids as IPv4 or hash. 255218912SlstewartWithout any arguments, displays whether refids are shown as IPv4 256218912Slstewartaddresses or hashes. 257218912Slstewart.br 258218912Slstewart.ns 259218912Slstewart.TP 15 260218912Slstewart.NOP \f\*[B-Font]exit\f[] 261218912SlstewartExit 262218912Slstewart\f\*[B-Font]ntpq\fP. 263218912Slstewart.br 264218912Slstewart.ns 265218912Slstewart.TP 15 266218912Slstewart.NOP \f\*[B-Font]host\f[] [\f\*[I-Font]name\f[]] 267218912SlstewartSet the host to which future queries will be sent. 268218912SlstewartThe 269218912Slstewart\f\*[I-Font]name\f[] 270218912Slstewartmay be either a host name or a numeric address. 271218912SlstewartWithout any arguments, displays the current host. 272218912Slstewart.br 273218912Slstewart.ns 274218912Slstewart.TP 15 275218912Slstewart.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[]|\f\*[B-Font]no\f[]] 276218912SlstewartIf 277218912Slstewart\f\*[B-Font]yes\f[] 278218912Slstewartis specified, host names are printed in 279218912Slstewartinformation displays. 280218912SlstewartIf 281218912Slstewart\f\*[B-Font]no\f[] 282218912Slstewartis specified, numeric 283218912Slstewartaddresses are printed instead. 284218912SlstewartThe default is 285218912Slstewart\f\*[B-Font]yes\f[], 286218912Slstewartunless 287218912Slstewartmodified using the command line 288218912Slstewart\f\*[B-Font]\-n\f[] 289218912Slstewartswitch. 290235693SgjbWithout any arguments, displays whether host names or numeric addresses 291218912Slstewartare shown. 292218912Slstewart.br 293218912Slstewart.ns 294218912Slstewart.TP 15 295218912Slstewart.NOP \f\*[B-Font]keyid\f[] [\f\*[I-Font]keyid\f[]] 296218912SlstewartThis command allows the specification of a key number to be 297218912Slstewartused to authenticate configuration requests. 298218912SlstewartThis must correspond 299225583Slstewartto the 300218912Slstewart\f\*[B-Font]controlkey\f[] 301218912Slstewartkey number the server has been configured to use for this 302218912Slstewartpurpose. 303218912SlstewartWithout any arguments, displays the current 304218912Slstewart\f\*[I-Font]keyid\f[]. 305218912Slstewart.br 306218912Slstewart.ns 307218912Slstewart.TP 15 308218912Slstewart.NOP \f\*[B-Font]keytype\f[] [\f\*[I-Font]digest\f[]] 309218912SlstewartSpecify the digest algorithm to use for authenticating requests, with default 310218912Slstewart\f\*[B-Font]MD5\f[]. 311218912SlstewartIf 312218912Slstewart\f\*[B-Font]ntpq\fP 313220560Slstewartwas built with OpenSSL support, and OpenSSL is installed, 314220560Slstewart\f\*[I-Font]digest\f[] 315220560Slstewartcan be any message digest algorithm supported by OpenSSL. 316220560SlstewartIf no argument is given, the current 317218912Slstewart\f\*[B-Font]keytype\f[] \f\*[I-Font]digest\f[] 318218912Slstewartalgorithm used is displayed. 319218912Slstewart.br 320218912Slstewart.ns 321218912Slstewart.TP 15 322218912Slstewart.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[]] 323218912SlstewartSets the NTP version number which 324218912Slstewart\f\*[B-Font]ntpq\fP 325218912Slstewartclaims in 326218912Slstewartpackets. 327218912SlstewartDefaults to 3, and note that mode 6 control messages (and 328218912Slstewartmodes, for that matter) didn't exist in NTP version 1. 329218912SlstewartThere appear 330218912Slstewartto be no servers left which demand version 1. 331218912SlstewartWith no argument, displays the current NTP version that will be used 332218912Slstewartwhen communicating with servers. 333218912Slstewart.br 334.ns 335.TP 15 336.NOP \f\*[B-Font]passwd\f[] 337This command prompts you to type in a password (which will not 338be echoed) which will be used to authenticate configuration 339requests. 340The password must correspond to the key configured for 341use by the NTP server for this purpose if such requests are to be 342successful. 343.br 344.ns 345.TP 15 346.NOP \f\*[B-Font]poll\f[] [\f\*[I-Font]n\f[]] [\f\*[B-Font]verbose\f[]] 347Poll an NTP server in client mode 348\f\*[I-Font]n\f[] 349times. 350Poll not implemented yet. 351.br 352.ns 353.TP 15 354.NOP \f\*[B-Font]quit\f[] 355Exit 356\f\*[B-Font]ntpq\fP. 357.br 358.ns 359.TP 15 360.NOP \f\*[B-Font]raw\f[] 361Causes all output from query commands is printed as received 362from the remote server. 363The only formating/interpretation done on 364the data is to transform nonascii data into a printable (but barely 365understandable) form. 366.br 367.ns 368.TP 15 369.NOP \f\*[B-Font]timeout\f[] [\f\*[I-Font]milliseconds\f[]] 370Specify a timeout period for responses to server queries. 371The 372default is about 5000 milliseconds. 373Without any arguments, displays the current timeout period. 374Note that since 375\f\*[B-Font]ntpq\fP 376retries each query once after a timeout, the total waiting time for 377a timeout will be twice the timeout value set. 378.br 379.ns 380.TP 15 381.NOP \f\*[B-Font]version\f[] 382Display the version of the 383\f\*[B-Font]ntpq\fP 384program. 385.PP 386.SS "Control Message Commands" 387Association ids are used to identify system, peer and clock variables. 388System variables are assigned an association id of zero and system name 389space, while each association is assigned a nonzero association id and 390peer namespace. 391Most control commands send a single message to the server and expect a 392single response message. 393The exceptions are the 394\f\*[B-Font]peers\f[] 395command, which sends a series of messages, 396and the 397\f\*[B-Font]mreadlist\f[] 398and 399\f\*[B-Font]mreadvar\f[] 400commands, which iterate over a range of associations. 401.TP 10 402.NOP \f\*[B-Font]apeers\f[] 403Display a list of peers in the form: 404.Dl [tally]remote refid assid st t when pool reach delay offset jitter 405where the output is just like the 406\f\*[B-Font]peers\f[] 407command except that the 408\f\*[B-Font]refid\f[] 409is displayed in hex format and the association number is also displayed. 410.br 411.ns 412.TP 10 413.NOP \f\*[B-Font]associations\f[] 414Display a list of mobilized associations in the form: 415.Dl ind assid status conf reach auth condition last_event cnt 416.RS 417.IP \fB\(bu\fP 2 418.IP \fB\(bu\fP 2 \f\*[B-Font]ind\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]index\f[] \f\*[B-Font]on\f[] \f\*[B-Font]this\f[] \f\*[B-Font]list\f[] 419.IP \fB\(bu\fP 2 \f\*[B-Font]assid\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]association\f[] \f\*[B-Font]id\f[] 420.IP \fB\(bu\fP 2 \f\*[B-Font]status\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\f[] 421.IP \fB\(bu\fP 2 \f\*[B-Font]conf\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]persistent,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]ephemeral\f[] 422.IP \fB\(bu\fP 2 \f\*[B-Font]reach\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]yes\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]reachable,\f[] \f\*[B-Font]no\f[]: \f\*[B-Font]No\f[] \f\*[B-Font]unreachable\f[] 423.IP \fB\(bu\fP 2 \f\*[B-Font]auth\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]ok\f[], \f\*[B-Font]yes\f[], \f\*[B-Font]bad\f[] \f\*[B-Font]No\f[] \f\*[B-Font]and\f[] \f\*[B-Font]none\f[] 424.IP \fB\(bu\fP 2 \f\*[B-Font]condition\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]selection\f[] \f\*[B-Font]status\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]select\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[] 425.IP \fB\(bu\fP 2 \f\*[B-Font]last_event\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]report\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]event\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[] 426.IP \fB\(bu\fP 2 \f\*[B-Font]cnt\f[] \f\*[B-Font]Ta\f[] \f\*[B-Font]event\f[] \f\*[B-Font]count\f[] \f\*[B-Font]\&(see\f[] \f\*[B-Font]the\f[] \f\*[B-Font]count\f[] \f\*[B-Font]No\f[] \f\*[B-Font]field\f[] \f\*[B-Font]of\f[] \f\*[B-Font]the\f[] \f\*[B-Font]peer\f[] \f\*[B-Font]status\f[] \f\*[B-Font]word\&)\f[] 427.RE 428.br 429.ns 430.TP 10 431.NOP \f\*[B-Font]authinfo\f[] 432Display the authentication statistics counters: 433time since reset, stored keys, free keys, key lookups, keys not found, 434uncached keys, expired keys, encryptions, decryptions. 435.br 436.ns 437.TP 10 438.NOP \f\*[B-Font]clocklist\f[] [\f\*[I-Font]associd\f[]] 439.br 440.ns 441.TP 10 442.NOP \f\*[B-Font]cl\f[] [\f\*[I-Font]associd\f[]] 443Display all clock variables in the variable list for those associations 444supporting a reference clock. 445.br 446.ns 447.TP 10 448.NOP \f\*[B-Font]clockvar\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...] 449.br 450.ns 451.TP 10 452.NOP \f\*[B-Font]cv\f[] [\f\*[I-Font]associd\f[]] [\f\*[I-Font]name\f[][\&=\f\*[I-Font]value\f[]][] ,...] 453Display a list of clock variables for those associations supporting a 454reference clock. 455.br 456.ns 457.TP 10 458.NOP \f\*[B-Font]:config\f[] \f\*[I-Font]configuration command line\f[] 459Send the remainder of the command line, including whitespace, to the 460server as a run-time configuration command in the same format as a line 461in the configuration file. 462This command is experimental until further notice and clarification. 463Authentication is of course required. 464.br 465.ns 466.TP 10 467.NOP \f\*[B-Font]config-from-file\f[] \f\*[I-Font]filename\f[] 468Send each line of 469\f\*[I-Font]filename\f[] 470to the server as run-time configuration commands in the same format as 471lines in the configuration file. 472This command is experimental until further notice and clarification. 473Authentication is required. 474.br 475.ns 476.TP 10 477.NOP \f\*[B-Font]ifstats\f[] 478Display status and statistics counters for each local network interface address: 479interface number, interface name and address or broadcast, drop, flag, 480ttl, mc, received, sent, send failed, peers, uptime. 481Authentication is required. 482.br 483.ns 484.TP 10 485.NOP \f\*[B-Font]iostats\f[] 486Display network and reference clock I/O statistics: 487time since reset, receive buffers, free receive buffers, used receive buffers, 488low water refills, dropped packets, ignored packets, received packets, 489packets sent, packet send failures, input wakeups, useful input wakeups. 490.br 491.ns 492.TP 10 493.NOP \f\*[B-Font]kerninfo\f[] 494Display kernel loop and PPS statistics: 495associd, status, pll offset, pll frequency, maximum error, 496estimated error, kernel status, pll time constant, precision, 497frequency tolerance, pps frequency, pps stability, pps jitter, 498calibration interval, calibration cycles, jitter exceeded, 499stability exceeded, calibration errors. 500As with other ntpq output, times are in milliseconds; very small values 501may be shown as exponentials. 502The precision value displayed is in milliseconds as well, unlike the 503precision system variable. 504.br 505.ns 506.TP 10 507.NOP \f\*[B-Font]lassociations\f[] 508Perform the same function as the associations command, except display 509mobilized and unmobilized associations, including all clients. 510.br 511.ns 512.TP 10 513.NOP \f\*[B-Font]lopeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]] 514Display a list of all peers and clients showing 515\f\*[B-Font]dstadr\f[] 516(associated with the given IP version). 517.br 518.ns 519.TP 10 520.NOP \f\*[B-Font]lpassociations\f[] 521Display the last obtained list of associations, including all clients. 522.br 523.ns 524.TP 10 525.NOP \f\*[B-Font]lpeers\f[] [\f\*[B-Font]\-4\f[]|\f\*[B-Font]\-6\f[]] 526Display a list of all peers and clients (associated with the given IP version). 527.br 528.ns 529.TP 10 530.NOP \f\*[B-Font]monstats\f[] 531Display monitor facility status, statistics, and limits: 532enabled, addresses, peak addresses, maximum addresses, 533reclaim above count, reclaim older than, kilobytes, maximum kilobytes. 534.br 535.ns 536.TP 10 537.NOP \f\*[B-Font]mreadlist\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] 538.br 539.ns 540.TP 10 541.NOP \f\*[B-Font]mrl\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] 542Perform the same function as the 543\f\*[B-Font]readlist\f[] 544command for a range of association ids. 545.br 546.ns 547.TP 10 548.NOP \f\*[B-Font]mreadvar\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...] 549This range may be determined from the list displayed by any 550command showing associations. 551.br 552.ns 553.TP 10 554.NOP \f\*[B-Font]mrv\f[] \f\*[I-Font]associdlo\f[] \f\*[I-Font]associdhi\f[] [\f\*[I-Font]name\f[]][,...] 555Perform the same function as the 556\f\*[B-Font]readvar\f[] 557command for a range of association ids. 558This range may be determined from the list displayed by any 559command showing associations. 560.br 561.ns 562.TP 10 563.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[]] 564Display traffic counts of the most recently seen source addresses 565collected and maintained by the monitor facility. 566With the exception of 567\f\*[B-Font]sort\f[]\&=[\&-]\f\*[I-Font]sortorder\f[], 568the options filter the list returned by 569\fCntpd\f[]\fR(8)\f[]. 570The 571\f\*[B-Font]limited\f[] 572and 573\f\*[B-Font]kod\f[] 574options return only entries representing client addresses from which the 575last packet received triggered either discarding or a KoD response. 576The 577\f\*[B-Font]mincount\f[]=\f\*[I-Font]count\f[] 578option filters entries representing less than 579\f\*[I-Font]count\f[] 580packets. 581The 582\f\*[B-Font]laddr\f[]=\f\*[I-Font]localaddr\f[] 583option filters entries for packets received on any local address other than 584\f\*[I-Font]localaddr\f[]. 585\f\*[B-Font]resany\f[]=\f\*[I-Font]hexmask\f[] 586and 587\f\*[B-Font]resall\f[]=\f\*[I-Font]hexmask\f[] 588filter entries containing none or less than all, respectively, of the bits in 589\f\*[I-Font]hexmask\f[], 590which must begin with 591\f\*[B-Font]0x\f[]. 592The 593\f\*[I-Font]sortorder\f[] 594defaults to 595\f\*[B-Font]lstint\f[] 596and may be 597\f\*[B-Font]addr\f[], 598\f\*[B-Font]avgint\f[], 599\f\*[B-Font]count\f[], 600\f\*[B-Font]lstint\f[], 601or any of those preceded by 602\[oq]\&-\[cq] 603to reverse the sort order. 604The output columns are: 605.RS 606.TP 10 607.NOP Column 608Description 609.br 610.ns 611.TP 10 612.NOP \f\*[B-Font]lstint\f[] 613Interval in seconds between the receipt of the most recent packet from 614this address and the completion of the retrieval of the MRU list by 615\f\*[B-Font]ntpq\fP. 616.br 617.ns 618.TP 10 619.NOP \f\*[B-Font]avgint\f[] 620Average interval in s between packets from this address. 621.br 622.ns 623.TP 10 624.NOP \f\*[B-Font]rstr\f[] 625Restriction flags associated with this address. 626Most are copied unchanged from the matching 627\f\*[B-Font]restrict\f[] 628command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless 629the last packet from this address triggered a rate control response. 630.br 631.ns 632.TP 10 633.NOP \f\*[B-Font]r\f[] 634Rate control indicator, either 635a period, 636\f\*[B-Font]L\f[] 637or 638\f\*[B-Font]K\f[] 639for no rate control response, 640rate limiting by discarding, or rate limiting with a KoD response, respectively. 641.br 642.ns 643.TP 10 644.NOP \f\*[B-Font]m\f[] 645Packet mode. 646.br 647.ns 648.TP 10 649.NOP \f\*[B-Font]v\f[] 650Packet version number. 651.br 652.ns 653.TP 10 654.NOP \f\*[B-Font]count\f[] 655Packets received from this address. 656.br 657.ns 658.TP 10 659.NOP \f\*[B-Font]rport\f[] 660Source port of last packet from this address. 661.br 662.ns 663.TP 10 664.NOP \f\*[B-Font]remote\f[] \f\*[B-Font]address\f[] 665host or DNS name, numeric address, or address followed by 666claimed DNS name which could not be verified in parentheses. 667.RE 668.br 669.ns 670.TP 10 671.NOP \f\*[B-Font]opeers\f[] [\f\*[B-Font]\-4\f[] | \f\*[B-Font]\-6\f[]] 672Obtain and print the old-style list of all peers and clients showing 673\f\*[B-Font]dstadr\f[] 674(associated with the given IP version), 675rather than the 676\f\*[B-Font]refid\f[]. 677.br 678.ns 679.TP 10 680.NOP \f\*[B-Font]passociations\f[] 681Perform the same function as the 682\f\*[B-Font]associations\f[] 683command, 684except that it uses previously stored data rather than making a new query. 685.br 686.ns 687.TP 10 688.NOP \f\*[B-Font]peers\f[] 689Display a list of peers in the form: 690.Dl [tally]remote refid st t when pool reach delay offset jitter 691.RS 692.TP 10 693.NOP Variable 694Description 695.br 696.ns 697.TP 10 698.NOP \f\*[B-Font][tally]\f[] 699single-character code indicating current value of the 700\f\*[B-Font]select\f[] 701field of the 702.Lk decode.html#peer "peer status word" 703.br 704.ns 705.TP 10 706.NOP \f\*[B-Font]remote\f[] 707host name (or IP number) of peer. 708The value displayed will be truncated to 15 characters unless the 709\f\*[B-Font]ntpq\fP 710\f\*[B-Font]\-w\f[] 711option is given, in which case the full value will be displayed 712on the first line, and if too long, 713the remaining data will be displayed on the next line. 714.br 715.ns 716.TP 10 717.NOP \f\*[B-Font]refid\f[] 718source IP address or 719.Lk decode.html#kiss "'kiss code" 720.br 721.ns 722.TP 10 723.NOP \f\*[B-Font]st\f[] 724stratum: 0 for local reference clocks, 1 for servers with local 725reference clocks, ..., 16 for unsynchronized server clocks 726.br 727.ns 728.TP 10 729.NOP \f\*[B-Font]t\f[] 730\f\*[B-Font]u\f[]: 731unicast or manycast client, 732\f\*[B-Font]b\f[]: 733broadcast or multicast client, 734\f\*[B-Font]p\f[]: 735pool source, 736\f\*[B-Font]l\f[]: 737local (reference clock), 738\f\*[B-Font]s\f[]: 739symmetric (peer), 740\f\*[B-Font]A\f[]: 741manycast server, 742\f\*[B-Font]B\f[]: 743broadcast server, 744\f\*[B-Font]M\f[]: 745multicast server 746.br 747.ns 748.TP 10 749.NOP \f\*[B-Font]when\f[] 750time in seconds, minutes, hours, or days since the last packet 751was received, or 752\[oq]\&-\[cq] 753if a packet has never been received 754.br 755.ns 756.TP 10 757.NOP \f\*[B-Font]poll\f[] 758poll interval (s) 759.br 760.ns 761.TP 10 762.NOP \f\*[B-Font]reach\f[] 763reach shift register (octal) 764.br 765.ns 766.TP 10 767.NOP \f\*[B-Font]delay\f[] 768roundtrip delay 769.br 770.ns 771.TP 10 772.NOP \f\*[B-Font]offset\f[] 773offset of server relative to this host 774.br 775.ns 776.TP 10 777.NOP \f\*[B-Font]jitter\f[] 778offset RMS error estimate. 779.RE 780.br 781.ns 782.TP 10 783.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]associd\f[] 784Display the statistics for the peer with the given 785\f\*[I-Font]associd\f[]: 786associd, status, remote host, local address, time last received, 787time until next send, reachability change, packets sent, 788packets received, bad authentication, bogus origin, duplicate, 789bad dispersion, bad reference time, candidate order. 790.br 791.ns 792.TP 10 793.NOP \f\*[B-Font]readlist\f[] [\f\*[I-Font]associd\f[]] 794.br 795.ns 796.TP 10 797.NOP \f\*[B-Font]rl\f[] [\f\*[I-Font]associd\f[]] 798Display all system or peer variables. 799If the 800\f\*[I-Font]associd\f[] 801is omitted, it is assumed to be zero. 802.br 803.ns 804.TP 10 805.NOP \f\*[B-Font]readvar\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]] 806.br 807.ns 808.TP 10 809.NOP \f\*[B-Font]rv\f[] [\f\*[I-Font]associd\f[] \f\*[I-Font]name\f[][=\f\*[I-Font]value\f[]] [, ...]] 810Display the specified system or peer variables. 811If 812\f\*[I-Font]associd\f[] 813is zero, the variables are from the 814\fISystem\f[] \fIVariables\f[] 815name space, otherwise they are from the 816\fIPeer\f[] \fIVariables\f[] 817name space. 818The 819\f\*[I-Font]associd\f[] 820is required, as the same name can occur in both spaces. 821If no 822\f\*[I-Font]name\f[] 823is included, all operative variables in the name space are displayed. 824In this case only, if the 825\f\*[I-Font]associd\f[] 826is omitted, it is assumed to be zero. 827Multiple names are specified with comma separators and without whitespace. 828Note that time values are represented in milliseconds 829and frequency values in parts-per-million (PPM). 830Some NTP timestamps are represented in the format 831\f\*[I-Font]YYYY\f[]\f\*[I-Font]MM\f[] \f\*[I-Font]DD\f[] \f\*[I-Font]TTTT\f[], 832where 833\f\*[I-Font]YYYY\f[] 834is the year, 835\f\*[I-Font]MM\f[] 836the month of year, 837\f\*[I-Font]DD\f[] 838the day of month and 839\f\*[I-Font]TTTT\f[] 840the time of day. 841.br 842.ns 843.TP 10 844.NOP \f\*[B-Font]reslist\f[] 845Display the access control (restrict) list for 846\f\*[B-Font]ntpq\fP. 847Authentication is required. 848.br 849.ns 850.TP 10 851.NOP \f\*[B-Font]saveconfig\f[] \f\*[I-Font]filename\f[] 852Save the current configuration, 853including any runtime modifications made by 854\f\*[B-Font]:config\f[] 855or 856\f\*[B-Font]config-from-file\f[], 857to the NTP server host file 858\f\*[I-Font]filename\f[]. 859This command will be rejected by the server unless 860.Lk miscopt.html#saveconfigdir "saveconfigdir" 861appears in the 862\fCntpd\f[]\fR(8)\f[] 863configuration file. 864\f\*[I-Font]filename\f[] 865can use 866\fCdate\f[]\fR(1)\f[] 867format specifiers to substitute the current date and time, for 868example, 869.in +4 870\f\*[B-Font]saveconfig\f[] \fIntp-%Y%m%d-%H%M%S.conf\f[]. 871.in -4 872The filename used is stored in system variable 873\f\*[B-Font]savedconfig\f[]. 874Authentication is required. 875.br 876.ns 877.TP 10 878.NOP \f\*[B-Font]sysinfo\f[] 879Display system operational summary: 880associd, status, system peer, system peer mode, leap indicator, 881stratum, log2 precision, root delay, root dispersion, 882reference id, reference time, system jitter, clock jitter, 883clock wander, broadcast delay, symm. auth. delay. 884.br 885.ns 886.TP 10 887.NOP \f\*[B-Font]sysstats\f[] 888Display system uptime and packet counts maintained in the 889protocol module: 890uptime, sysstats reset, packets received, current version, 891older version, bad length or format, authentication failed, 892declined, restricted, rate limited, KoD responses, 893processed for time. 894.br 895.ns 896.TP 10 897.NOP \f\*[B-Font]timerstats\f[] 898Display interval timer counters: 899time since reset, timer overruns, calls to transmit. 900.br 901.ns 902.TP 10 903.NOP \f\*[B-Font]writelist\f[] \f\*[I-Font]associd\f[] 904Set all system or peer variables included in the variable list. 905.br 906.ns 907.TP 10 908.NOP \f\*[B-Font]writevar\f[] \f\*[I-Font]associd\f[] \f\*[I-Font]name\f[]=\f\*[I-Font]value\f[] [, ...] 909Set the specified variables in the variable list. 910If the 911\f\*[I-Font]associd\f[] 912is zero, the variables are from the 913\fISystem\f[] \fIVariables\f[] 914name space, otherwise they are from the 915\fIPeer\f[] \fIVariables\f[] 916name space. 917The 918\f\*[I-Font]associd\f[] 919is required, as the same name can occur in both spaces. 920Authentication is required. 921.PP 922.SS Status Words and Kiss Codes 923The current state of the operating program is shown 924in a set of status words 925maintained by the system. 926Status information is also available on a per-association basis. 927These words are displayed by the 928\f\*[B-Font]readlist\f[] 929and 930\f\*[B-Font]associations\f[] 931commands both in hexadecimal and in decoded short tip strings. 932The codes, tips and short explanations are documented on the 933.Lk decode.html "Event Messages and Status Words" 934page. 935The page also includes a list of system and peer messages, 936the code for the latest of which is included in the status word. 937.sp \n(Ppu 938.ne 2 939 940Information resulting from protocol machine state transitions 941is displayed using an informal set of ASCII strings called 942.Lk decode.html#kiss "kiss codes" . 943The original purpose was for kiss-o'-death (KoD) packets 944sent by the server to advise the client of an unusual condition. 945They are now displayed, when appropriate, 946in the reference identifier field in various billboards. 947.SS System Variables 948The following system variables appear in the 949\f\*[B-Font]readlist\f[] 950billboard. 951Not all variables are displayed in some configurations. 952.sp \n(Ppu 953.ne 2 954 955.TP 10 956.NOP Variable 957Description 958.br 959.ns 960.TP 10 961.NOP \f\*[B-Font]status\f[] 962.Lk decode.html#sys "system status word" 963.br 964.ns 965.TP 10 966.NOP \f\*[B-Font]version\f[] 967NTP software version and build time 968.br 969.ns 970.TP 10 971.NOP \f\*[B-Font]processor\f[] 972hardware platform and version 973.br 974.ns 975.TP 10 976.NOP \f\*[B-Font]system\f[] 977operating system and version 978.br 979.ns 980.TP 10 981.NOP \f\*[B-Font]leap\f[] 982leap warning indicator (0-3) 983.br 984.ns 985.TP 10 986.NOP \f\*[B-Font]stratum\f[] 987stratum (1-15) 988.br 989.ns 990.TP 10 991.NOP \f\*[B-Font]precision\f[] 992precision (log2 s) 993.br 994.ns 995.TP 10 996.NOP \f\*[B-Font]rootdelay\f[] 997total roundtrip delay to the primary reference clock 998.br 999.ns 1000.TP 10 1001.NOP \f\*[B-Font]rootdisp\f[] 1002total dispersion to the primary reference clock 1003.br 1004.ns 1005.TP 10 1006.NOP \f\*[B-Font]refid\f[] 1007reference id or 1008.Lk decode.html#kiss "kiss code" 1009.br 1010.ns 1011.TP 10 1012.NOP \f\*[B-Font]reftime\f[] 1013reference time 1014.br 1015.ns 1016.TP 10 1017.NOP \f\*[B-Font]clock\f[] 1018date and time of day 1019.br 1020.ns 1021.TP 10 1022.NOP \f\*[B-Font]peer\f[] 1023system peer association id 1024.br 1025.ns 1026.TP 10 1027.NOP \f\*[B-Font]tc\f[] 1028time constant and poll exponent (log2 s) (3-17) 1029.br 1030.ns 1031.TP 10 1032.NOP \f\*[B-Font]mintc\f[] 1033minimum time constant (log2 s) (3-10) 1034.br 1035.ns 1036.TP 10 1037.NOP \f\*[B-Font]offset\f[] 1038combined offset of server relative to this host 1039.br 1040.ns 1041.TP 10 1042.NOP \f\*[B-Font]frequency\f[] 1043frequency drift (PPM) relative to hardware clock 1044.br 1045.ns 1046.TP 10 1047.NOP \f\*[B-Font]sys_jitter\f[] 1048combined system jitter 1049.br 1050.ns 1051.TP 10 1052.NOP \f\*[B-Font]clk_wander\f[] 1053clock frequency wander (PPM) 1054.br 1055.ns 1056.TP 10 1057.NOP \f\*[B-Font]clk_jitter\f[] 1058clock jitter 1059.br 1060.ns 1061.TP 10 1062.NOP \f\*[B-Font]tai\f[] 1063TAI-UTC offset (s) 1064.br 1065.ns 1066.TP 10 1067.NOP \f\*[B-Font]leapsec\f[] 1068NTP seconds when the next leap second is/was inserted 1069.br 1070.ns 1071.TP 10 1072.NOP \f\*[B-Font]expire\f[] 1073NTP seconds when the NIST leapseconds file expires 1074.PP 1075The jitter and wander statistics are exponentially-weighted RMS averages. 1076The system jitter is defined in the NTPv4 specification; 1077the clock jitter statistic is computed by the clock discipline module. 1078.sp \n(Ppu 1079.ne 2 1080 1081When the NTPv4 daemon is compiled with the OpenSSL software library, 1082additional system variables are displayed, 1083including some or all of the following, 1084depending on the particular Autokey dance: 1085.TP 10 1086.NOP Variable 1087Description 1088.br 1089.ns 1090.TP 10 1091.NOP \f\*[B-Font]host\f[] 1092Autokey host name for this host 1093.br 1094.ns 1095.TP 10 1096.NOP \f\*[B-Font]ident\f[] 1097Autokey group name for this host 1098.br 1099.ns 1100.TP 10 1101.NOP \f\*[B-Font]flags\f[] 1102host flags (see Autokey specification) 1103.br 1104.ns 1105.TP 10 1106.NOP \f\*[B-Font]digest\f[] 1107OpenSSL message digest algorithm 1108.br 1109.ns 1110.TP 10 1111.NOP \f\*[B-Font]signature\f[] 1112OpenSSL digest/signature scheme 1113.br 1114.ns 1115.TP 10 1116.NOP \f\*[B-Font]update\f[] 1117NTP seconds at last signature update 1118.br 1119.ns 1120.TP 10 1121.NOP \f\*[B-Font]cert\f[] 1122certificate subject, issuer and certificate flags 1123.br 1124.ns 1125.TP 10 1126.NOP \f\*[B-Font]until\f[] 1127NTP seconds when the certificate expires 1128.PP 1129.SS Peer Variables 1130The following peer variables appear in the 1131\f\*[B-Font]readlist\f[] 1132billboard for each association. 1133Not all variables are displayed in some configurations. 1134.sp \n(Ppu 1135.ne 2 1136 1137.TP 10 1138.NOP Variable 1139Description 1140.br 1141.ns 1142.TP 10 1143.NOP \f\*[B-Font]associd\f[] 1144association id 1145.br 1146.ns 1147.TP 10 1148.NOP \f\*[B-Font]status\f[] 1149.Lk decode.html#peer "peer status word" 1150.br 1151.ns 1152.TP 10 1153.NOP \f\*[B-Font]srcadr\f[] 1154source (remote) IP address 1155.br 1156.ns 1157.TP 10 1158.NOP \f\*[B-Font]srcport\f[] 1159source (remote) port 1160.br 1161.ns 1162.TP 10 1163.NOP \f\*[B-Font]dstadr\f[] 1164destination (local) IP address 1165.br 1166.ns 1167.TP 10 1168.NOP \f\*[B-Font]dstport\f[] 1169destination (local) port 1170.br 1171.ns 1172.TP 10 1173.NOP \f\*[B-Font]leap\f[] 1174leap indicator (0-3) 1175.br 1176.ns 1177.TP 10 1178.NOP \f\*[B-Font]stratum\f[] 1179stratum (0-15) 1180.br 1181.ns 1182.TP 10 1183.NOP \f\*[B-Font]precision\f[] 1184precision (log2 s) 1185.br 1186.ns 1187.TP 10 1188.NOP \f\*[B-Font]rootdelay\f[] 1189total roundtrip delay to the primary reference clock 1190.br 1191.ns 1192.TP 10 1193.NOP \f\*[B-Font]rootdisp\f[] 1194total root dispersion to the primary reference clock 1195.br 1196.ns 1197.TP 10 1198.NOP \f\*[B-Font]refid\f[] 1199reference id or 1200.Lk decode.html#kiss "kiss code" 1201.br 1202.ns 1203.TP 10 1204.NOP \f\*[B-Font]reftime\f[] 1205reference time 1206.br 1207.ns 1208.TP 10 1209.NOP \f\*[B-Font]rec\f[] 1210last packet received time 1211.br 1212.ns 1213.TP 10 1214.NOP \f\*[B-Font]reach\f[] 1215reach register (octal) 1216.br 1217.ns 1218.TP 10 1219.NOP \f\*[B-Font]unreach\f[] 1220unreach counter 1221.br 1222.ns 1223.TP 10 1224.NOP \f\*[B-Font]hmode\f[] 1225host mode (1-6) 1226.br 1227.ns 1228.TP 10 1229.NOP \f\*[B-Font]pmode\f[] 1230peer mode (1-5) 1231.br 1232.ns 1233.TP 10 1234.NOP \f\*[B-Font]hpoll\f[] 1235host poll exponent (log2 s) (3-17) 1236.br 1237.ns 1238.TP 10 1239.NOP \f\*[B-Font]ppoll\f[] 1240peer poll exponent (log2 s) (3-17) 1241.br 1242.ns 1243.TP 10 1244.NOP \f\*[B-Font]headway\f[] 1245headway (see 1246.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" ) 1247.br 1248.ns 1249.TP 10 1250.NOP \f\*[B-Font]flash\f[] 1251.Lk decode.html#flash "flash status word" 1252.br 1253.ns 1254.TP 10 1255.NOP \f\*[B-Font]keyid\f[] 1256symmetric key id 1257.br 1258.ns 1259.TP 10 1260.NOP \f\*[B-Font]offset\f[] 1261filter offset 1262.br 1263.ns 1264.TP 10 1265.NOP \f\*[B-Font]delay\f[] 1266filter delay 1267.br 1268.ns 1269.TP 10 1270.NOP \f\*[B-Font]dispersion\f[] 1271filter dispersion 1272.br 1273.ns 1274.TP 10 1275.NOP \f\*[B-Font]jitter\f[] 1276filter jitter 1277.br 1278.ns 1279.TP 10 1280.NOP \f\*[B-Font]bias\f[] 1281unicast/broadcast bias 1282.br 1283.ns 1284.TP 10 1285.NOP \f\*[B-Font]xleave\f[] 1286interleave delay (see 1287.Lk xleave.html "NTP Interleaved Modes" ) 1288.PP 1289The 1290\f\*[B-Font]bias\f[] 1291variable is calculated when the first broadcast packet is received 1292after the calibration volley. 1293It represents the offset of the broadcast subgraph relative to the 1294unicast subgraph. 1295The 1296\f\*[B-Font]xleave\f[] 1297variable appears only for the interleaved symmetric and interleaved modes. 1298It represents the internal queuing, buffering and transmission delays 1299for the preceding packet. 1300.sp \n(Ppu 1301.ne 2 1302 1303When the NTPv4 daemon is compiled with the OpenSSL software library, 1304additional peer variables are displayed, including the following: 1305.TP 10 1306.NOP Variable 1307Description 1308.br 1309.ns 1310.TP 10 1311.NOP \f\*[B-Font]flags\f[] 1312peer flags (see Autokey specification) 1313.br 1314.ns 1315.TP 10 1316.NOP \f\*[B-Font]host\f[] 1317Autokey server name 1318.br 1319.ns 1320.TP 10 1321.NOP \f\*[B-Font]flags\f[] 1322peer flags (see Autokey specification) 1323.br 1324.ns 1325.TP 10 1326.NOP \f\*[B-Font]signature\f[] 1327OpenSSL digest/signature scheme 1328.br 1329.ns 1330.TP 10 1331.NOP \f\*[B-Font]initsequence\f[] 1332initial key id 1333.br 1334.ns 1335.TP 10 1336.NOP \f\*[B-Font]initkey\f[] 1337initial key index 1338.br 1339.ns 1340.TP 10 1341.NOP \f\*[B-Font]timestamp\f[] 1342Autokey signature timestamp 1343.br 1344.ns 1345.TP 10 1346.NOP \f\*[B-Font]ident\f[] 1347Autokey group name for this association 1348.PP 1349.SS Clock Variables 1350The following clock variables appear in the 1351\f\*[B-Font]clocklist\f[] 1352billboard for each association with a reference clock. 1353Not all variables are displayed in some configurations. 1354.TP 10 1355.NOP Variable 1356Description 1357.br 1358.ns 1359.TP 10 1360.NOP \f\*[B-Font]associd\f[] 1361association id 1362.br 1363.ns 1364.TP 10 1365.NOP \f\*[B-Font]status\f[] 1366.Lk decode.html#clock "clock status word" 1367.br 1368.ns 1369.TP 10 1370.NOP \f\*[B-Font]device\f[] 1371device description 1372.br 1373.ns 1374.TP 10 1375.NOP \f\*[B-Font]timecode\f[] 1376ASCII time code string (specific to device) 1377.br 1378.ns 1379.TP 10 1380.NOP \f\*[B-Font]poll\f[] 1381poll messages sent 1382.br 1383.ns 1384.TP 10 1385.NOP \f\*[B-Font]noreply\f[] 1386no reply 1387.br 1388.ns 1389.TP 10 1390.NOP \f\*[B-Font]badformat\f[] 1391bad format 1392.br 1393.ns 1394.TP 10 1395.NOP \f\*[B-Font]baddata\f[] 1396bad date or time 1397.br 1398.ns 1399.TP 10 1400.NOP \f\*[B-Font]fudgetime1\f[] 1401fudge time 1 1402.br 1403.ns 1404.TP 10 1405.NOP \f\*[B-Font]fudgetime2\f[] 1406fudge time 2 1407.br 1408.ns 1409.TP 10 1410.NOP \f\*[B-Font]stratum\f[] 1411driver stratum 1412.br 1413.ns 1414.TP 10 1415.NOP \f\*[B-Font]refid\f[] 1416driver reference id 1417.br 1418.ns 1419.TP 10 1420.NOP \f\*[B-Font]flags\f[] 1421driver flags 1422.PP 1423.SH "OPTIONS" 1424.TP 1425.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 1426Force IPv4 name resolution. 1427This option must not appear in combination with any of the following options: 1428ipv6. 1429.sp 1430Force resolution of following host names on the command line 1431to the IPv4 namespace. 1432.TP 1433.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 1434Force IPv6 name resolution. 1435This option must not appear in combination with any of the following options: 1436ipv4. 1437.sp 1438Force resolution of following host names on the command line 1439to the IPv6 namespace. 1440.TP 1441.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 1442run a command and exit. 1443This option may appear an unlimited number of times. 1444.sp 1445The following argument is interpreted as an interactive format command 1446and is added to the list of commands to be executed on the specified 1447host(s). 1448.TP 1449.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 1450Increase debug verbosity level. 1451This option may appear an unlimited number of times. 1452.sp 1453.TP 1454.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 1455Set the debug verbosity level. 1456This option may appear an unlimited number of times. 1457This option takes an integer number as its argument. 1458.sp 1459.TP 1460.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 1461Force ntpq to operate in interactive mode. 1462This option must not appear in combination with any of the following options: 1463command, peers. 1464.sp 1465Force \fBntpq\fP to operate in interactive mode. 1466Prompts will be written to the standard output and 1467commands read from the standard input. 1468.TP 1469.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 1470numeric host addresses. 1471.sp 1472Output all host addresses in dotted-quad numeric format rather than 1473converting to the canonical host names. 1474.TP 1475.NOP \f\*[B-Font]\-\-old\-rv\f[] 1476Always output status line with readvar. 1477.sp 1478By default, \fBntpq\fP now suppresses the \fBassocid=...\fP 1479line that precedes the output of \fBreadvar\fP 1480(alias \fBrv\fP) when a single variable is requested, such as 1481\fBntpq \-c "rv 0 offset"\fP. 1482This option causes \fBntpq\fP to include both lines of output 1483for a single-variable \fBreadvar\fP. 1484Using an environment variable to 1485preset this option in a script will enable both older and 1486newer \fBntpq\fP to behave identically in this regard. 1487.TP 1488.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 1489Print a list of the peers. 1490This option must not appear in combination with any of the following options: 1491interactive. 1492.sp 1493Print a list of the peers known to the server as well as a summary 1494of their state. This is equivalent to the 'peers' interactive command. 1495.TP 1496.NOP \f\*[B-Font]\-r\f[] \f\*[I-Font]keyword\f[], \f\*[B-Font]\-\-refid\f[]=\f\*[I-Font]keyword\f[] 1497Set default display type for S2+ refids. 1498This option takes a keyword as its argument. The argument sets an enumeration value that can 1499be tested by comparing them against the option value macro. 1500The available keywords are: 1501.in +4 1502.nf 1503.na 1504hash ipv4 1505.fi 1506or their numeric equivalent. 1507.in -4 1508.sp 1509The default 1510\f\*[I-Font]keyword\f[] 1511for this option is: 1512.ti +4 1513 ipv4 1514.sp 1515Set the default display format for S2+ refids. 1516.TP 1517.NOP \f\*[B-Font]\-w\f[], \f\*[B-Font]\-\-wide\f[] 1518Display the full 'remote' value. 1519.sp 1520Display the full value of the 'remote' value. If this requires 1521more than 15 characters, display the full value, emit a newline, 1522and continue the data display properly indented on the next line. 1523.TP 1524.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 1525Display usage information and exit. 1526.TP 1527.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 1528Pass the extended usage information through a pager. 1529.TP 1530.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 1531Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP 1532configuration file listed in the \fBOPTION PRESETS\fP section, below. 1533The command will exit after updating the config file. 1534.TP 1535.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[] 1536Load options from \fIcfgfile\fP. 1537The \fIno-load-opts\fP form will disable the loading 1538of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 1539out of order. 1540.TP 1541.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 1542Output version of program and exit. The default mode is `v', a simple 1543version. The `c' mode will print copyright information and `n' will 1544print the full copyright notice. 1545.PP 1546.SH "OPTION PRESETS" 1547Any option that is not marked as \fInot presettable\fP may be preset 1548by loading values from configuration ("RC" or ".INI") file(s) and values from 1549environment variables named: 1550.nf 1551 \fBNTPQ_<option-name>\fP or \fBNTPQ\fP 1552.fi 1553.ad 1554The environmental presets take precedence (are processed later than) 1555the configuration files. 1556The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 1557If any of these are directories, then the file \fI.ntprc\fP 1558is searched for within those directories. 1559.SH "ENVIRONMENT" 1560See \fBOPTION PRESETS\fP for configuration environment variables. 1561.SH "FILES" 1562See \fBOPTION PRESETS\fP for configuration files. 1563.SH "EXIT STATUS" 1564One of the following exit values will be returned: 1565.TP 1566.NOP 0 " (EXIT_SUCCESS)" 1567Successful program execution. 1568.TP 1569.NOP 1 " (EXIT_FAILURE)" 1570The operation failed or the command syntax was not valid. 1571.TP 1572.NOP 66 " (EX_NOINPUT)" 1573A specified configuration file could not be loaded. 1574.TP 1575.NOP 70 " (EX_SOFTWARE)" 1576libopts had an internal operational error. Please report 1577it to autogen-users@lists.sourceforge.net. Thank you. 1578.PP 1579.SH "AUTHORS" 1580The University of Delaware and Network Time Foundation 1581.SH "COPYRIGHT" 1582Copyright (C) 1992-2017 The University of Delaware and Network Time Foundation all rights reserved. 1583This program is released under the terms of the NTP license, <http://ntp.org/license>. 1584.SH "BUGS" 1585Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org 1586.SH "NOTES" 1587This manual page was \fIAutoGen\fP-erated from the \fBntpq\fP 1588option definitions. 1589