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