ntpdc.1ntpdcman revision 298770
1184588Sdfr.de1 NOP 2184588Sdfr. it 1 an-trap 3184588Sdfr. if \\n[.$] \,\\$*\/ 4184588Sdfr.. 5184588Sdfr.ie t \ 6184588Sdfr.ds B-Font [CB] 7184588Sdfr.ds I-Font [CI] 8184588Sdfr.ds R-Font [CR] 9184588Sdfr.el \ 10184588Sdfr.ds B-Font B 11184588Sdfr.ds I-Font I 12184588Sdfr.ds R-Font R 13184588Sdfr.TH ntpdc 1ntpdcman "26 Apr 2016" "4.2.8p7" "User Commands" 14184588Sdfr.\" 15184588Sdfr.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-bTaatH/ag-nTa4rH) 16184588Sdfr.\" 17184588Sdfr.\" It has been AutoGen-ed April 26, 2016 at 08:29:01 PM by AutoGen 5.18.5 18184588Sdfr.\" From the definitions ntpdc-opts.def 19184588Sdfr.\" and the template file agman-cmd.tpl 20184588Sdfr.SH NAME 21184588Sdfr\f\*[B-Font]ntpdc\fP 22184588Sdfr\- vendor-specific NTPD control program 23184588Sdfr.SH SYNOPSIS 24184588Sdfr\f\*[B-Font]ntpdc\fP 25184588Sdfr.\" Mixture of short (flag) options and long options 26184588Sdfr[\f\*[B-Font]\-flags\f[]] 27184588Sdfr[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 28184588Sdfr[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 29184588Sdfr[ host ...] 30184588Sdfr.sp \n(Ppu 31184588Sdfr.ne 2 32184588Sdfr 33184588Sdfr.SH DESCRIPTION 34184588Sdfr\f\*[B-Font]ntpdc\fP 35184588Sdfris deprecated. 36184588SdfrPlease use 37184588Sdfr\fCntpq\f[]\fR(1ntpqmdoc)\f[] instead \- it can do everything 38184588Sdfr\f\*[B-Font]ntpdc\fP 39184588Sdfrused to do, and it does so using a much more sane interface. 40184588Sdfr.sp \n(Ppu 41249596Sken.ne 2 42184588Sdfr 43184588Sdfr\f\*[B-Font]ntpdc\fP 44184588Sdfris a utility program used to query 45201899Smarius\fCntpd\f[]\fR(1ntpdmdoc)\f[] 46249592Skenabout its 47249592Skencurrent state and to request changes in that state. 48184588SdfrIt uses NTP mode 7 control message formats described in the source code. 49249592SkenThe program may 50184588Sdfrbe run either in interactive mode or controlled using command line 51249592Skenarguments. 52249592SkenExtensive state and statistics information is available 53184588Sdfrthrough the 54249592Sken\f\*[B-Font]ntpdc\fP 55261054Smavinterface. 56184588SdfrIn addition, nearly all the 57261054Smavconfiguration options which can be specified at startup using 58261054Smavntpd's configuration file may also be specified at run time using 59184588Sdfr\f\*[B-Font]ntpdc\fP. 60184588Sdfr.SH "OPTIONS" 61249592Sken.TP 62184588Sdfr.NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 63249592SkenForce IPv4 DNS name resolution. 64249592SkenThis option must not appear in combination with any of the following options: 65249592Skenipv6. 66249592Sken.sp 67184588SdfrForce DNS resolution of following host names on the command line 68249592Skento the IPv4 namespace. 69249592Sken.TP 70249592Sken.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 71249592SkenForce IPv6 DNS name resolution. 72249592SkenThis option must not appear in combination with any of the following options: 73249592Skenipv4. 74249592Sken.sp 75249592SkenForce DNS resolution of following host names on the command line 76249592Skento the IPv6 namespace. 77249592Sken.TP 78249592Sken.NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 79249592Skenrun a command and exit. 80249592SkenThis option may appear an unlimited number of times. 81249592Sken.sp 82249592SkenThe following argument is interpreted as an interactive format command 83249592Skenand is added to the list of commands to be executed on the specified 84184588Sdfrhost(s). 85249592Sken.TP 86249592Sken.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 87249592SkenIncrease debug verbosity level. 88249592SkenThis option may appear an unlimited number of times. 89249592Sken.sp 90249592Sken.TP 91249592Sken.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 92249592SkenSet the debug verbosity level. 93249592SkenThis option may appear an unlimited number of times. 94184588SdfrThis option takes an integer number as its argument. 95249592Sken.sp 96184588Sdfr.TP 97184588Sdfr.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 98249592SkenForce ntpq to operate in interactive mode. 99184588SdfrThis option must not appear in combination with any of the following options: 100249592Skencommand, listpeers, peers, showpeers. 101184588Sdfr.sp 102184588SdfrForce ntpq to operate in interactive mode. Prompts will be written 103249592Skento the standard output and commands read from the standard input. 104184588Sdfr.TP 105249592Sken.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-listpeers\f[] 106184588SdfrPrint a list of the peers. 107184588SdfrThis option must not appear in combination with any of the following options: 108249592Skencommand. 109184588Sdfr.sp 110249592SkenPrint a list of the peers known to the server as well as a summary of 111249592Skentheir state. This is equivalent to the 'listpeers' interactive command. 112184588Sdfr.TP 113184588Sdfr.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 114249592Skennumeric host addresses. 115249592Sken.sp 116184588SdfrOutput all host addresses in dotted-quad numeric format rather than 117261054Smavconverting to the canonical host names. 118261054Smav.TP 119249592Sken.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 120261054SmavPrint a list of the peers. 121261054SmavThis option must not appear in combination with any of the following options: 122184588Sdfrcommand. 123184588Sdfr.sp 124201899SmariusPrint a list of the peers known to the server as well as a summary 125184588Sdfrof their state. This is equivalent to the 'peers' interactive command. 126184588Sdfr.TP 127184588Sdfr.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-showpeers\f[] 128184588SdfrShow a list of the peers. 129249592SkenThis option must not appear in combination with any of the following options: 130249592Skencommand. 131184588Sdfr.sp 132201896SmariusPrint a list of the peers known to the server as well as a summary 133201896Smariusof their state. This is equivalent to the 'dmpeers' interactive command. 134184588Sdfr.TP 135184588Sdfr.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 136184588SdfrDisplay usage information and exit. 137184588Sdfr.TP 138184588Sdfr.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 139201899SmariusPass the extended usage information through a pager. 140201899Smarius.TP 141201899Smarius.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 142184588SdfrSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 143184588Sdfrconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 144184588SdfrThe command will exit after updating the config file. 145184588Sdfr.TP 146184588Sdfr.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[] 147201899SmariusLoad options from \fIcfgfile\fP. 148184588SdfrThe \fIno-load-opts\fP form will disable the loading 149184744Sdfrof earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 150201899Smariusout of order. 151184744Sdfr.TP 152184588Sdfr.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 153184588SdfrOutput version of program and exit. The default mode is `v', a simple 154184744Sdfrversion. The `c' mode will print copyright information and `n' will 155249592Skenprint the full copyright notice. 156249592Sken.PP 157249592Sken.SH "OPTION PRESETS" 158249592SkenAny option that is not marked as \fInot presettable\fP may be preset 159184744Sdfrby loading values from configuration ("RC" or ".INI") file(s) and values from 160249592Skenenvironment variables named: 161184744Sdfr.nf 162184588Sdfr \fBNTPDC_<option-name>\fP or \fBNTPDC\fP 163201899Smarius.fi 164201899Smarius.ad 165201899SmariusThe environmental presets take precedence (are processed later than) 166201899Smariusthe configuration files. 167184588SdfrThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 168184588SdfrIf any of these are directories, then the file \fI.ntprc\fP 169249592Skenis searched for within those directories. 170184588Sdfr.SH USAGE 171201899SmariusIf one or more request options are included on the command line 172249592Skenwhen 173203732Smarius\f\*[B-Font]ntpdc\fP 174203732Smariusis executed, each of the requests will be sent 175201896Smariusto the NTP servers running on each of the hosts given as command 176201896Smariusline arguments, or on localhost by default. 177201896SmariusIf no request options 178184588Sdfrare given, 179261049Smav\f\*[B-Font]ntpdc\fP 180184588Sdfrwill attempt to read commands from the 181184588Sdfrstandard input and execute these on the NTP server running on the 182184588Sdfrfirst host given on the command line, again defaulting to localhost 183184588Sdfrwhen no other host is specified. 184249592SkenThe 185249592Sken\f\*[B-Font]ntpdc\fP 186184588Sdfrutility will prompt for 187249592Skencommands if the standard input is a terminal device. 188249592Sken.sp \n(Ppu 189184588Sdfr.ne 2 190184588Sdfr 191184588SdfrThe 192184588Sdfr\f\*[B-Font]ntpdc\fP 193184588Sdfrutility uses NTP mode 7 packets to communicate with the 194184588SdfrNTP server, and hence can be used to query any compatible server on 195184588Sdfrthe network which permits it. 196184588SdfrNote that since NTP is a UDP protocol 197184588Sdfrthis communication will be somewhat unreliable, especially over 198249592Skenlarge distances in terms of network topology. 199249592SkenThe 200184588Sdfr\f\*[B-Font]ntpdc\fP 201184588Sdfrutility makes 202201899Smariusno attempt to retransmit requests, and will time requests out if 203201899Smariusthe remote host is not heard from within a suitable timeout 204184588Sdfrtime. 205184588Sdfr.sp \n(Ppu 206184588Sdfr.ne 2 207184588Sdfr 208184588SdfrThe operation of 209184588Sdfr\f\*[B-Font]ntpdc\fP 210261054Smavare specific to the particular 211261054Smavimplementation of the 212261054Smav\fCntpd\f[]\fR(1ntpdmdoc)\f[] 213261054Smavdaemon and can be expected to 214261054Smavwork only with this and maybe some previous versions of the daemon. 215261054SmavRequests from a remote 216261054Smav\f\*[B-Font]ntpdc\fP 217184588Sdfrutility which affect the 218184588Sdfrstate of the local server must be authenticated, which requires 219184588Sdfrboth the remote program and local server share a common key and key 220184588Sdfridentifier. 221184588Sdfr.sp \n(Ppu 222184588Sdfr.ne 2 223184588Sdfr 224261054SmavNote that in contexts where a host name is expected, a 225184588Sdfr\f\*[B-Font]\-4\f[] 226184588Sdfrqualifier preceding the host name forces DNS resolution to the IPv4 namespace, 227184588Sdfrwhile a 228184588Sdfr\f\*[B-Font]\-6\f[] 229184588Sdfrqualifier forces DNS resolution to the IPv6 namespace. 230249592SkenSpecifying a command line option other than 231184588Sdfr\f\*[B-Font]\-i\f[] 232249592Skenor 233261054Smav\f\*[B-Font]\-n\f[] 234261054Smavwill cause the specified query (queries) to be sent to 235249592Skenthe indicated host(s) immediately. 236249592SkenOtherwise, 237261054Smav\f\*[B-Font]ntpdc\fP 238261054Smavwill 239261054Smavattempt to read interactive format commands from the standard 240261054Smavinput. 241261054Smav.SS "Interactive Commands" 242184588SdfrInteractive format commands consist of a keyword followed by zero 243184588Sdfrto four arguments. 244184588SdfrOnly enough characters of the full keyword to 245261054Smavuniquely identify the command need be typed. 246261054SmavThe output of a 247261054Smavcommand is normally sent to the standard output, but optionally the 248261054Smavoutput of individual commands may be sent to a file by appending a 249201899Smarius\[oq]\&>\[cq], 250184588Sdfrfollowed by a file name, to the command line. 251184588Sdfr.sp \n(Ppu 252184588Sdfr.ne 2 253184588Sdfr 254184588SdfrA number of interactive format commands are executed entirely 255201899Smariuswithin the 256261054Smav\f\*[B-Font]ntpdc\fP 257261054Smavutility itself and do not result in NTP 258184588Sdfrmode 7 requests being sent to a server. 259184588SdfrThese are described 260184588Sdfrfollowing. 261184588Sdfr.TP 7 262184588Sdfr.NOP \f\*[B-Font]\&?\f[] \f\*[I-Font]command_keyword\f[] 263184588Sdfr.TP 7 264184588Sdfr.NOP \f\*[B-Font]help\f[] \f\*[I-Font]command_keyword\f[] 265184588SdfrA 266261054Smav\[oq]\f\*[B-Font]\&?\f[]\[cq] 267261054Smavwill print a list of all the command 268261054Smavkeywords known to this incarnation of 269184588Sdfr\f\*[B-Font]ntpdc\fP. 270184588SdfrA 271184588Sdfr\[oq]\f\*[B-Font]\&?\f[]\[cq] 272184588Sdfrfollowed by a command keyword will print function and usage 273201899Smariusinformation about the command. 274184588SdfrThis command is probably a better 275184588Sdfrsource of information about 276184588Sdfr\fCntpq\f[]\fR(1ntpqmdoc)\f[] 277184588Sdfrthan this manual 278184588Sdfrpage. 279184588Sdfr.TP 7 280261054Smav.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] 281184588SdfrSpecify a time interval to be added to timestamps included in 282249592Skenrequests which require authentication. 283184588SdfrThis is used to enable 284249592Sken(unreliable) server reconfiguration over long delay network paths 285184588Sdfror between machines whose clocks are unsynchronized. 286184588SdfrActually the 287201899Smariusserver does not now require timestamps in authenticated requests, 288184588Sdfrso this command may be obsolete. 289184588Sdfr.TP 7 290184588Sdfr.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] 291267740SmavSet the host to which future queries will be sent. 292249592SkenHostname may 293249592Skenbe either a host name or a numeric address. 294184588Sdfr.TP 7 295184588Sdfr.NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] 296249592SkenIf 297184588Sdfr\f\*[B-Font]yes\f[] 298184588Sdfris specified, host names are printed in 299184588Sdfrinformation displays. 300249592SkenIf 301249592Sken\f\*[B-Font]no\f[] 302184588Sdfris specified, numeric 303261054Smavaddresses are printed instead. 304184588SdfrThe default is 305184588Sdfr\f\*[B-Font]yes\f[], 306249592Skenunless 307184588Sdfrmodified using the command line 308201899Smarius\f\*[B-Font]\-n\f[] 309184588Sdfrswitch. 310184588Sdfr.TP 7 311184588Sdfr.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] 312184588SdfrThis command allows the specification of a key number to be 313184588Sdfrused to authenticate configuration requests. 314201899SmariusThis must correspond 315201899Smariusto a key number the server has been configured to use for this 316201899Smariuspurpose. 317184588Sdfr.TP 7 318249592Sken.NOP \f\*[B-Font]quit\f[] 319261054SmavExit 320249592Sken\f\*[B-Font]ntpdc\fP. 321249592Sken.TP 7 322249592Sken.NOP \f\*[B-Font]passwd\f[] 323249592SkenThis command prompts you to type in a password (which will not 324249592Skenbe echoed) which will be used to authenticate configuration 325249592Skenrequests. 326249592SkenThe password must correspond to the key configured for 327184588Sdfruse by the NTP server for this purpose if such requests are to be 328201899Smariussuccessful. 329184588Sdfr.TP 7 330184588Sdfr.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] 331184588SdfrSpecify a timeout period for responses to server queries. 332184588SdfrThe 333184588Sdfrdefault is about 8000 milliseconds. 334184588SdfrNote that since 335201899Smarius\f\*[B-Font]ntpdc\fP 336184588Sdfrretries each query once after a timeout, the total waiting time for 337201899Smariusa timeout will be twice the timeout value set. 338184588Sdfr.PP 339184588Sdfr.SS "Control Message Commands" 340184588SdfrQuery commands result in NTP mode 7 packets containing requests for 341201899Smariusinformation being sent to the server. 342201899SmariusThese are read-only commands 343184588Sdfrin that they make no modification of the server configuration 344184588Sdfrstate. 345184588Sdfr.TP 7 346184588Sdfr.NOP \f\*[B-Font]listpeers\f[] 347184588SdfrObtains and prints a brief list of the peers for which the 348184588Sdfrserver is maintaining state. 349184588SdfrThese should include all configured 350184588Sdfrpeer associations as well as those peers whose stratum is such that 351201899Smariusthey are considered by the server to be possible future 352201899Smariussynchronization candidates. 353184588Sdfr.TP 7 354184588Sdfr.NOP \f\*[B-Font]peers\f[] 355249592SkenObtains a list of peers for which the server is maintaining 356249592Skenstate, along with a summary of that state. 357261054SmavSummary information 358184588Sdfrincludes the address of the remote peer, the local interface 359261054Smavaddress (0.0.0.0 if a local address has yet to be determined), the 360261054Smavstratum of the remote peer (a stratum of 16 indicates the remote 361184588Sdfrpeer is unsynchronized), the polling interval, in seconds, the 362184588Sdfrreachability register, in octal, and the current estimated delay, 363184588Sdfroffset and dispersion of the peer, all in seconds. 364201899Smarius.sp \n(Ppu 365201899Smarius.ne 2 366184588Sdfr 367184588SdfrThe character in the left margin indicates the mode this peer 368184588Sdfrentry is operating in. 369184588SdfrA 370184588Sdfr\[oq]\&+\[cq] 371184588Sdfrdenotes symmetric active, a 372184588Sdfr\[oq]\&-\[cq] 373184588Sdfrindicates symmetric passive, a 374201899Smarius\[oq]\&=\[cq] 375201899Smariusmeans the 376184588Sdfrremote server is being polled in client mode, a 377184588Sdfr\[oq]\&^\[cq] 378184588Sdfrindicates that the server is broadcasting to this address, a 379249592Sken\[oq]\&~\[cq] 380249592Skendenotes that the remote peer is sending broadcasts and a 381184588Sdfr\[oq]\&~\[cq] 382184588Sdfrdenotes that the remote peer is sending broadcasts and a 383184588Sdfr\[oq]\&*\[cq] 384184588Sdfrmarks the peer the server is currently synchronizing 385249592Skento. 386184588Sdfr.sp \n(Ppu 387249592Sken.ne 2 388249592Sken 389249592SkenThe contents of the host field may be one of four forms. 390249592SkenIt may 391261054Smavbe a host name, an IP address, a reference clock implementation 392249592Skenname with its parameter or 393184588Sdfr\fBREFCLK\f[]\fR()\f[] 394184588SdfrOn 395184588Sdfr\f\*[B-Font]hostnames\f[] 396184588Sdfr\f\*[B-Font]no\f[] 397261054Smavonly IP-addresses 398184588Sdfrwill be displayed. 399184588Sdfr.TP 7 400261054Smav.NOP \f\*[B-Font]dmpeers\f[] 401184588SdfrA slightly different peer summary list. 402249592SkenIdentical to the output 403184588Sdfrof the 404201899Smarius\f\*[B-Font]peers\f[] 405201899Smariuscommand, except for the character in the 406184588Sdfrleftmost column. 407184588SdfrCharacters only appear beside peers which were 408249592Skenincluded in the final stage of the clock selection algorithm. 409184588SdfrA 410184588Sdfr\[oq]\&.\[cq] 411184588Sdfrindicates that this peer was cast off in the falseticker 412201899Smariusdetection, while a 413201899Smarius\[oq]\&+\[cq] 414184588Sdfrindicates that the peer made it 415184588Sdfrthrough. 416184588SdfrA 417249592Sken\[oq]\&*\[cq] 418184588Sdfrdenotes the peer the server is currently 419184588Sdfrsynchronizing with. 420261054Smav.TP 7 421261054Smav.NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 422184588SdfrShows a detailed display of the current peer variables for one 423261054Smavor more peers. 424261054SmavMost of these values are described in the NTP 425261054SmavVersion 2 specification. 426261054Smav.TP 7 427267740Smav.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 428261054SmavShow per-peer statistic counters associated with the specified 429261054Smavpeer(s). 430184588Sdfr.TP 7 431261054Smav.NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 432261054SmavObtain and print information concerning a peer clock. 433267740SmavThe 434261054Smavvalues obtained provide information on the setting of fudge factors 435184588Sdfrand other clock performance information. 436184588Sdfr.TP 7 437201899Smarius.NOP \f\*[B-Font]kerninfo\f[] 438201899SmariusObtain and print kernel phase-lock loop operating parameters. 439184588SdfrThis information is available only if the kernel has been specially 440184588Sdfrmodified for a precision timekeeping function. 441184588Sdfr.TP 7 442184588Sdfr.NOP \f\*[B-Font]loopinfo\f[] [\f\*[B-Font]oneline\f[] | \f\*[B-Font]multiline\f[]] 443184588SdfrPrint the values of selected loop filter variables. 444184588SdfrThe loop 445261054Smavfilter is the part of NTP which deals with adjusting the local 446184588Sdfrsystem clock. 447184588SdfrThe 448184588Sdfr\[oq]offset\[cq] 449184588Sdfris the last offset given to the 450184588Sdfrloop filter by the packet processing code. 451184588SdfrThe 452184588Sdfr\[oq]frequency\[cq] 453184588Sdfris the frequency error of the local clock in parts-per-million 454261054Smav(ppm). 455261054SmavThe 456184588Sdfr\[oq]time_const\[cq] 457261054Smavcontrols the stiffness of the 458261054Smavphase-lock loop and thus the speed at which it can adapt to 459261054Smavoscillator drift. 460261054SmavThe 461184588Sdfr\[oq]watchdog timer\[cq] 462249592Skenvalue is the number 463184588Sdfrof seconds which have elapsed since the last sample offset was 464184588Sdfrgiven to the loop filter. 465261054SmavThe 466184588Sdfr\f\*[B-Font]oneline\f[] 467184588Sdfrand 468249592Sken\f\*[B-Font]multiline\f[] 469249592Skenoptions specify the format in which this 470184588Sdfrinformation is to be printed, with 471267753Smav\f\*[B-Font]multiline\f[] 472184588Sdfras the 473184588Sdfrdefault. 474267753Smav.TP 7 475184588Sdfr.NOP \f\*[B-Font]sysinfo\f[] 476249592SkenPrint a variety of system state variables, i.e., state related 477184588Sdfrto the local server. 478267753SmavAll except the last four lines are described 479184588Sdfrin the NTP Version 3 specification, RFC-1305. 480249592Sken.sp \n(Ppu 481249592Sken.ne 2 482249592Sken 483184588SdfrThe 484184588Sdfr\[oq]system flags\[cq] 485184588Sdfrshow various system flags, some of 486249592Skenwhich can be set and cleared by the 487184588Sdfr\f\*[B-Font]enable\f[] 488261054Smavand 489261054Smav\f\*[B-Font]disable\f[] 490267753Smavconfiguration commands, respectively. 491184588SdfrThese are 492267753Smavthe 493184588Sdfr\f\*[B-Font]auth\f[], 494184588Sdfr\f\*[B-Font]bclient\f[], 495184588Sdfr\f\*[B-Font]monitor\f[], 496184588Sdfr\f\*[B-Font]pll\f[], 497267753Smav\f\*[B-Font]pps\f[] 498267753Smavand 499261054Smav\f\*[B-Font]stats\f[] 500267753Smavflags. 501267753SmavSee the 502267753Smav\fCntpd\f[]\fR(1ntpdmdoc)\f[] 503267753Smavdocumentation for the meaning of these flags. 504267753SmavThere 505267753Smavare two additional flags which are read only, the 506261054Smav\f\*[B-Font]kernel_pll\f[] 507267753Smavand 508184588Sdfr\f\*[B-Font]kernel_pps\f[]. 509184588SdfrThese flags indicate 510267753Smavthe synchronization status when the precision time kernel 511267753Smavmodifications are in use. 512184588SdfrThe 513184588Sdfr\[oq]kernel_pll\[cq] 514184588Sdfrindicates that 515267753Smavthe local clock is being disciplined by the kernel, while the 516267753Smav\[oq]kernel_pps\[cq] 517261054Smavindicates the kernel discipline is provided by the PPS 518184588Sdfrsignal. 519184588Sdfr.sp \n(Ppu 520267753Smav.ne 2 521184588Sdfr 522184588SdfrThe 523267753Smav\[oq]stability\[cq] 524261054Smavis the residual frequency error remaining 525267753Smavafter the system frequency correction is applied and is intended for 526184588Sdfrmaintenance and debugging. 527184588SdfrIn most architectures, this value will 528184588Sdfrinitially decrease from as high as 500 ppm to a nominal value in 529184588Sdfrthe range .01 to 0.1 ppm. 530184588SdfrIf it remains high for some time after 531184588Sdfrstarting the daemon, something may be wrong with the local clock, 532184588Sdfror the value of the kernel variable 533184588Sdfr\fIkern.clockrate.tick\f[] 534184588Sdfrmay be 535incorrect. 536.sp \n(Ppu 537.ne 2 538 539The 540\[oq]broadcastdelay\[cq] 541shows the default broadcast delay, 542as set by the 543\f\*[B-Font]broadcastdelay\f[] 544configuration command. 545.sp \n(Ppu 546.ne 2 547 548The 549\[oq]authdelay\[cq] 550shows the default authentication delay, 551as set by the 552\f\*[B-Font]authdelay\f[] 553configuration command. 554.TP 7 555.NOP \f\*[B-Font]sysstats\f[] 556Print statistics counters maintained in the protocol 557module. 558.TP 7 559.NOP \f\*[B-Font]memstats\f[] 560Print statistics counters related to memory allocation 561code. 562.TP 7 563.NOP \f\*[B-Font]iostats\f[] 564Print statistics counters maintained in the input-output 565module. 566.TP 7 567.NOP \f\*[B-Font]timerstats\f[] 568Print statistics counters maintained in the timer/event queue 569support code. 570.TP 7 571.NOP \f\*[B-Font]reslist\f[] 572Obtain and print the server's restriction list. 573This list is 574(usually) printed in sorted order and may help to understand how 575the restrictions are applied. 576.TP 7 577.NOP \f\*[B-Font]monlist\f[] [\f\*[I-Font]version\f[]] 578Obtain and print traffic counts collected and maintained by the 579monitor facility. 580The version number should not normally need to be 581specified. 582.TP 7 583.NOP \f\*[B-Font]clkbug\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 584Obtain debugging information for a reference clock driver. 585This 586information is provided only by some clock drivers and is mostly 587undecodable without a copy of the driver source in hand. 588.PP 589.SS "Runtime Configuration Requests" 590All requests which cause state changes in the server are 591authenticated by the server using a configured NTP key (the 592facility can also be disabled by the server by not configuring a 593key). 594The key number and the corresponding key must also be made 595known to 596\f\*[B-Font]ntpdc\fP. 597This can be done using the 598\f\*[B-Font]keyid\f[] 599and 600\f\*[B-Font]passwd\f[] 601commands, the latter of which will prompt at the terminal for a 602password to use as the encryption key. 603You will also be prompted 604automatically for both the key number and password the first time a 605command which would result in an authenticated request to the 606server is given. 607Authentication not only provides verification that 608the requester has permission to make such changes, but also gives 609an extra degree of protection again transmission errors. 610.sp \n(Ppu 611.ne 2 612 613Authenticated requests always include a timestamp in the packet 614data, which is included in the computation of the authentication 615code. 616This timestamp is compared by the server to its receive time 617stamp. 618If they differ by more than a small amount the request is 619rejected. 620This is done for two reasons. 621First, it makes simple 622replay attacks on the server, by someone who might be able to 623overhear traffic on your LAN, much more difficult. 624Second, it makes 625it more difficult to request configuration changes to your server 626from topologically remote hosts. 627While the reconfiguration facility 628will work well with a server on the local host, and may work 629adequately between time-synchronized hosts on the same LAN, it will 630work very poorly for more distant hosts. 631As such, if reasonable 632passwords are chosen, care is taken in the distribution and 633protection of keys and appropriate source address restrictions are 634applied, the run time reconfiguration facility should provide an 635adequate level of security. 636.sp \n(Ppu 637.ne 2 638 639The following commands all make authenticated requests. 640.TP 7 641.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[]] 642Add a configured peer association at the given address and 643operating in symmetric active mode. 644Note that an existing 645association with the same peer may be deleted when this command is 646executed, or may simply be converted to conform to the new 647configuration, as appropriate. 648If the optional 649\f\*[I-Font]keyid\f[] 650is a 651nonzero integer, all outgoing packets to the remote server will 652have an authentication field attached encrypted with this key. 653If 654the value is 0 (or not given) no authentication will be done. 655The 656\f\*[I-Font]version\f[] 657can be 1, 2 or 3 and defaults to 3. 658The 659\f\*[B-Font]prefer\f[] 660keyword indicates a preferred peer (and thus will 661be used primarily for clock synchronisation if possible). 662The 663preferred peer also determines the validity of the PPS signal \- if 664the preferred peer is suitable for synchronisation so is the PPS 665signal. 666.TP 7 667.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[]] 668Identical to the addpeer command, except that the operating 669mode is client. 670.TP 7 671.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[]] 672Identical to the addpeer command, except that the operating 673mode is broadcast. 674In this case a valid key identifier and key are 675required. 676The 677\f\*[I-Font]peer_address\f[] 678parameter can be the broadcast 679address of the local network or a multicast group address assigned 680to NTP. 681If a multicast address, a multicast-capable kernel is 682required. 683.TP 7 684.NOP \f\*[B-Font]unconfig\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 685This command causes the configured bit to be removed from the 686specified peer(s). 687In many cases this will cause the peer 688association to be deleted. 689When appropriate, however, the 690association may persist in an unconfigured mode if the remote peer 691is willing to continue on in this fashion. 692.TP 7 693.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[]] 694This command provides a way to set certain data for a reference 695clock. 696See the source listing for further information. 697.TP 7 698.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[]] 699.TP 7 700.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[]] 701These commands operate in the same way as the 702\f\*[B-Font]enable\f[] 703and 704\f\*[B-Font]disable\f[] 705configuration file commands of 706\fCntpd\f[]\fR(1ntpdmdoc)\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(1ntpdmdoc)\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(1ntpdmdoc)\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(1ntpdmdoc)\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(1ntpdmdoc)\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-2016 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