ntpdc.man.in revision 316722
159191Skris.de1 NOP 2296465Sdelphij. it 1 an-trap 3296465Sdelphij. if \\n[.$] \,\\$*\/ 4160814Ssimon.. 559191Skris.ie t \ 659191Skris.ds B-Font [CB] 7160814Ssimon.ds I-Font [CI] 859191Skris.ds R-Font [CR] 959191Skris.el \ 1059191Skris.ds B-Font B 1159191Skris.ds I-Font I 1259191Skris.ds R-Font R 1359191Skris.TH ntpdc @NTPDC_MS@ "21 Mar 2017" "4.2.8p10" "User Commands" 14296465Sdelphij.\" 1559191Skris.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-T2aicv/ag-q4aGav) 1659191Skris.\" 1759191Skris.\" It has been AutoGen-ed March 21, 2017 at 10:44:50 AM by AutoGen 5.18.5 1859191Skris.\" From the definitions ntpdc-opts.def 1959191Skris.\" and the template file agman-cmd.tpl 2059191Skris.SH NAME 2159191Skris\f\*[B-Font]ntpdc\fP 2259191Skris\- vendor-specific NTPD control program 2359191Skris.SH SYNOPSIS 2459191Skris\f\*[B-Font]ntpdc\fP 2559191Skris.\" Mixture of short (flag) options and long options 2659191Skris[\f\*[B-Font]\-flags\f[]] 2759191Skris[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 2859191Skris[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 2959191Skris[ host ...] 3059191Skris.sp \n(Ppu 3159191Skris.ne 2 3259191Skris 3359191Skris.SH DESCRIPTION 3459191Skris\f\*[B-Font]ntpdc\fP 3559191Skrisis deprecated. 3659191SkrisPlease use 3759191Skris\fCntpq\f[]\fR(@NTPQ_MS@)\f[] instead \- it can do everything 3859191Skris\f\*[B-Font]ntpdc\fP 3959191Skrisused to do, and it does so using a much more sane interface. 4059191Skris.sp \n(Ppu 4159191Skris.ne 2 4259191Skris 4359191Skris\f\*[B-Font]ntpdc\fP 4459191Skrisis a utility program used to query 4559191Skris\fCntpd\f[]\fR(@NTPD_MS@)\f[] 4659191Skrisabout its 4759191Skriscurrent state and to request changes in that state. 4859191SkrisIt uses NTP mode 7 control message formats described in the source code. 4959191SkrisThe program may 5059191Skrisbe run either in interactive mode or controlled using command line 5159191Skrisarguments. 5259191SkrisExtensive state and statistics information is available 5359191Skristhrough the 5459191Skris\f\*[B-Font]ntpdc\fP 5559191Skrisinterface. 5659191SkrisIn addition, nearly all the 5759191Skrisconfiguration options which can be specified at startup using 5859191Skrisntpd's configuration file may also be specified at run time using 5959191Skris\f\*[B-Font]ntpdc\fP. 6059191Skris.SH "OPTIONS" 6159191Skris.TP 6259191Skris.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 6359191SkrisForce IPv4 DNS name resolution. 6459191SkrisThis option must not appear in combination with any of the following options: 6559191Skrisipv6. 6659191Skris.sp 6759191SkrisForce DNS resolution of following host names on the command line 68160814Ssimonto the IPv4 namespace. 69160814Ssimon.TP 7059191Skris.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 7159191SkrisForce IPv6 DNS name resolution. 7259191SkrisThis option must not appear in combination with any of the following options: 7359191Skrisipv4. 74160814Ssimon.sp 7559191SkrisForce DNS resolution of following host names on the command line 76296465Sdelphijto the IPv6 namespace. 77296465Sdelphij.TP 78296465Sdelphij.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 79296465Sdelphijrun a command and exit. 80296465SdelphijThis option may appear an unlimited number of times. 81296465Sdelphij.sp 8259191SkrisThe following argument is interpreted as an interactive format command 8359191Skrisand is added to the list of commands to be executed on the specified 8459191Skrishost(s). 8559191Skris.TP 86296465Sdelphij.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 87296465SdelphijIncrease debug verbosity level. 88296465SdelphijThis option may appear an unlimited number of times. 89296465Sdelphij.sp 90296465Sdelphij.TP 91296465Sdelphij.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 92296465SdelphijSet the debug verbosity level. 93296465SdelphijThis option may appear an unlimited number of times. 94296465SdelphijThis option takes an integer number as its argument. 95296465Sdelphij.sp 96296465Sdelphij.TP 97296465Sdelphij.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 98296465SdelphijForce ntpq to operate in interactive mode. 99296465SdelphijThis option must not appear in combination with any of the following options: 100296465Sdelphijcommand, listpeers, peers, showpeers. 101296465Sdelphij.sp 102296465SdelphijForce ntpq to operate in interactive mode. Prompts will be written 103296465Sdelphijto the standard output and commands read from the standard input. 104296465Sdelphij.TP 105296465Sdelphij.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-listpeers\f[] 106296465SdelphijPrint a list of the peers. 107296465SdelphijThis option must not appear in combination with any of the following options: 108296465Sdelphijcommand. 109296465Sdelphij.sp 110296465SdelphijPrint a list of the peers known to the server as well as a summary of 111111147Snectartheir state. This is equivalent to the 'listpeers' interactive command. 112296465Sdelphij.TP 113111147Snectar.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 114109998Smarkmnumeric host addresses. 115296465Sdelphij.sp 116160814SsimonOutput all host addresses in dotted-quad numeric format rather than 117296465Sdelphijconverting to the canonical host names. 118296465Sdelphij.TP 11959191Skris.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 120296465SdelphijPrint a list of the peers. 121109998SmarkmThis option must not appear in combination with any of the following options: 122296465Sdelphijcommand. 123296465Sdelphij.sp 124296465SdelphijPrint a list of the peers known to the server as well as a summary 125296465Sdelphijof their state. This is equivalent to the 'peers' interactive command. 126109998Smarkm.TP 127296465Sdelphij.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-showpeers\f[] 128296465SdelphijShow a list of the peers. 129109998SmarkmThis option must not appear in combination with any of the following options: 130296465Sdelphijcommand. 131296465Sdelphij.sp 132296465SdelphijPrint a list of the peers known to the server as well as a summary 133296465Sdelphijof their state. This is equivalent to the 'dmpeers' interactive command. 134296465Sdelphij.TP 135296465Sdelphij.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 136296465SdelphijDisplay usage information and exit. 137296465Sdelphij.TP 138296465Sdelphij.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 139296465SdelphijPass the extended usage information through a pager. 140296465Sdelphij.TP 141109998Smarkm.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 142296465SdelphijSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 143296465Sdelphijconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 144296465SdelphijThe command will exit after updating the config file. 145296465Sdelphij.TP 14659191Skris.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[] 147194206SsimonLoad options from \fIcfgfile\fP. 148296465SdelphijThe \fIno-load-opts\fP form will disable the loading 149296465Sdelphijof earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 150194206Ssimonout of order. 151109998Smarkm.TP 152296465Sdelphij.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 153296465SdelphijOutput version of program and exit. The default mode is `v', a simple 154296465Sdelphijversion. The `c' mode will print copyright information and `n' will 155296465Sdelphijprint the full copyright notice. 156296465Sdelphij.PP 157296465Sdelphij.SH "OPTION PRESETS" 15859191SkrisAny option that is not marked as \fInot presettable\fP may be preset 159109998Smarkmby loading values from configuration ("RC" or ".INI") file(s) and values from 160296465Sdelphijenvironment variables named: 161296465Sdelphij.nf 162296465Sdelphij \fBNTPDC_<option-name>\fP or \fBNTPDC\fP 163296465Sdelphij.fi 164296465Sdelphij.ad 165296465SdelphijThe environmental presets take precedence (are processed later than) 166109998Smarkmthe configuration files. 167162911SsimonThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 168296465SdelphijIf any of these are directories, then the file \fI.ntprc\fP 169296465Sdelphijis searched for within those directories. 170296465Sdelphij.SH USAGE 171296465SdelphijIf one or more request options are included on the command line 172296465Sdelphijwhen 173296465Sdelphij\f\*[B-Font]ntpdc\fP 174162911Ssimonis executed, each of the requests will be sent 175296465Sdelphijto the NTP servers running on each of the hosts given as command 176296465Sdelphijline arguments, or on localhost by default. 177296465SdelphijIf no request options 178296465Sdelphijare given, 179296465Sdelphij\f\*[B-Font]ntpdc\fP 180296465Sdelphijwill attempt to read commands from the 181296465Sdelphijstandard input and execute these on the NTP server running on the 182296465Sdelphijfirst host given on the command line, again defaulting to localhost 183296465Sdelphijwhen no other host is specified. 184296465SdelphijThe 185296465Sdelphij\f\*[B-Font]ntpdc\fP 186296465Sdelphijutility will prompt for 187296465Sdelphijcommands if the standard input is a terminal device. 188296465Sdelphij.sp \n(Ppu 189296465Sdelphij.ne 2 190296465Sdelphij 191296465SdelphijThe 192296465Sdelphij\f\*[B-Font]ntpdc\fP 193296465Sdelphijutility uses NTP mode 7 packets to communicate with the 194296465SdelphijNTP server, and hence can be used to query any compatible server on 195296465Sdelphijthe network which permits it. 196296465SdelphijNote that since NTP is a UDP protocol 197296465Sdelphijthis communication will be somewhat unreliable, especially over 198296465Sdelphijlarge distances in terms of network topology. 199296465SdelphijThe 200296465Sdelphij\f\*[B-Font]ntpdc\fP 201296465Sdelphijutility makes 202296465Sdelphijno attempt to retransmit requests, and will time requests out if 203296465Sdelphijthe remote host is not heard from within a suitable timeout 204296465Sdelphijtime. 205296465Sdelphij.sp \n(Ppu 206296465Sdelphij.ne 2 207111147Snectar 208296465SdelphijThe operation of 209296465Sdelphij\f\*[B-Font]ntpdc\fP 210296465Sdelphijare specific to the particular 211296465Sdelphijimplementation of the 212296465Sdelphij\fCntpd\f[]\fR(@NTPD_MS@)\f[] 213296465Sdelphijdaemon and can be expected to 214296465Sdelphijwork only with this and maybe some previous versions of the daemon. 215111147SnectarRequests from a remote 216296465Sdelphij\f\*[B-Font]ntpdc\fP 217296465Sdelphijutility which affect the 218296465Sdelphijstate of the local server must be authenticated, which requires 219296465Sdelphijboth the remote program and local server share a common key and key 220296465Sdelphijidentifier. 221296465Sdelphij.sp \n(Ppu 222296465Sdelphij.ne 2 223296465Sdelphij 224296465SdelphijNote that in contexts where a host name is expected, a 225296465Sdelphij\f\*[B-Font]\-4\f[] 226296465Sdelphijqualifier preceding the host name forces DNS resolution to the IPv4 namespace, 227296465Sdelphijwhile a 228296465Sdelphij\f\*[B-Font]\-6\f[] 229296465Sdelphijqualifier forces DNS resolution to the IPv6 namespace. 230296465SdelphijSpecifying a command line option other than 231296465Sdelphij\f\*[B-Font]\-i\f[] 232296465Sdelphijor 233296465Sdelphij\f\*[B-Font]\-n\f[] 234296465Sdelphijwill cause the specified query (queries) to be sent to 235296465Sdelphijthe indicated host(s) immediately. 236296465SdelphijOtherwise, 237296465Sdelphij\f\*[B-Font]ntpdc\fP 238296465Sdelphijwill 239296465Sdelphijattempt to read interactive format commands from the standard 240296465Sdelphijinput. 241296465Sdelphij.SS "Interactive Commands" 242296465SdelphijInteractive format commands consist of a keyword followed by zero 243296465Sdelphijto four arguments. 244296465SdelphijOnly enough characters of the full keyword to 245296465Sdelphijuniquely identify the command need be typed. 246296465SdelphijThe output of a 247296465Sdelphijcommand is normally sent to the standard output, but optionally the 248296465Sdelphijoutput of individual commands may be sent to a file by appending a 249296465Sdelphij\[oq]\&>\[cq], 250296465Sdelphijfollowed by a file name, to the command line. 251296465Sdelphij.sp \n(Ppu 252296465Sdelphij.ne 2 253296465Sdelphij 254296465SdelphijA number of interactive format commands are executed entirely 255296465Sdelphijwithin the 256296465Sdelphij\f\*[B-Font]ntpdc\fP 257296465Sdelphijutility itself and do not result in NTP 258296465Sdelphijmode 7 requests being sent to a server. 259296465SdelphijThese are described 260296465Sdelphijfollowing. 261296465Sdelphij.TP 7 262296465Sdelphij.NOP \f\*[B-Font]\&?\f[] \f\*[I-Font]command_keyword\f[] 263296465Sdelphij.TP 7 264296465Sdelphij.NOP \f\*[B-Font]help\f[] \f\*[I-Font]command_keyword\f[] 265296465SdelphijA 266296465Sdelphij\[oq]\f\*[B-Font]\&?\f[]\[cq] 267296465Sdelphijwill print a list of all the command 268296465Sdelphijkeywords known to this incarnation of 269296465Sdelphij\f\*[B-Font]ntpdc\fP. 270296465SdelphijA 271296465Sdelphij\[oq]\f\*[B-Font]\&?\f[]\[cq] 272296465Sdelphijfollowed by a command keyword will print function and usage 273296465Sdelphijinformation about the command. 274296465SdelphijThis command is probably a better 275296465Sdelphijsource of information about 276296465Sdelphij\fCntpq\f[]\fR(@NTPQ_MS@)\f[] 277296465Sdelphijthan this manual 278296465Sdelphijpage. 279296465Sdelphij.TP 7 280296465Sdelphij.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] 281296465SdelphijSpecify a time interval to be added to timestamps included in 282296465Sdelphijrequests which require authentication. 283296465SdelphijThis is used to enable 284296465Sdelphij(unreliable) server reconfiguration over long delay network paths 285296465Sdelphijor between machines whose clocks are unsynchronized. 286296465SdelphijActually the 287296465Sdelphijserver does not now require timestamps in authenticated requests, 288296465Sdelphijso this command may be obsolete. 289296465Sdelphij.TP 7 290296465Sdelphij.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] 291296465SdelphijSet the host to which future queries will be sent. 292296465SdelphijHostname may 293296465Sdelphijbe either a host name or a numeric address. 294296465Sdelphij.TP 7 295296465Sdelphij.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] 296296465SdelphijIf 297296465Sdelphij\f\*[B-Font]yes\f[] 298296465Sdelphijis specified, host names are printed in 299296465Sdelphijinformation displays. 300296465SdelphijIf 301296465Sdelphij\f\*[B-Font]no\f[] 302296465Sdelphijis specified, numeric 303296465Sdelphijaddresses are printed instead. 304296465SdelphijThe default is 305296465Sdelphij\f\*[B-Font]yes\f[], 306296465Sdelphijunless 307296465Sdelphijmodified using the command line 308296465Sdelphij\f\*[B-Font]\-n\f[] 309296465Sdelphijswitch. 310296465Sdelphij.TP 7 311296465Sdelphij.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] 312296465SdelphijThis command allows the specification of a key number to be 313296465Sdelphijused to authenticate configuration requests. 314296465SdelphijThis must correspond 315296465Sdelphijto a key number the server has been configured to use for this 316296465Sdelphijpurpose. 317296465Sdelphij.TP 7 31859191Skris.NOP \f\*[B-Font]quit\f[] 319296465SdelphijExit 320296465Sdelphij\f\*[B-Font]ntpdc\fP. 321296465Sdelphij.TP 7 322296465Sdelphij.NOP \f\*[B-Font]passwd\f[] 323296465SdelphijThis command prompts you to type in a password (which will not 324296465Sdelphijbe echoed) which will be used to authenticate configuration 325296465Sdelphijrequests. 326296465SdelphijThe password must correspond to the key configured for 327296465Sdelphijuse by the NTP server for this purpose if such requests are to be 328296465Sdelphijsuccessful. 329296465Sdelphij.TP 7 330296465Sdelphij.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] 331296465SdelphijSpecify a timeout period for responses to server queries. 332296465SdelphijThe 333296465Sdelphijdefault is about 8000 milliseconds. 334296465SdelphijNote that since 335296465Sdelphij\f\*[B-Font]ntpdc\fP 336296465Sdelphijretries each query once after a timeout, the total waiting time for 337296465Sdelphija timeout will be twice the timeout value set. 338296465Sdelphij.PP 339160814Ssimon.SS "Control Message Commands" 340296465SdelphijQuery commands result in NTP mode 7 packets containing requests for 341296465Sdelphijinformation being sent to the server. 342296465SdelphijThese are read-only commands 343296465Sdelphijin that they make no modification of the server configuration 344296465Sdelphijstate. 345296465Sdelphij.TP 7 346296465Sdelphij.NOP \f\*[B-Font]listpeers\f[] 347296465SdelphijObtains and prints a brief list of the peers for which the 348109998Smarkmserver is maintaining state. 349296465SdelphijThese should include all configured 350296465Sdelphijpeer associations as well as those peers whose stratum is such that 35159191Skristhey are considered by the server to be possible future 352194206Ssimonsynchronization candidates. 353296465Sdelphij.TP 7 354194206Ssimon.NOP \f\*[B-Font]peers\f[] 355109998SmarkmObtains a list of peers for which the server is maintaining 356296465Sdelphijstate, along with a summary of that state. 357296465SdelphijSummary information 358296465Sdelphijincludes the address of the remote peer, the local interface 35959191Skrisaddress (0.0.0.0 if a local address has yet to be determined), the 360109998Smarkmstratum of the remote peer (a stratum of 16 indicates the remote 361296465Sdelphijpeer is unsynchronized), the polling interval, in seconds, the 362296465Sdelphijreachability register, in octal, and the current estimated delay, 363296465Sdelphijoffset and dispersion of the peer, all in seconds. 364109998Smarkm.sp \n(Ppu 365162911Ssimon.ne 2 366296465Sdelphij 367296465SdelphijThe character in the left margin indicates the mode this peer 368296465Sdelphijentry is operating in. 369162911SsimonA 370296465Sdelphij\[oq]\&+\[cq] 371296465Sdelphijdenotes symmetric active, a 372296465Sdelphij\[oq]\&-\[cq] 373296465Sdelphijindicates symmetric passive, a 374296465Sdelphij\[oq]\&=\[cq] 375296465Sdelphijmeans the 376296465Sdelphijremote server is being polled in client mode, a 377296465Sdelphij\[oq]\&^\[cq] 378296465Sdelphijindicates that the server is broadcasting to this address, a 379296465Sdelphij\[oq]\&~\[cq] 380296465Sdelphijdenotes that the remote peer is sending broadcasts and a 381296465Sdelphij\[oq]\&~\[cq] 382296465Sdelphijdenotes that the remote peer is sending broadcasts and a 383296465Sdelphij\[oq]\&*\[cq] 384296465Sdelphijmarks the peer the server is currently synchronizing 385296465Sdelphijto. 386296465Sdelphij.sp \n(Ppu 387296465Sdelphij.ne 2 388296465Sdelphij 389296465SdelphijThe contents of the host field may be one of four forms. 390296465SdelphijIt may 391296465Sdelphijbe a host name, an IP address, a reference clock implementation 392296465Sdelphijname with its parameter or 393296465Sdelphij\fBREFCLK\f[]\fR()\f[] 394296465SdelphijOn 395296465Sdelphij\f\*[B-Font]hostnames\f[] 396296465Sdelphij\f\*[B-Font]no\f[] 397296465Sdelphijonly IP-addresses 398296465Sdelphijwill be displayed. 399296465Sdelphij.TP 7 400296465Sdelphij.NOP \f\*[B-Font]dmpeers\f[] 401296465SdelphijA slightly different peer summary list. 402296465SdelphijIdentical to the output 403296465Sdelphijof the 404296465Sdelphij\f\*[B-Font]peers\f[] 405296465Sdelphijcommand, except for the character in the 406296465Sdelphijleftmost column. 407296465SdelphijCharacters only appear beside peers which were 408296465Sdelphijincluded in the final stage of the clock selection algorithm. 409296465SdelphijA 410296465Sdelphij\[oq]\&.\[cq] 411111147Snectarindicates that this peer was cast off in the falseticker 412296465Sdelphijdetection, while a 413296465Sdelphij\[oq]\&+\[cq] 414111147Snectarindicates that the peer made it 415296465Sdelphijthrough. 416296465SdelphijA 417296465Sdelphij\[oq]\&*\[cq] 418296465Sdelphijdenotes the peer the server is currently 419296465Sdelphijsynchronizing with. 420296465Sdelphij.TP 7 421296465Sdelphij.NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 422296465SdelphijShows a detailed display of the current peer variables for one 423296465Sdelphijor more peers. 424296465SdelphijMost of these values are described in the NTP 425111147SnectarVersion 2 specification. 426296465Sdelphij.TP 7 427111147Snectar.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 428109998SmarkmShow per-peer statistic counters associated with the specified 429296465Sdelphijpeer(s). 430296465Sdelphij.TP 7 431296465Sdelphij.NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 432296465SdelphijObtain and print information concerning a peer clock. 43359191SkrisThe 434296465Sdelphijvalues obtained provide information on the setting of fudge factors 435296465Sdelphijand other clock performance information. 436296465Sdelphij.TP 7 437296465Sdelphij.NOP \f\*[B-Font]kerninfo\f[] 438296465SdelphijObtain and print kernel phase-lock loop operating parameters. 439296465SdelphijThis information is available only if the kernel has been specially 44059191Skrismodified for a precision timekeeping function. 441296465Sdelphij.TP 7 44259191Skris.NOP \f\*[B-Font]loopinfo\f[] [\f\*[B-Font]oneline\f[] | \f\*[B-Font]multiline\f[]] 443296465SdelphijPrint the values of selected loop filter variables. 444296465SdelphijThe loop 44559191Skrisfilter is the part of NTP which deals with adjusting the local 446296465Sdelphijsystem clock. 447296465SdelphijThe 448296465Sdelphij\[oq]offset\[cq] 449296465Sdelphijis the last offset given to the 450296465Sdelphijloop filter by the packet processing code. 451296465SdelphijThe 452296465Sdelphij\[oq]frequency\[cq] 453296465Sdelphijis the frequency error of the local clock in parts-per-million 454296465Sdelphij(ppm). 455296465SdelphijThe 456296465Sdelphij\[oq]time_const\[cq] 45759191Skriscontrols the stiffness of the 458296465Sdelphijphase-lock loop and thus the speed at which it can adapt to 459296465Sdelphijoscillator drift. 460296465SdelphijThe 461296465Sdelphij\[oq]watchdog timer\[cq] 46259191Skrisvalue is the number 463296465Sdelphijof seconds which have elapsed since the last sample offset was 464296465Sdelphijgiven to the loop filter. 46559191SkrisThe 466296465Sdelphij\f\*[B-Font]oneline\f[] 467296465Sdelphijand 468296465Sdelphij\f\*[B-Font]multiline\f[] 469296465Sdelphijoptions specify the format in which this 470296465Sdelphijinformation is to be printed, with 471296465Sdelphij\f\*[B-Font]multiline\f[] 472296465Sdelphijas the 473296465Sdelphijdefault. 474296465Sdelphij.TP 7 475109998Smarkm.NOP \f\*[B-Font]sysinfo\f[] 476296465SdelphijPrint a variety of system state variables, i.e., state related 477296465Sdelphijto the local server. 478296465SdelphijAll except the last four lines are described 479296465Sdelphijin the NTP Version 3 specification, RFC-1305. 480296465Sdelphij.sp \n(Ppu 481296465Sdelphij.ne 2 482296465Sdelphij 48359191SkrisThe 484296465Sdelphij\[oq]system flags\[cq] 485296465Sdelphijshow various system flags, some of 486296465Sdelphijwhich can be set and cleared by the 487296465Sdelphij\f\*[B-Font]enable\f[] 488296465Sdelphijand 489296465Sdelphij\f\*[B-Font]disable\f[] 490296465Sdelphijconfiguration commands, respectively. 491109998SmarkmThese are 492296465Sdelphijthe 493296465Sdelphij\f\*[B-Font]auth\f[], 494296465Sdelphij\f\*[B-Font]bclient\f[], 49559191Skris\f\*[B-Font]monitor\f[], 496296465Sdelphij\f\*[B-Font]pll\f[], 497296465Sdelphij\f\*[B-Font]pps\f[] 498296465Sdelphijand 499296465Sdelphij\f\*[B-Font]stats\f[] 500296465Sdelphijflags. 501296465SdelphijSee the 502109998Smarkm\fCntpd\f[]\fR(@NTPD_MS@)\f[] 503296465Sdelphijdocumentation for the meaning of these flags. 504296465SdelphijThere 505296465Sdelphijare two additional flags which are read only, the 506296465Sdelphij\f\*[B-Font]kernel_pll\f[] 50759191Skrisand 508296465Sdelphij\f\*[B-Font]kernel_pps\f[]. 509296465SdelphijThese flags indicate 510296465Sdelphijthe synchronization status when the precision time kernel 511296465Sdelphijmodifications are in use. 512296465SdelphijThe 513296465Sdelphij\[oq]kernel_pll\[cq] 514296465Sdelphijindicates that 515109998Smarkmthe local clock is being disciplined by the kernel, while the 516296465Sdelphij\[oq]kernel_pps\[cq] 517296465Sdelphijindicates the kernel discipline is provided by the PPS 518296465Sdelphijsignal. 519296465Sdelphij.sp \n(Ppu 52059191Skris.ne 2 521296465Sdelphij 522296465SdelphijThe 523296465Sdelphij\[oq]stability\[cq] 524296465Sdelphijis the residual frequency error remaining 525296465Sdelphijafter the system frequency correction is applied and is intended for 526296465Sdelphijmaintenance and debugging. 527296465SdelphijIn most architectures, this value will 528296465Sdelphijinitially decrease from as high as 500 ppm to a nominal value in 52959191Skristhe range .01 to 0.1 ppm. 530296465SdelphijIf it remains high for some time after 531296465Sdelphijstarting the daemon, something may be wrong with the local clock, 532296465Sdelphijor the value of the kernel variable 533296465Sdelphij\fIkern.clockrate.tick\f[] 534296465Sdelphijmay be 535296465Sdelphijincorrect. 53659191Skris.sp \n(Ppu 537296465Sdelphij.ne 2 538296465Sdelphij 539296465SdelphijThe 540296465Sdelphij\[oq]broadcastdelay\[cq] 541296465Sdelphijshows the default broadcast delay, 542296465Sdelphijas set by the 543296465Sdelphij\f\*[B-Font]broadcastdelay\f[] 54459191Skrisconfiguration command. 545296465Sdelphij.sp \n(Ppu 546296465Sdelphij.ne 2 547296465Sdelphij 548296465SdelphijThe 549296465Sdelphij\[oq]authdelay\[cq] 550296465Sdelphijshows the default authentication delay, 551296465Sdelphijas set by the 552109998Smarkm\f\*[B-Font]authdelay\f[] 553296465Sdelphijconfiguration command. 554296465Sdelphij.TP 7 555296465Sdelphij.NOP \f\*[B-Font]sysstats\f[] 556296465SdelphijPrint statistics counters maintained in the protocol 55768651Skrismodule. 558296465Sdelphij.TP 7 55959191Skris.NOP \f\*[B-Font]memstats\f[] 560296465SdelphijPrint statistics counters related to memory allocation 561296465Sdelphijcode. 562296465Sdelphij.TP 7 563296465Sdelphij.NOP \f\*[B-Font]iostats\f[] 564296465SdelphijPrint statistics counters maintained in the input-output 565296465Sdelphijmodule. 566296465Sdelphij.TP 7 56759191Skris.NOP \f\*[B-Font]timerstats\f[] 568296465SdelphijPrint statistics counters maintained in the timer/event queue 569109998Smarkmsupport code. 570296465Sdelphij.TP 7 571296465Sdelphij.NOP \f\*[B-Font]reslist\f[] 572296465SdelphijObtain and print the server's restriction list. 573296465SdelphijThis list is 574296465Sdelphij(usually) printed in sorted order and may help to understand how 575296465Sdelphijthe restrictions are applied. 576296465Sdelphij.TP 7 577296465Sdelphij.NOP \f\*[B-Font]monlist\f[] [\f\*[I-Font]version\f[]] 578296465SdelphijObtain and print traffic counts collected and maintained by the 579296465Sdelphijmonitor facility. 580296465SdelphijThe version number should not normally need to be 581296465Sdelphijspecified. 582296465Sdelphij.TP 7 583296465Sdelphij.NOP \f\*[B-Font]clkbug\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 584296465SdelphijObtain debugging information for a reference clock driver. 585296465SdelphijThis 586296465Sdelphijinformation is provided only by some clock drivers and is mostly 587296465Sdelphijundecodable without a copy of the driver source in hand. 588296465Sdelphij.PP 589296465Sdelphij.SS "Runtime Configuration Requests" 59059191SkrisAll requests which cause state changes in the server are 591296465Sdelphijauthenticated by the server using a configured NTP key (the 592296465Sdelphijfacility can also be disabled by the server by not configuring a 593296465Sdelphijkey). 594296465SdelphijThe key number and the corresponding key must also be made 595296465Sdelphijknown to 596296465Sdelphij\f\*[B-Font]ntpdc\fP. 597296465SdelphijThis can be done using the 598296465Sdelphij\f\*[B-Font]keyid\f[] 599296465Sdelphijand 600296465Sdelphij\f\*[B-Font]passwd\f[] 601296465Sdelphijcommands, the latter of which will prompt at the terminal for a 602296465Sdelphijpassword to use as the encryption key. 60368651SkrisYou will also be prompted 604296465Sdelphijautomatically for both the key number and password the first time a 605296465Sdelphijcommand which would result in an authenticated request to the 606296465Sdelphijserver is given. 607296465SdelphijAuthentication not only provides verification that 60859191Skristhe requester has permission to make such changes, but also gives 609296465Sdelphijan extra degree of protection again transmission errors. 610296465Sdelphij.sp \n(Ppu 611296465Sdelphij.ne 2 612296465Sdelphij 613296465SdelphijAuthenticated requests always include a timestamp in the packet 614296465Sdelphijdata, which is included in the computation of the authentication 615296465Sdelphijcode. 616296465SdelphijThis timestamp is compared by the server to its receive time 617296465Sdelphijstamp. 618296465SdelphijIf they differ by more than a small amount the request is 619296465Sdelphijrejected. 620296465SdelphijThis is done for two reasons. 621296465SdelphijFirst, it makes simple 622296465Sdelphijreplay attacks on the server, by someone who might be able to 623296465Sdelphijoverhear traffic on your LAN, much more difficult. 624296465SdelphijSecond, it makes 625296465Sdelphijit more difficult to request configuration changes to your server 626296465Sdelphijfrom topologically remote hosts. 627296465SdelphijWhile the reconfiguration facility 628296465Sdelphijwill work well with a server on the local host, and may work 629296465Sdelphijadequately between time-synchronized hosts on the same LAN, it will 630296465Sdelphijwork very poorly for more distant hosts. 631296465SdelphijAs such, if reasonable 632296465Sdelphijpasswords are chosen, care is taken in the distribution and 633296465Sdelphijprotection of keys and appropriate source address restrictions are 634296465Sdelphijapplied, the run time reconfiguration facility should provide an 635296465Sdelphijadequate level of security. 636296465Sdelphij.sp \n(Ppu 637296465Sdelphij.ne 2 638296465Sdelphij 639296465SdelphijThe following commands all make authenticated requests. 640296465Sdelphij.TP 7 641296465Sdelphij.NOP \f\*[B-Font]addpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 642296465SdelphijAdd a configured peer association at the given address and 643296465Sdelphijoperating in symmetric active mode. 644296465SdelphijNote that an existing 645296465Sdelphijassociation with the same peer may be deleted when this command is 646296465Sdelphijexecuted, or may simply be converted to conform to the new 647296465Sdelphijconfiguration, as appropriate. 648296465SdelphijIf the optional 649296465Sdelphij\f\*[I-Font]keyid\f[] 650296465Sdelphijis a 651296465Sdelphijnonzero integer, all outgoing packets to the remote server will 652296465Sdelphijhave an authentication field attached encrypted with this key. 653296465SdelphijIf 654296465Sdelphijthe value is 0 (or not given) no authentication will be done. 655296465SdelphijThe 656296465Sdelphij\f\*[I-Font]version\f[] 657296465Sdelphijcan be 1, 2 or 3 and defaults to 3. 658296465SdelphijThe 659296465Sdelphij\f\*[B-Font]prefer\f[] 660296465Sdelphijkeyword indicates a preferred peer (and thus will 661296465Sdelphijbe used primarily for clock synchronisation if possible). 662296465SdelphijThe 663296465Sdelphijpreferred peer also determines the validity of the PPS signal \- if 664296465Sdelphijthe preferred peer is suitable for synchronisation so is the PPS 665296465Sdelphijsignal. 666296465Sdelphij.TP 7 667296465Sdelphij.NOP \f\*[B-Font]addserver\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 668296465SdelphijIdentical to the addpeer command, except that the operating 669296465Sdelphijmode is client. 670296465Sdelphij.TP 7 671296465Sdelphij.NOP \f\*[B-Font]broadcast\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] 67259191SkrisIdentical to the addpeer command, except that the operating 67359191Skrismode is broadcast. 67459191SkrisIn this case a valid key identifier and key are 675296465Sdelphijrequired. 676296465SdelphijThe 677296465Sdelphij\f\*[I-Font]peer_address\f[] 678296465Sdelphijparameter can be the broadcast 679296465Sdelphijaddress of the local network or a multicast group address assigned 680296465Sdelphijto NTP. 681296465SdelphijIf a multicast address, a multicast-capable kernel is 682296465Sdelphijrequired. 683296465Sdelphij.TP 7 684296465Sdelphij.NOP \f\*[B-Font]unconfig\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 685296465SdelphijThis command causes the configured bit to be removed from the 686296465Sdelphijspecified peer(s). 687296465SdelphijIn many cases this will cause the peer 688160814Ssimonassociation to be deleted. 689160814SsimonWhen appropriate, however, the 690160814Ssimonassociation may persist in an unconfigured mode if the remote peer 691160814Ssimonis willing to continue on in this fashion. 692296465Sdelphij.TP 7 693296465Sdelphij.NOP \f\*[B-Font]fudge\f[] \f\*[I-Font]peer_address\f[] [\f\*[B-Font]time1\f[]] [\f\*[B-Font]time2\f[]] [\f\*[I-Font]stratum\f[]] [\f\*[I-Font]refid\f[]] 694160814SsimonThis command provides a way to set certain data for a reference 695296465Sdelphijclock. 696160814SsimonSee the source listing for further information. 697296465Sdelphij.TP 7 698296465Sdelphij.NOP \f\*[B-Font]enable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]] 699296465Sdelphij.TP 7 700160814Ssimon.NOP \f\*[B-Font]disable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]] 701296465SdelphijThese commands operate in the same way as the 702160814Ssimon\f\*[B-Font]enable\f[] 703296465Sdelphijand 704160814Ssimon\f\*[B-Font]disable\f[] 705296465Sdelphijconfiguration file commands of 706\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 707.RS 708.TP 7 709.NOP \f\*[B-Font]auth\f[] 710Enables the server to synchronize with unconfigured peers only 711if the peer has been correctly authenticated using either public key 712or private key cryptography. 713The default for this flag is enable. 714.TP 7 715.NOP \f\*[B-Font]bclient\f[] 716Enables the server to listen for a message from a broadcast or 717multicast server, as in the multicastclient command with 718default address. 719The default for this flag is disable. 720.TP 7 721.NOP \f\*[B-Font]calibrate\f[] 722Enables the calibrate feature for reference clocks. 723The default for this flag is disable. 724.TP 7 725.NOP \f\*[B-Font]kernel\f[] 726Enables the kernel time discipline, if available. 727The default for this flag is enable if support is available, otherwise disable. 728.TP 7 729.NOP \f\*[B-Font]monitor\f[] 730Enables the monitoring facility. 731See the documentation here about the 732\f\*[B-Font]monlist\f[] 733command or further information. 734The default for this flag is enable. 735.TP 7 736.NOP \f\*[B-Font]ntp\f[] 737Enables time and frequency discipline. 738In effect, this switch opens and closes the feedback loop, 739which is useful for testing. 740The default for this flag is enable. 741.TP 7 742.NOP \f\*[B-Font]pps\f[] 743Enables the pulse-per-second (PPS) signal when frequency 744and time is disciplined by the precision time kernel modifications. 745See the 746"A Kernel Model for Precision Timekeeping" 747(available as part of the HTML documentation 748provided in 749\fI/usr/share/doc/ntp\f[]) 750page for further information. 751The default for this flag is disable. 752.TP 7 753.NOP \f\*[B-Font]stats\f[] 754Enables the statistics facility. 755See the 756\fIMonitoring\f[] \fIOptions\f[] 757section of 758\fCntp.conf\f[]\fR(5)\f[] 759for further information. 760The default for this flag is disable. 761.RE 762.TP 7 763.NOP \f\*[B-Font]restrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] 764This command operates in the same way as the 765\f\*[B-Font]restrict\f[] 766configuration file commands of 767\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 768.TP 7 769.NOP \f\*[B-Font]unrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] 770Unrestrict the matching entry from the restrict list. 771.TP 7 772.NOP \f\*[B-Font]delrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] [\f\*[B-Font]ntpport\f[]] 773Delete the matching entry from the restrict list. 774.TP 7 775.NOP \f\*[B-Font]readkeys\f[] 776Causes the current set of authentication keys to be purged and 777a new set to be obtained by rereading the keys file (which must 778have been specified in the 779\fCntpd\f[]\fR(@NTPD_MS@)\f[] 780configuration file). 781This 782allows encryption keys to be changed without restarting the 783server. 784.TP 7 785.NOP \f\*[B-Font]trustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]] 786.TP 7 787.NOP \f\*[B-Font]untrustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]] 788These commands operate in the same way as the 789\f\*[B-Font]trustedkey\f[] 790and 791\f\*[B-Font]untrustedkey\f[] 792configuration file 793commands of 794\fCntpd\f[]\fR(@NTPD_MS@)\f[]. 795.TP 7 796.NOP \f\*[B-Font]authinfo\f[] 797Returns information concerning the authentication module, 798including known keys and counts of encryptions and decryptions 799which have been done. 800.TP 7 801.NOP \f\*[B-Font]traps\f[] 802Display the traps set in the server. 803See the source listing for 804further information. 805.TP 7 806.NOP \f\*[B-Font]addtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] 807Set a trap for asynchronous messages. 808See the source listing 809for further information. 810.TP 7 811.NOP \f\*[B-Font]clrtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] 812Clear a trap for asynchronous messages. 813See the source listing 814for further information. 815.TP 7 816.NOP \f\*[B-Font]reset\f[] 817Clear the statistics counters in various modules of the server. 818See the source listing for further information. 819.PP 820.SH "ENVIRONMENT" 821See \fBOPTION PRESETS\fP for configuration environment variables. 822.SH "FILES" 823See \fBOPTION PRESETS\fP for configuration files. 824.SH "EXIT STATUS" 825One of the following exit values will be returned: 826.TP 827.NOP 0 " (EXIT_SUCCESS)" 828Successful program execution. 829.TP 830.NOP 1 " (EXIT_FAILURE)" 831The operation failed or the command syntax was not valid. 832.TP 833.NOP 66 " (EX_NOINPUT)" 834A specified configuration file could not be loaded. 835.TP 836.NOP 70 " (EX_SOFTWARE)" 837libopts had an internal operational error. Please report 838it to autogen-users@lists.sourceforge.net. Thank you. 839.PP 840.SH "SEE ALSO" 841\fCntp.conf\f[]\fR(5)\f[], 842\fCntpd\f[]\fR(@NTPD_MS@)\f[] 843David L. Mills, 844\fINetwork Time Protocol (Version 3)\fR, 845RFC1305 846.PP 847 848.SH AUTHORS 849The formatting directives in this document came from FreeBSD. 850.SH "COPYRIGHT" 851Copyright (C) 1992-2017 The University of Delaware and Network Time Foundation all rights reserved. 852This program is released under the terms of the NTP license, <http://ntp.org/license>. 853.SH BUGS 854The 855\f\*[B-Font]ntpdc\fP 856utility is a crude hack. 857Much of the information it shows is 858deadly boring and could only be loved by its implementer. 859The 860program was designed so that new (and temporary) features were easy 861to hack in, at great expense to the program's ease of use. 862Despite 863this, the program is occasionally useful. 864.sp \n(Ppu 865.ne 2 866 867Please report bugs to http://bugs.ntp.org . 868.sp \n(Ppu 869.ne 2 870 871Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org 872.SH "NOTES" 873This manual page was \fIAutoGen\fP-erated from the \fBntpdc\fP 874option definitions. 875