ntp-4.2.8p15.tar.gz: ntp-4.2.8p15/ntpdc/ntpdc.1ntpdcman

"Fossies" - the Fresh Open Source Software Archive

Member "ntp-4.2.8p15/ntpdc/ntpdc.1ntpdcman" (23 Jun 2020, 28384 Bytes) of package /linux/misc/ntp-4.2.8p15.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "ntpdc.1ntpdcman":

4.2.8p14_vs_4.2.8p15.

1 .de1 NOP 2 . it 1 an-trap 3 . if \\n[.$] \,\\$*\/ 4 .. 5 .ie t \ 6 .ds B-Font [CB] 7 .ds I-Font [CI] 8 .ds R-Font [CR] 9 .el \ 10 .ds B-Font B 11 .ds I-Font I 12 .ds R-Font R 13 .TH ntpdc 1ntpdcman "23 Jun 2020" "4.2.8p15" "User Commands" 14 .\" 15 .\" EDIT THIS FILE WITH CAUTION (in-mem file) 16 .\" 17 .\" It has been AutoGen-ed June 23, 2020 at 02:20:47 AM by AutoGen 5.18.5 18 .\" From the definitions ntpdc-opts.def 19 .\" and the template file agman-cmd.tpl 20 .SH NAME 21 \f\*[B-Font]ntpdc\fP 22 \- vendor-specific NTPD control program 23 .SH SYNOPSIS 24 \f\*[B-Font]ntpdc\fP 25 .\" Mixture of short (flag) options and long options 26 [\f\*[B-Font]\-flags\f[]] 27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] 28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] 29 [ host ...] 30 .sp \n(Ppu 31 .ne 2 32 33 .SH DESCRIPTION 34 \f\*[B-Font]ntpdc\fP 35 is deprecated. 36 Please use 37 \fCntpq\f[]\fR(1ntpqmdoc)\f[] instead \- it can do everything 38 \f\*[B-Font]ntpdc\fP 39 used to do, and it does so using a much more sane interface. 40 .sp \n(Ppu 41 .ne 2 42 43 \f\*[B-Font]ntpdc\fP 44 is a utility program used to query 45 \fCntpd\f[]\fR(1ntpdmdoc)\f[] 46 about its 47 current state and to request changes in that state. 48 It uses NTP mode 7 control message formats described in the source code. 49 The program may 50 be run either in interactive mode or controlled using command line 51 arguments. 52 Extensive state and statistics information is available 53 through the 54 \f\*[B-Font]ntpdc\fP 55 interface. 56 In addition, nearly all the 57 configuration options which can be specified at startup using 58 ntpd's configuration file may also be specified at run time using 59 \f\*[B-Font]ntpdc\fP. 60 .SH "OPTIONS" 61 .TP 62 .NOP \f\*[B-Font]\-4\f[], \f\*[B-Font]\-\-ipv4\f[] 63 Force IPv4 DNS name resolution. 64 This option must not appear in combination with any of the following options: 65 ipv6. 66 .sp 67 Force DNS resolution of following host names on the command line 68 to the IPv4 namespace. 69 .TP 70 .NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[] 71 Force IPv6 DNS name resolution. 72 This option must not appear in combination with any of the following options: 73 ipv4. 74 .sp 75 Force DNS resolution of following host names on the command line 76 to the IPv6 namespace. 77 .TP 78 .NOP \f\*[B-Font]\-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]\-\-command\f[]=\f\*[I-Font]cmd\f[] 79 run a command and exit. 80 This option may appear an unlimited number of times. 81 .sp 82 The following argument is interpreted as an interactive format command 83 and is added to the list of commands to be executed on the specified 84 host(s). 85 .TP 86 .NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[] 87 Increase debug verbosity level. 88 This option may appear an unlimited number of times. 89 .sp 90 .TP 91 .NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-set\-debug\-level\f[]=\f\*[I-Font]number\f[] 92 Set the debug verbosity level. 93 This option may appear an unlimited number of times. 94 This option takes an integer number as its argument. 95 .sp 96 .TP 97 .NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[] 98 Force ntpq to operate in interactive mode. 99 This option must not appear in combination with any of the following options: 100 command, listpeers, peers, showpeers. 101 .sp 102 Force ntpq to operate in interactive mode. Prompts will be written 103 to the standard output and commands read from the standard input. 104 .TP 105 .NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-listpeers\f[] 106 Print a list of the peers. 107 This option must not appear in combination with any of the following options: 108 command. 109 .sp 110 Print a list of the peers known to the server as well as a summary of 111 their state. This is equivalent to the 'listpeers' interactive command. 112 .TP 113 .NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[] 114 numeric host addresses. 115 .sp 116 Output all host addresses in dotted-quad numeric format rather than 117 converting to the canonical host names. 118 .TP 119 .NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[] 120 Print a list of the peers. 121 This option must not appear in combination with any of the following options: 122 command. 123 .sp 124 Print a list of the peers known to the server as well as a summary 125 of their state. This is equivalent to the 'peers' interactive command. 126 .TP 127 .NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-showpeers\f[] 128 Show a list of the peers. 129 This option must not appear in combination with any of the following options: 130 command. 131 .sp 132 Print a list of the peers known to the server as well as a summary 133 of their state. This is equivalent to the 'dmpeers' interactive command. 134 .TP 135 .NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] 136 Display usage information and exit. 137 .TP 138 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] 139 Pass the extended usage information through a pager. 140 .TP 141 .NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] 142 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP 143 configuration file listed in the \fBOPTION PRESETS\fP section, below. 144 The command will exit after updating the config file. 145 .TP 146 .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[] 147 Load options from \fIcfgfile\fP. 148 The \fIno-load-opts\fP form will disable the loading 149 of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early, 150 out of order. 151 .TP 152 .NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}] 153 Output version of program and exit. The default mode is `v', a simple 154 version. The `c' mode will print copyright information and `n' will 155 print the full copyright notice. 156 .PP 157 .SH "OPTION PRESETS" 158 Any option that is not marked as \fInot presettable\fP may be preset 159 by loading values from configuration ("RC" or ".INI") file(s) and values from 160 environment variables named: 161 .nf 162 \fBNTPDC_<option-name>\fP or \fBNTPDC\fP 163 .fi 164 .ad 165 The environmental presets take precedence (are processed later than) 166 the configuration files. 167 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 168 If any of these are directories, then the file \fI.ntprc\fP 169 is searched for within those directories. 170 .SH USAGE 171 If one or more request options are included on the command line 172 when 173 \f\*[B-Font]ntpdc\fP 174 is executed, each of the requests will be sent 175 to the NTP servers running on each of the hosts given as command 176 line arguments, or on localhost by default. 177 If no request options 178 are given, 179 \f\*[B-Font]ntpdc\fP 180 will attempt to read commands from the 181 standard input and execute these on the NTP server running on the 182 first host given on the command line, again defaulting to localhost 183 when no other host is specified. 184 The 185 \f\*[B-Font]ntpdc\fP 186 utility will prompt for 187 commands if the standard input is a terminal device. 188 .sp \n(Ppu 189 .ne 2 190 191 The 192 \f\*[B-Font]ntpdc\fP 193 utility uses NTP mode 7 packets to communicate with the 194 NTP server, and hence can be used to query any compatible server on 195 the network which permits it. 196 Note that since NTP is a UDP protocol 197 this communication will be somewhat unreliable, especially over 198 large distances in terms of network topology. 199 The 200 \f\*[B-Font]ntpdc\fP 201 utility makes 202 no attempt to retransmit requests, and will time requests out if 203 the remote host is not heard from within a suitable timeout 204 time. 205 .sp \n(Ppu 206 .ne 2 207 208 The operation of 209 \f\*[B-Font]ntpdc\fP 210 are specific to the particular 211 implementation of the 212 \fCntpd\f[]\fR(1ntpdmdoc)\f[] 213 daemon and can be expected to 214 work only with this and maybe some previous versions of the daemon. 215 Requests from a remote 216 \f\*[B-Font]ntpdc\fP 217 utility which affect the 218 state of the local server must be authenticated, which requires 219 both the remote program and local server share a common key and key 220 identifier. 221 .sp \n(Ppu 222 .ne 2 223 224 Note that in contexts where a host name is expected, a 225 \f\*[B-Font]\-4\f[] 226 qualifier preceding the host name forces DNS resolution to the IPv4 namespace, 227 while a 228 \f\*[B-Font]\-6\f[] 229 qualifier forces DNS resolution to the IPv6 namespace. 230 Specifying a command line option other than 231 \f\*[B-Font]\-i\f[] 232 or 233 \f\*[B-Font]\-n\f[] 234 will cause the specified query (queries) to be sent to 235 the indicated host(s) immediately. 236 Otherwise, 237 \f\*[B-Font]ntpdc\fP 238 will 239 attempt to read interactive format commands from the standard 240 input. 241 .SS "Interactive Commands" 242 Interactive format commands consist of a keyword followed by zero 243 to four arguments. 244 Only enough characters of the full keyword to 245 uniquely identify the command need be typed. 246 The output of a 247 command is normally sent to the standard output, but optionally the 248 output of individual commands may be sent to a file by appending a 249 \[oq]\&>\[cq], 250 followed by a file name, to the command line. 251 .sp \n(Ppu 252 .ne 2 253 254 A number of interactive format commands are executed entirely 255 within the 256 \f\*[B-Font]ntpdc\fP 257 utility itself and do not result in NTP 258 mode 7 requests being sent to a server. 259 These are described 260 following. 261 .TP 7 262 .NOP \f\*[B-Font]\&?\f[] \f\*[I-Font]command_keyword\f[] 263 .TP 7 264 .NOP \f\*[B-Font]help\f[] \f\*[I-Font]command_keyword\f[] 265 A 266 \[oq]\f\*[B-Font]\&?\f[]\[cq] 267 will print a list of all the command 268 keywords known to this incarnation of 269 \f\*[B-Font]ntpdc\fP. 270 A 271 \[oq]\f\*[B-Font]\&?\f[]\[cq] 272 followed by a command keyword will print function and usage 273 information about the command. 274 This command is probably a better 275 source of information about 276 \fCntpq\f[]\fR(1ntpqmdoc)\f[] 277 than this manual 278 page. 279 .TP 7 280 .NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] 281 Specify a time interval to be added to timestamps included in 282 requests which require authentication. 283 This is used to enable 284 (unreliable) server reconfiguration over long delay network paths 285 or between machines whose clocks are unsynchronized. 286 Actually the 287 server does not now require timestamps in authenticated requests, 288 so this command may be obsolete. 289 .TP 7 290 .NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] 291 Set the host to which future queries will be sent. 292 Hostname may 293 be either a host name or a numeric address. 294 .TP 7 295 .NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] 296 If 297 \f\*[B-Font]yes\f[] 298 is specified, host names are printed in 299 information displays. 300 If 301 \f\*[B-Font]no\f[] 302 is specified, numeric 303 addresses are printed instead. 304 The default is 305 \f\*[B-Font]yes\f[], 306 unless 307 modified using the command line 308 \f\*[B-Font]\-n\f[] 309 switch. 310 .TP 7 311 .NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] 312 This command allows the specification of a key number to be 313 used to authenticate configuration requests. 314 This must correspond 315 to a key number the server has been configured to use for this 316 purpose. 317 .TP 7 318 .NOP \f\*[B-Font]quit\f[] 319 Exit 320 \f\*[B-Font]ntpdc\fP. 321 .TP 7 322 .NOP \f\*[B-Font]passwd\f[] 323 This command prompts you to type in a password (which will not 324 be echoed) which will be used to authenticate configuration 325 requests. 326 The password must correspond to the key configured for 327 use by the NTP server for this purpose if such requests are to be 328 successful. 329 .TP 7 330 .NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] 331 Specify a timeout period for responses to server queries. 332 The 333 default is about 8000 milliseconds. 334 Note that since 335 \f\*[B-Font]ntpdc\fP 336 retries each query once after a timeout, the total waiting time for 337 a timeout will be twice the timeout value set. 338 .PP 339 .SS "Control Message Commands" 340 Query commands result in NTP mode 7 packets containing requests for 341 information being sent to the server. 342 These are read-only commands 343 in that they make no modification of the server configuration 344 state. 345 .TP 7 346 .NOP \f\*[B-Font]listpeers\f[] 347 Obtains and prints a brief list of the peers for which the 348 server is maintaining state. 349 These should include all configured 350 peer associations as well as those peers whose stratum is such that 351 they are considered by the server to be possible future 352 synchronization candidates. 353 .TP 7 354 .NOP \f\*[B-Font]peers\f[] 355 Obtains a list of peers for which the server is maintaining 356 state, along with a summary of that state. 357 Summary information 358 includes the address of the remote peer, the local interface 359 address (0.0.0.0 if a local address has yet to be determined), the 360 stratum of the remote peer (a stratum of 16 indicates the remote 361 peer is unsynchronized), the polling interval, in seconds, the 362 reachability register, in octal, and the current estimated delay, 363 offset and dispersion of the peer, all in seconds. 364 .sp \n(Ppu 365 .ne 2 366 367 The character in the left margin indicates the mode this peer 368 entry is operating in. 369 A 370 \[oq]\&+\[cq] 371 denotes symmetric active, a 372 \[oq]\&-\[cq] 373 indicates symmetric passive, a 374 \[oq]\&=\[cq] 375 means the 376 remote server is being polled in client mode, a 377 \[oq]\&^\[cq] 378 indicates that the server is broadcasting to this address, a 379 \[oq]\&~\[cq] 380 denotes that the remote peer is sending broadcasts and a 381 \[oq]\&~\[cq] 382 denotes that the remote peer is sending broadcasts and a 383 \[oq]\&*\[cq] 384 marks the peer the server is currently synchronizing 385 to. 386 .sp \n(Ppu 387 .ne 2 388 389 The contents of the host field may be one of four forms. 390 It may 391 be a host name, an IP address, a reference clock implementation 392 name with its parameter or 393 \fBREFCLK\f[]\fR()\f[] 394 On 395 \f\*[B-Font]hostnames\f[] 396 \f\*[B-Font]no\f[] 397 only IP-addresses 398 will be displayed. 399 .TP 7 400 .NOP \f\*[B-Font]dmpeers\f[] 401 A slightly different peer summary list. 402 Identical to the output 403 of the 404 \f\*[B-Font]peers\f[] 405 command, except for the character in the 406 leftmost column. 407 Characters only appear beside peers which were 408 included in the final stage of the clock selection algorithm. 409 A 410 \[oq]\&.\[cq] 411 indicates that this peer was cast off in the falseticker 412 detection, while a 413 \[oq]\&+\[cq] 414 indicates that the peer made it 415 through. 416 A 417 \[oq]\&*\[cq] 418 denotes the peer the server is currently 419 synchronizing with. 420 .TP 7 421 .NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 422 Shows a detailed display of the current peer variables for one 423 or more peers. 424 Most of these values are described in the NTP 425 Version 2 specification. 426 .TP 7 427 .NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 428 Show per-peer statistic counters associated with the specified 429 peer(s). 430 .TP 7 431 .NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 432 Obtain and print information concerning a peer clock. 433 The 434 values obtained provide information on the setting of fudge factors 435 and other clock performance information. 436 .TP 7 437 .NOP \f\*[B-Font]kerninfo\f[] 438 Obtain and print kernel phase-lock loop operating parameters. 439 This information is available only if the kernel has been specially 440 modified for a precision timekeeping function. 441 .TP 7 442 .NOP \f\*[B-Font]loopinfo\f[] [\f\*[B-Font]oneline\f[] | \f\*[B-Font]multiline\f[]] 443 Print the values of selected loop filter variables. 444 The loop 445 filter is the part of NTP which deals with adjusting the local 446 system clock. 447 The 448 \[oq]offset\[cq] 449 is the last offset given to the 450 loop filter by the packet processing code. 451 The 452 \[oq]frequency\[cq] 453 is the frequency error of the local clock in parts-per-million 454 (ppm). 455 The 456 \[oq]time_const\[cq] 457 controls the stiffness of the 458 phase-lock loop and thus the speed at which it can adapt to 459 oscillator drift. 460 The 461 \[oq]watchdog timer\[cq] 462 value is the number 463 of seconds which have elapsed since the last sample offset was 464 given to the loop filter. 465 The 466 \f\*[B-Font]oneline\f[] 467 and 468 \f\*[B-Font]multiline\f[] 469 options specify the format in which this 470 information is to be printed, with 471 \f\*[B-Font]multiline\f[] 472 as the 473 default. 474 .TP 7 475 .NOP \f\*[B-Font]sysinfo\f[] 476 Print a variety of system state variables, i.e., state related 477 to the local server. 478 All except the last four lines are described 479 in the NTP Version 3 specification, RFC-1305. 480 .sp \n(Ppu 481 .ne 2 482 483 The 484 \[oq]system flags\[cq] 485 show various system flags, some of 486 which can be set and cleared by the 487 \f\*[B-Font]enable\f[] 488 and 489 \f\*[B-Font]disable\f[] 490 configuration commands, respectively. 491 These are 492 the 493 \f\*[B-Font]auth\f[], 494 \f\*[B-Font]bclient\f[], 495 \f\*[B-Font]monitor\f[], 496 \f\*[B-Font]pll\f[], 497 \f\*[B-Font]pps\f[] 498 and 499 \f\*[B-Font]stats\f[] 500 flags. 501 See the 502 \fCntpd\f[]\fR(1ntpdmdoc)\f[] 503 documentation for the meaning of these flags. 504 There 505 are two additional flags which are read only, the 506 \f\*[B-Font]kernel_pll\f[] 507 and 508 \f\*[B-Font]kernel_pps\f[]. 509 These flags indicate 510 the synchronization status when the precision time kernel 511 modifications are in use. 512 The 513 \[oq]kernel_pll\[cq] 514 indicates that 515 the local clock is being disciplined by the kernel, while the 516 \[oq]kernel_pps\[cq] 517 indicates the kernel discipline is provided by the PPS 518 signal. 519 .sp \n(Ppu 520 .ne 2 521 522 The 523 \[oq]stability\[cq] 524 is the residual frequency error remaining 525 after the system frequency correction is applied and is intended for 526 maintenance and debugging. 527 In most architectures, this value will 528 initially decrease from as high as 500 ppm to a nominal value in 529 the range .01 to 0.1 ppm. 530 If it remains high for some time after 531 starting the daemon, something may be wrong with the local clock, 532 or the value of the kernel variable 533 \fIkern.clockrate.tick\f[] 534 may be 535 incorrect. 536 .sp \n(Ppu 537 .ne 2 538 539 The 540 \[oq]broadcastdelay\[cq] 541 shows the default broadcast delay, 542 as set by the 543 \f\*[B-Font]broadcastdelay\f[] 544 configuration command. 545 .sp \n(Ppu 546 .ne 2 547 548 The 549 \[oq]authdelay\[cq] 550 shows the default authentication delay, 551 as set by the 552 \f\*[B-Font]authdelay\f[] 553 configuration command. 554 .TP 7 555 .NOP \f\*[B-Font]sysstats\f[] 556 Print statistics counters maintained in the protocol 557 module. 558 .TP 7 559 .NOP \f\*[B-Font]memstats\f[] 560 Print statistics counters related to memory allocation 561 code. 562 .TP 7 563 .NOP \f\*[B-Font]iostats\f[] 564 Print statistics counters maintained in the input-output 565 module. 566 .TP 7 567 .NOP \f\*[B-Font]timerstats\f[] 568 Print statistics counters maintained in the timer/event queue 569 support code. 570 .TP 7 571 .NOP \f\*[B-Font]reslist\f[] 572 Obtain and print the server's restriction list. 573 This list is 574 (usually) printed in sorted order and may help to understand how 575 the restrictions are applied. 576 .TP 7 577 .NOP \f\*[B-Font]monlist\f[] [\f\*[I-Font]version\f[]] 578 Obtain and print traffic counts collected and maintained by the 579 monitor facility. 580 The version number should not normally need to be 581 specified. 582 .TP 7 583 .NOP \f\*[B-Font]clkbug\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] 584 Obtain debugging information for a reference clock driver. 585 This 586 information is provided only by some clock drivers and is mostly 587 undecodable without a copy of the driver source in hand. 588 .PP 589 .SS "Runtime Configuration Requests" 590 All requests which cause state changes in the server are 591 authenticated by the server using a configured NTP key (the 592 facility can also be disabled by the server by not configuring a 593 key). 594 The key number and the corresponding key must also be made 595 known to 596 \f\*[B-Font]ntpdc\fP. 597 This can be done using the 598 \f\*[B-Font]keyid\f[] 599 and 600 \f\*[B-Font]passwd\f[] 601 commands, the latter of which will prompt at the terminal for a 602 password to use as the encryption key. 603 You will also be prompted 604 automatically for both the key number and password the first time a 605 command which would result in an authenticated request to the 606 server is given. 607 Authentication not only provides verification that 608 the requester has permission to make such changes, but also gives 609 an extra degree of protection again transmission errors. 610 .sp \n(Ppu 611 .ne 2 612 613 Authenticated requests always include a timestamp in the packet 614 data, which is included in the computation of the authentication 615 code. 616 This timestamp is compared by the server to its receive time 617 stamp. 618 If they differ by more than a small amount the request is 619 rejected. 620 This is done for two reasons. 621 First, it makes simple 622 replay attacks on the server, by someone who might be able to 623 overhear traffic on your LAN, much more difficult. 624 Second, it makes 625 it more difficult to request configuration changes to your server 626 from topologically remote hosts. 627 While the reconfiguration facility 628 will work well with a server on the local host, and may work 629 adequately between time-synchronized hosts on the same LAN, it will 630 work very poorly for more distant hosts. 631 As such, if reasonable 632 passwords are chosen, care is taken in the distribution and 633 protection of keys and appropriate source address restrictions are 634 applied, the run time reconfiguration facility should provide an 635 adequate level of security. 636 .sp \n(Ppu 637 .ne 2 638 639 The 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[]] 642 Add a configured peer association at the given address and 643 operating in symmetric active mode. 644 Note that an existing 645 association with the same peer may be deleted when this command is 646 executed, or may simply be converted to conform to the new 647 configuration, as appropriate. 648 If the optional 649 \f\*[I-Font]keyid\f[] 650 is a 651 nonzero integer, all outgoing packets to the remote server will 652 have an authentication field attached encrypted with this key. 653 If 654 the value is 0 (or not given) no authentication will be done. 655 The 656 \f\*[I-Font]version\f[] 657 can be 1, 2 or 3 and defaults to 3. 658 The 659 \f\*[B-Font]prefer\f[] 660 keyword indicates a preferred peer (and thus will 661 be used primarily for clock synchronisation if possible). 662 The 663 preferred peer also determines the validity of the PPS signal \- if 664 the preferred peer is suitable for synchronisation so is the PPS 665 signal. 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[]] 668 Identical to the addpeer command, except that the operating 669 mode 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[]] 672 Identical to the addpeer command, except that the operating 673 mode is broadcast. 674 In this case a valid key identifier and key are 675 required. 676 The 677 \f\*[I-Font]peer_address\f[] 678 parameter can be the broadcast 679 address of the local network or a multicast group address assigned 680 to NTP. 681 If a multicast address, a multicast-capable kernel is 682 required. 683 .TP 7 684 .NOP \f\*[B-Font]unconfig\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] 685 This command causes the configured bit to be removed from the 686 specified peer(s). 687 In many cases this will cause the peer 688 association to be deleted. 689 When appropriate, however, the 690 association may persist in an unconfigured mode if the remote peer 691 is 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[]] 694 This command provides a way to set certain data for a reference 695 clock. 696 See 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[]] 701 These commands operate in the same way as the 702 \f\*[B-Font]enable\f[] 703 and 704 \f\*[B-Font]disable\f[] 705 configuration file commands of 706 \fCntpd\f[]\fR(1ntpdmdoc)\f[]. 707 .RS 708 .TP 7 709 .NOP \f\*[B-Font]auth\f[] 710 Enables the server to synchronize with unconfigured peers only 711 if the peer has been correctly authenticated using either public key 712 or private key cryptography. 713 The default for this flag is enable. 714 .TP 7 715 .NOP \f\*[B-Font]bclient\f[] 716 Enables the server to listen for a message from a broadcast or 717 multicast server, as in the multicastclient command with 718 default address. 719 The default for this flag is disable. 720 .TP 7 721 .NOP \f\*[B-Font]calibrate\f[] 722 Enables the calibrate feature for reference clocks. 723 The default for this flag is disable. 724 .TP 7 725 .NOP \f\*[B-Font]kernel\f[] 726 Enables the kernel time discipline, if available. 727 The default for this flag is enable if support is available, otherwise disable. 728 .TP 7 729 .NOP \f\*[B-Font]monitor\f[] 730 Enables the monitoring facility. 731 See the documentation here about the 732 \f\*[B-Font]monlist\f[] 733 command or further information. 734 The default for this flag is enable. 735 .TP 7 736 .NOP \f\*[B-Font]ntp\f[] 737 Enables time and frequency discipline. 738 In effect, this switch opens and closes the feedback loop, 739 which is useful for testing. 740 The default for this flag is enable. 741 .TP 7 742 .NOP \f\*[B-Font]pps\f[] 743 Enables the pulse-per-second (PPS) signal when frequency 744 and time is disciplined by the precision time kernel modifications. 745 See the 746 "A Kernel Model for Precision Timekeeping" 747 (available as part of the HTML documentation 748 provided in 749 \fI/usr/share/doc/ntp\f[]) 750 page for further information. 751 The default for this flag is disable. 752 .TP 7 753 .NOP \f\*[B-Font]stats\f[] 754 Enables the statistics facility. 755 See the 756 \fIMonitoring\f[] \fIOptions\f[] 757 section of 758 \fCntp.conf\f[]\fR(5)\f[] 759 for further information. 760 The 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[]] 764 This command operates in the same way as the 765 \f\*[B-Font]restrict\f[] 766 configuration 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[]] 770 Unrestrict 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[]] 773 Delete the matching entry from the restrict list. 774 .TP 7 775 .NOP \f\*[B-Font]readkeys\f[] 776 Causes the current set of authentication keys to be purged and 777 a new set to be obtained by rereading the keys file (which must 778 have been specified in the 779 \fCntpd\f[]\fR(1ntpdmdoc)\f[] 780 configuration file). 781 This 782 allows encryption keys to be changed without restarting the 783 server. 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[]] 788 These commands operate in the same way as the 789 \f\*[B-Font]trustedkey\f[] 790 and 791 \f\*[B-Font]untrustedkey\f[] 792 configuration file 793 commands of 794 \fCntpd\f[]\fR(1ntpdmdoc)\f[]. 795 .TP 7 796 .NOP \f\*[B-Font]authinfo\f[] 797 Returns information concerning the authentication module, 798 including known keys and counts of encryptions and decryptions 799 which have been done. 800 .TP 7 801 .NOP \f\*[B-Font]traps\f[] 802 Display the traps set in the server. 803 See the source listing for 804 further 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[]] 807 Set a trap for asynchronous messages. 808 See the source listing 809 for 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[]] 812 Clear a trap for asynchronous messages. 813 See the source listing 814 for further information. 815 .TP 7 816 .NOP \f\*[B-Font]reset\f[] 817 Clear the statistics counters in various modules of the server. 818 See the source listing for further information. 819 .PP 820 .SH "ENVIRONMENT" 821 See \fBOPTION PRESETS\fP for configuration environment variables. 822 .SH "FILES" 823 See \fBOPTION PRESETS\fP for configuration files. 824 .SH "EXIT STATUS" 825 One of the following exit values will be returned: 826 .TP 827 .NOP 0 " (EXIT_SUCCESS)" 828 Successful program execution. 829 .TP 830 .NOP 1 " (EXIT_FAILURE)" 831 The operation failed or the command syntax was not valid. 832 .TP 833 .NOP 66 " (EX_NOINPUT)" 834 A specified configuration file could not be loaded. 835 .TP 836 .NOP 70 " (EX_SOFTWARE)" 837 libopts had an internal operational error. Please report 838 it 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[] 843 David L. Mills, 844 \fINetwork Time Protocol (Version 3)\fR, 845 RFC1305 846 .PP 847 848 .SH AUTHORS 849 The formatting directives in this document came from FreeBSD. 850 .SH "COPYRIGHT" 851 Copyright (C) 1992-2020 The University of Delaware and Network Time Foundation all rights reserved. 852 This program is released under the terms of the NTP license, <http://ntp.org/license>. 853 .SH BUGS 854 The 855 \f\*[B-Font]ntpdc\fP 856 utility is a crude hack. 857 Much of the information it shows is 858 deadly boring and could only be loved by its implementer. 859 The 860 program was designed so that new (and temporary) features were easy 861 to hack in, at great expense to the program's ease of use. 862 Despite 863 this, the program is occasionally useful. 864 .sp \n(Ppu 865 .ne 2 866 867 Please report bugs to http://bugs.ntp.org . 868 .sp \n(Ppu 869 .ne 2 870 871 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org 872 .SH "NOTES" 873 This manual page was \fIAutoGen\fP-erated from the \fBntpdc\fP 874 option definitions.