diff options
Diffstat (limited to 'contrib/ntp/ntpd/ntp.conf.5mdoc')
| -rw-r--r-- | contrib/ntp/ntpd/ntp.conf.5mdoc | 103 |
1 files changed, 76 insertions, 27 deletions
diff --git a/contrib/ntp/ntpd/ntp.conf.5mdoc b/contrib/ntp/ntpd/ntp.conf.5mdoc index f2b418b..c6c7e6c 100644 --- a/contrib/ntp/ntpd/ntp.conf.5mdoc +++ b/contrib/ntp/ntpd/ntp.conf.5mdoc @@ -1,9 +1,9 @@ -.Dd January 20 2016 +.Dd April 26 2016 .Dt NTP_CONF 5mdoc File Formats .Os .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc) .\" -.\" It has been AutoGen-ed January 20, 2016 at 04:18:07 AM by AutoGen 5.18.5 +.\" It has been AutoGen-ed April 26, 2016 at 08:28:36 PM by AutoGen 5.18.5 .\" From the definitions ntp.conf.def .\" and the template file agmdoc-cmd.tpl .Sh NAME @@ -111,8 +111,14 @@ in some weird and even destructive behavior. If the Basic Socket Interface Extensions for IPv6 (RFC\-2553) is detected, support for the IPv6 address family is generated in addition to the default support of the IPv4 address family. -In a few cases, including the reslist billboard generated -by ntpdc, IPv6 addresses are automatically generated. +In a few cases, including the +.Cm reslist +billboard generated +by +.Xr ntpq 1ntpqmdoc +or +.Xr ntpdc 1ntpdcmdoc , +IPv6 addresses are automatically generated. IPv6 addresses can be identified by the presence of colons .Dq \&: in the address field. @@ -147,6 +153,7 @@ equivalent classes for that address family. .Op Cm prefer .Op Cm minpoll Ar minpoll .Op Cm maxpoll Ar maxpoll +.Op Cm true .Xc .It Xo Ic peer Ar address .Op Cm key Ar key \&| Cm autokey @@ -154,6 +161,8 @@ equivalent classes for that address family. .Op Cm prefer .Op Cm minpoll Ar minpoll .Op Cm maxpoll Ar maxpoll +.Op Cm true +.Op Cm xleave .Xc .It Xo Ic broadcast Ar address .Op Cm key Ar key \&| Cm autokey @@ -161,6 +170,7 @@ equivalent classes for that address family. .Op Cm prefer .Op Cm minpoll Ar minpoll .Op Cm ttl Ar ttl +.Op Cm xleave .Xc .It Xo Ic manycastclient Ar address .Op Cm key Ar key \&| Cm autokey @@ -286,7 +296,9 @@ when the server is reachable, send a burst of eight packets instead of the usual one. The packet spacing is normally 2 s; however, the spacing between the first and second packets -can be changed with the calldelay command to allow +can be changed with the +.Ic calldelay +command to allow additional time for a modem or ISDN call to complete. This is designed to improve timekeeping quality with the @@ -297,7 +309,9 @@ When the server is unreachable, send a burst of eight packets instead of the usual one. The packet spacing is normally 2 s; however, the spacing between the first two packets can be -changed with the calldelay command to allow +changed with the +.Ic calldelay +command to allow additional time for a modem or ISDN call to complete. This is designed to speed the initial synchronization acquisition with the @@ -330,6 +344,11 @@ option to a lower limit of 4 (16 s). .It Cm noselect Marks the server as unused, except for display purposes. The server is discarded by the selection algroithm. +.It Cm preempt +Says the association can be preempted. +.It Cm true +Marks the server as a truechimer. +Use this option only for testing. .It Cm prefer Marks the server as preferred. All other things being equal, @@ -342,6 +361,11 @@ page provided in .Pa /usr/share/doc/ntp ) for further information. +.It Cm true +Forces the association to always survive the selection and clustering algorithms. +This option should almost certainly +.Em only +be used while testing an association. .It Cm ttl Ar ttl This option is used only with broadcast server and manycast client modes. @@ -360,6 +384,12 @@ Specifies the version number to be used for outgoing NTP packets. Versions 1\-4 are the choices, with version 4 the default. +.It Cm xleave +Valid in +.Cm peer +and +.Cm broadcast +modes only, this flag enables interleave mode. .El .Ss Auxiliary Commands .Bl -tag -width indent @@ -505,7 +535,7 @@ and commands and also by remote configuration commands sent by a .Xr ntpdc 1ntpdcmdoc -program running in +program running on another machine. If this flag is enabled, which is the default case, new broadcast client and symmetric passive associations and @@ -695,7 +725,7 @@ using the host name, network address and public keys, all of which are bound together by the protocol specifically to deflect masquerade attacks. For this reason Autokey -includes the source and destinatino IP addresses in message digest +includes the source and destination IP addresses in message digest computations and so the same addresses must be available at both the server and client. For this reason operation @@ -893,8 +923,8 @@ the link .Pa ntpkey_key_ Ns Ar hostname in the keys directory. .It Cm iffpar Ar file -Specifies the location of the optional IFF parameters file.This -overrides the link +Specifies the location of the optional IFF parameters file. +This overrides the link .Pa ntpkey_iff_ Ns Ar hostname in the keys directory. .It Cm leap Ar file @@ -904,8 +934,7 @@ This overrides the link in the keys directory. .It Cm mvpar Ar file Specifies the location of the optional MV parameters file. -This -overrides the link +This overrides the link .Pa ntpkey_mv_ Ns Ar hostname in the keys directory. .It Cm pw Ar password @@ -1046,7 +1075,7 @@ supported. Statistic files are managed using file generation sets and scripts in the .Pa ./scripts -directory of this distribution. +directory of the source code distribution. Using these facilities and .Ux @@ -1380,7 +1409,9 @@ When there is already a file with this name and the number of links of this file is one, it is renamed appending a dot, the letter .Cm C , -and the pid of the ntpd server process. +and the pid of the +.Xr ntpd 1ntpdmdoc +server process. When the number of links is greater than one, the file is unlinked. This @@ -1423,7 +1454,9 @@ Source address based restrictions are easily circumvented by a determined cracker. .Pp Clients can be denied service because they are explicitly -included in the restrict list created by the restrict command +included in the restrict list created by the +.Ic restrict +command or implicitly as the result of cryptographic or rate limit violations. Cryptographic violations include certificate @@ -1433,9 +1466,9 @@ at abusive rates. Some violations cause denied service only for the offending packet, others cause denied service for a timed period and others cause the denied service for -an indefinate period. +an indefinite period. When a client or network is denied access -for an indefinate period, the only way at present to remove +for an indefinite period, the only way at present to remove the restrictions is by restarting the server. .Ss The Kiss\-of\-Death Packet Ordinarily, packets denied service are simply dropped with no @@ -1493,7 +1526,9 @@ Packets that violate these minima are discarded and a kiss\-o'\-death packet returned if enabled. The default minimum average and minimum are 5 and 2, respectively. -The monitor subcommand specifies the probability of discard +The +.Ic monitor +subcommand specifies the probability of discard for packets that overflow the rate\-control window. .It Xo Ic restrict address .Op Cm mask Ar mask @@ -1552,7 +1587,9 @@ If another KoD packet occurs within one second after the last one, the packet is dropped. .It Cm limited Deny service if the packet spacing violates the lower limits specified -in the discard command. +in the +.Ic discard +command. A history of clients is kept using the monitoring capability of .Xr ntpd 1ntpdmdoc . @@ -1612,7 +1649,9 @@ queries. .It Cm notrap Decline to provide mode 6 control message trap service to matching hosts. -The trap service is a subsystem of the ntpdq control message +The trap service is a subsystem of the +.Xr ntpq 1ntpqmdoc +control message protocol which is intended for use by remote event logging programs. .It Cm notrust Deny service unless the packet is cryptographically authenticated. @@ -1679,8 +1718,11 @@ The library can also be used with other NTPv4 modes as well and is highly recommended, especially for broadcast modes. .Pp A persistent manycast client association is configured -using the manycastclient command, which is similar to the -server command but with a multicast (IPv4 class +using the +.Ic manycastclient +command, which is similar to the +.Ic server +command but with a multicast (IPv4 class .Cm D or IPv6 prefix .Cm FF ) @@ -1750,7 +1792,9 @@ command and, under normal circumstances, increments to the .Cm maxpolll value specified in this command. Initially, the TTL is -set at the minimum hops specified by the ttl command. +set at the minimum hops specified by the +.Ic ttl +command. At each retransmission the TTL is increased until reaching the maximum hops specified by this command or a sufficient number client associations have been found. @@ -2388,7 +2432,8 @@ drift file is located in, and that file system links, symbolic or otherwise, should be avoided. .It Ic dscp Ar value This option specifies the Differentiated Services Control Point (DSCP) value, -a 6\-bit code. The default value is 46, signifying Expedited Forwarding. +a 6\-bit code. +The default value is 46, signifying Expedited Forwarding. .It Xo Ic enable .Oo .Cm auth | Cm bclient | @@ -2627,7 +2672,8 @@ A message class may also be followed by the .Cm all keyword to enable/disable all -messages of the respective message class.Thus, a minimal log configuration +messages of the respective message class. +Thus, a minimal log configuration could look like this: .Bd -literal logconfig =syncstatus +sysevents @@ -2651,7 +2697,9 @@ This command specifies the location of an alternate log file to be used instead of the default system .Xr syslog 3 facility. -This is the same operation as the \-l command line option. +This is the same operation as the +.Fl l +command line option. .It Ic setvar Ar variable Op Cm default This command adds an additional system variable. These @@ -2803,7 +2851,8 @@ Specifies the maximum size of the process stack on systems with the function. Defaults to 50 4k pages (200 4k pages in OpenBSD). .It Cm filenum Ar Nfiledescriptors -Specifies the maximum number of file descriptors ntpd may have open at once. Defaults to the system default. +Specifies the maximum number of file descriptors ntpd may have open at once. +Defaults to the system default. .El .It Xo Ic trap Ar host_address .Op Cm port Ar port_number |
