ntpdc.1ntpdcman revision 290001
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 "21 Oct 2015" "4.2.8p4" "User Commands"
14.\"
15.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-Gvay7L/ag-Svaq6L)
16.\"
17.\" It has been AutoGen-ed October 21, 2015 at 12:38:51 PM 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
35is deprecated.
36Please use
37\fCntpq\f[]\fR(1ntpqmdoc)\f[] instead \- it can do everything
38\f\*[B-Font]ntpdc\fP
39used 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
44is a utility program used to query
45\fCntpd\f[]\fR(1ntpdmdoc)\f[]
46about its
47current state and to request changes in that state.
48It uses NTP mode 7 control message formats described in the source code.
49The program may
50be run either in interactive mode or controlled using command line
51arguments.
52Extensive state and statistics information is available
53through the
54\f\*[B-Font]ntpdc\fP
55interface.
56In addition, nearly all the
57configuration options which can be specified at startup using
58ntpd'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[]
63Force IPv4 DNS name resolution.
64This option must not appear in combination with any of the following options:
65ipv6.
66.sp
67Force DNS resolution of following host names on the command line
68to the IPv4 namespace.
69.TP
70.NOP \f\*[B-Font]\-6\f[], \f\*[B-Font]\-\-ipv6\f[]
71Force IPv6 DNS name resolution.
72This option must not appear in combination with any of the following options:
73ipv4.
74.sp
75Force DNS resolution of following host names on the command line
76to 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[]
79run a command and exit.
80This option may appear an unlimited number of times.
81.sp
82The following argument is interpreted as an interactive format command
83and is added to the list of commands to be executed on the specified
84host(s).
85.TP
86.NOP \f\*[B-Font]\-d\f[], \f\*[B-Font]\-\-debug\-level\f[]
87Increase debug verbosity level.
88This 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[]
92Set the debug verbosity level.
93This option may appear an unlimited number of times.
94This option takes an integer number as its argument.
95.sp
96.TP
97.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-interactive\f[]
98Force ntpq to operate in interactive mode.
99This option must not appear in combination with any of the following options:
100command, listpeers, peers, showpeers.
101.sp
102Force ntpq to operate in interactive mode.  Prompts will be written
103to the standard output and commands read from the standard input.
104.TP
105.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-listpeers\f[]
106Print a list of the peers.
107This option must not appear in combination with any of the following options:
108command.
109.sp
110Print a list of the peers known to the server as well as a summary of
111their state. This is equivalent to the 'listpeers' interactive command.
112.TP
113.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[]
114numeric host addresses.
115.sp
116Output all host addresses in dotted-quad numeric format rather than
117converting to the canonical host names. 
118.TP
119.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[]
120Print a list of the peers.
121This option must not appear in combination with any of the following options:
122command.
123.sp
124Print a list of the peers known to the server as well as a summary
125of their state. This is equivalent to the 'peers' interactive command.
126.TP
127.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-showpeers\f[]
128Show a list of the peers.
129This option must not appear in combination with any of the following options:
130command.
131.sp
132Print a list of the peers known to the server as well as a summary
133of their state. This is equivalent to the 'dmpeers' interactive command.
134.TP
135.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
136Display usage information and exit.
137.TP
138.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
139Pass 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[]]
142Save the option state to \fIcfgfile\fP.  The default is the \fIlast\fP
143configuration file listed in the \fBOPTION PRESETS\fP section, below.
144The 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[]
147Load options from \fIcfgfile\fP.
148The \fIno-load-opts\fP form will disable the loading
149of earlier config/rc/ini files.  \fI\-\-no-load-opts\fP is handled early,
150out of order.
151.TP
152.NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]
153Output version of program and exit.  The default mode is `v', a simple
154version.  The `c' mode will print copyright information and `n' will
155print the full copyright notice.
156.PP
157.SH "OPTION PRESETS"
158Any option that is not marked as \fInot presettable\fP may be preset
159by loading values from configuration ("RC" or ".INI") file(s) and values from
160environment variables named:
161.nf
162  \fBNTPDC_<option-name>\fP or \fBNTPDC\fP
163.fi
164.ad
165The environmental presets take precedence (are processed later than)
166the configuration files.
167The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
168If any of these are directories, then the file \fI.ntprc\fP
169is searched for within those directories.
170.SH USAGE
171If one or more request options are included on the command line
172when
173\f\*[B-Font]ntpdc\fP
174is executed, each of the requests will be sent
175to the NTP servers running on each of the hosts given as command
176line arguments, or on localhost by default.
177If no request options
178are given,
179\f\*[B-Font]ntpdc\fP
180will attempt to read commands from the
181standard input and execute these on the NTP server running on the
182first host given on the command line, again defaulting to localhost
183when no other host is specified.
184The
185\f\*[B-Font]ntpdc\fP
186utility will prompt for
187commands if the standard input is a terminal device.
188.sp \n(Ppu
189.ne 2
190
191The
192\f\*[B-Font]ntpdc\fP
193utility uses NTP mode 7 packets to communicate with the
194NTP server, and hence can be used to query any compatible server on
195the network which permits it.
196Note that since NTP is a UDP protocol
197this communication will be somewhat unreliable, especially over
198large distances in terms of network topology.
199The
200\f\*[B-Font]ntpdc\fP
201utility makes
202no attempt to retransmit requests, and will time requests out if
203the remote host is not heard from within a suitable timeout
204time.
205.sp \n(Ppu
206.ne 2
207
208The operation of
209\f\*[B-Font]ntpdc\fP
210are specific to the particular
211implementation of the
212\fCntpd\f[]\fR(1ntpdmdoc)\f[]
213daemon and can be expected to
214work only with this and maybe some previous versions of the daemon.
215Requests from a remote
216\f\*[B-Font]ntpdc\fP
217utility which affect the
218state of the local server must be authenticated, which requires
219both the remote program and local server share a common key and key
220identifier.
221.sp \n(Ppu
222.ne 2
223
224Note that in contexts where a host name is expected, a
225\f\*[B-Font]\-4\f[]
226qualifier preceding the host name forces DNS resolution to the IPv4 namespace,
227while a
228\f\*[B-Font]\-6\f[]
229qualifier forces DNS resolution to the IPv6 namespace.
230Specifying a command line option other than
231\f\*[B-Font]\-i\f[]
232or
233\f\*[B-Font]\-n\f[]
234will cause the specified query (queries) to be sent to
235the indicated host(s) immediately.
236Otherwise,
237\f\*[B-Font]ntpdc\fP
238will
239attempt to read interactive format commands from the standard
240input.
241.SS "Interactive Commands"
242Interactive format commands consist of a keyword followed by zero
243to four arguments.
244Only enough characters of the full keyword to
245uniquely identify the command need be typed.
246The output of a
247command is normally sent to the standard output, but optionally the
248output of individual commands may be sent to a file by appending a
249\[oq]\&>\[cq],
250followed by a file name, to the command line.
251.sp \n(Ppu
252.ne 2
253
254A number of interactive format commands are executed entirely
255within the
256\f\*[B-Font]ntpdc\fP
257utility itself and do not result in NTP
258mode 7 requests being sent to a server.
259These are described
260following.
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[]
265A
266\[oq]\f\*[B-Font]\&?\f[]\[cq]
267will print a list of all the command
268keywords known to this incarnation of
269\f\*[B-Font]ntpdc\fP.
270A
271\[oq]\f\*[B-Font]\&?\f[]\[cq]
272followed by a command keyword will print function and usage
273information about the command.
274This command is probably a better
275source of information about
276\fCntpq\f[]\fR(1ntpqmdoc)\f[]
277than this manual
278page.
279.TP 7
280.NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[]
281Specify a time interval to be added to timestamps included in
282requests which require authentication.
283This is used to enable
284(unreliable) server reconfiguration over long delay network paths
285or between machines whose clocks are unsynchronized.
286Actually the
287server does not now require timestamps in authenticated requests,
288so this command may be obsolete.
289.TP 7
290.NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[]
291Set the host to which future queries will be sent.
292Hostname may
293be 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[]]
296If
297\f\*[B-Font]yes\f[]
298is specified, host names are printed in
299information displays.
300If
301\f\*[B-Font]no\f[]
302is specified, numeric
303addresses are printed instead.
304The default is
305\f\*[B-Font]yes\f[],
306unless
307modified using the command line
308\f\*[B-Font]\-n\f[]
309switch.
310.TP 7
311.NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[]
312This command allows the specification of a key number to be
313used to authenticate configuration requests.
314This must correspond
315to a key number the server has been configured to use for this
316purpose.
317.TP 7
318.NOP \f\*[B-Font]quit\f[]
319Exit
320\f\*[B-Font]ntpdc\fP.
321.TP 7
322.NOP \f\*[B-Font]passwd\f[]
323This command prompts you to type in a password (which will not
324be echoed) which will be used to authenticate configuration
325requests.
326The password must correspond to the key configured for
327use by the NTP server for this purpose if such requests are to be
328successful.
329.TP 7
330.NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[]
331Specify a timeout period for responses to server queries.
332The
333default is about 8000 milliseconds.
334Note that since
335\f\*[B-Font]ntpdc\fP
336retries each query once after a timeout, the total waiting time for
337a timeout will be twice the timeout value set.
338.PP
339.SS "Control Message Commands"
340Query commands result in NTP mode 7 packets containing requests for
341information being sent to the server.
342These are read-only commands
343in that they make no modification of the server configuration
344state.
345.TP 7
346.NOP \f\*[B-Font]listpeers\f[]
347Obtains and prints a brief list of the peers for which the
348server is maintaining state.
349These should include all configured
350peer associations as well as those peers whose stratum is such that
351they are considered by the server to be possible future
352synchronization candidates.
353.TP 7
354.NOP \f\*[B-Font]peers\f[]
355Obtains a list of peers for which the server is maintaining
356state, along with a summary of that state.
357Summary information
358includes the address of the remote peer, the local interface
359address (0.0.0.0 if a local address has yet to be determined), the
360stratum of the remote peer (a stratum of 16 indicates the remote
361peer is unsynchronized), the polling interval, in seconds, the
362reachability register, in octal, and the current estimated delay,
363offset and dispersion of the peer, all in seconds.
364.sp \n(Ppu
365.ne 2
366
367The character in the left margin indicates the mode this peer
368entry is operating in.
369A
370\[oq]\&+\[cq]
371denotes symmetric active, a
372\[oq]\&-\[cq]
373indicates symmetric passive, a
374\[oq]\&=\[cq]
375means the
376remote server is being polled in client mode, a
377\[oq]\&^\[cq]
378indicates that the server is broadcasting to this address, a
379\[oq]\&~\[cq]
380denotes that the remote peer is sending broadcasts and a
381\[oq]\&~\[cq]
382denotes that the remote peer is sending broadcasts and a
383\[oq]\&*\[cq]
384marks the peer the server is currently synchronizing
385to.
386.sp \n(Ppu
387.ne 2
388
389The contents of the host field may be one of four forms.
390It may
391be a host name, an IP address, a reference clock implementation
392name with its parameter or
393\fBREFCLK\f[]\fR()\f[]
394On
395\f\*[B-Font]hostnames\f[]
396\f\*[B-Font]no\f[]
397only IP-addresses
398will be displayed.
399.TP 7
400.NOP \f\*[B-Font]dmpeers\f[]
401A slightly different peer summary list.
402Identical to the output
403of the
404\f\*[B-Font]peers\f[]
405command, except for the character in the
406leftmost column.
407Characters only appear beside peers which were
408included in the final stage of the clock selection algorithm.
409A
410\[oq]\&.\[cq]
411indicates that this peer was cast off in the falseticker
412detection, while a
413\[oq]\&+\[cq]
414indicates that the peer made it
415through.
416A
417\[oq]\&*\[cq]
418denotes the peer the server is currently
419synchronizing with.
420.TP 7
421.NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]]
422Shows a detailed display of the current peer variables for one
423or more peers.
424Most of these values are described in the NTP
425Version 2 specification.
426.TP 7
427.NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]]
428Show per-peer statistic counters associated with the specified
429peer(s).
430.TP 7
431.NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]]
432Obtain and print information concerning a peer clock.
433The
434values obtained provide information on the setting of fudge factors
435and other clock performance information.
436.TP 7
437.NOP \f\*[B-Font]kerninfo\f[]
438Obtain and print kernel phase-lock loop operating parameters.
439This information is available only if the kernel has been specially
440modified 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[]]
443Print the values of selected loop filter variables.
444The loop
445filter is the part of NTP which deals with adjusting the local
446system clock.
447The
448\[oq]offset\[cq]
449is the last offset given to the
450loop filter by the packet processing code.
451The
452\[oq]frequency\[cq]
453is the frequency error of the local clock in parts-per-million
454(ppm).
455The
456\[oq]time_const\[cq]
457controls the stiffness of the
458phase-lock loop and thus the speed at which it can adapt to
459oscillator drift.
460The
461\[oq]watchdog timer\[cq]
462value is the number
463of seconds which have elapsed since the last sample offset was
464given to the loop filter.
465The
466\f\*[B-Font]oneline\f[]
467and
468\f\*[B-Font]multiline\f[]
469options specify the format in which this
470information is to be printed, with
471\f\*[B-Font]multiline\f[]
472as the
473default.
474.TP 7
475.NOP \f\*[B-Font]sysinfo\f[]
476Print a variety of system state variables, i.e., state related
477to the local server.
478All except the last four lines are described
479in the NTP Version 3 specification, RFC-1305.
480.sp \n(Ppu
481.ne 2
482
483The
484\[oq]system flags\[cq]
485show various system flags, some of
486which can be set and cleared by the
487\f\*[B-Font]enable\f[]
488and
489\f\*[B-Font]disable\f[]
490configuration commands, respectively.
491These are
492the
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[]
498and
499\f\*[B-Font]stats\f[]
500flags.
501See the
502\fCntpd\f[]\fR(1ntpdmdoc)\f[]
503documentation for the meaning of these flags.
504There
505are two additional flags which are read only, the
506\f\*[B-Font]kernel_pll\f[]
507and
508\f\*[B-Font]kernel_pps\f[].
509These flags indicate
510the synchronization status when the precision time kernel
511modifications are in use.
512The
513\[oq]kernel_pll\[cq]
514indicates that
515the local clock is being disciplined by the kernel, while the
516\[oq]kernel_pps\[cq]
517indicates the kernel discipline is provided by the PPS
518signal.
519.sp \n(Ppu
520.ne 2
521
522The
523\[oq]stability\[cq]
524is the residual frequency error remaining
525after the system frequency correction is applied and is intended for
526maintenance and debugging.
527In most architectures, this value will
528initially decrease from as high as 500 ppm to a nominal value in
529the range .01 to 0.1 ppm.
530If it remains high for some time after
531starting the daemon, something may be wrong with the local clock,
532or the value of the kernel variable
533\fIkern.clockrate.tick\f[]
534may 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-2015 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