diff options
Diffstat (limited to 'ntpd/invoke-ntp.conf.texi')
| -rw-r--r-- | ntpd/invoke-ntp.conf.texi | 103 |
1 files changed, 74 insertions, 29 deletions
diff --git a/ntpd/invoke-ntp.conf.texi b/ntpd/invoke-ntp.conf.texi index 1d8a621629d48..fa8e87afe1eaf 100644 --- a/ntpd/invoke-ntp.conf.texi +++ b/ntpd/invoke-ntp.conf.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntp.conf.texi) # -# It has been AutoGen-ed January 20, 2016 at 04:17:59 AM by AutoGen 5.18.5 +# It has been AutoGen-ed April 26, 2016 at 08:28:27 PM by AutoGen 5.18.5 # From the definitions ntp.conf.def # and the template file agtexi-file.tpl @end ignore @@ -108,8 +108,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 +@code{reslist} +billboard generated +by +@code{ntpq(1ntpqmdoc)} +or +@code{ntpdc(1ntpdcmdoc)}, +IPv6 addresses are automatically generated. IPv6 addresses can be identified by the presence of colons @quotedblleft{}:@quotedblright{} in the address field. @@ -129,9 +135,9 @@ See IPv6 references for the equivalent classes for that address family. @table @asis @item @code{pool} @kbd{address} @code{[@code{burst}]} @code{[@code{iburst}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} -@item @code{server} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{burst}]} @code{[@code{iburst}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} -@item @code{peer} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} -@item @code{broadcast} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{ttl} @kbd{ttl}]} +@item @code{server} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{burst}]} @code{[@code{iburst}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} @code{[@code{true}]} +@item @code{peer} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} @code{[@code{true}]} @code{[@code{xleave}]} +@item @code{broadcast} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{ttl} @kbd{ttl}]} @code{[@code{xleave}]} @item @code{manycastclient} @kbd{address} @code{[@code{key} @kbd{key} @kbd{|} @code{autokey}]} @code{[@code{version} @kbd{version}]} @code{[@code{prefer}]} @code{[@code{minpoll} @kbd{minpoll}]} @code{[@code{maxpoll} @kbd{maxpoll}]} @code{[@code{ttl} @kbd{ttl}]} @end table @@ -249,7 +255,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 +@code{calldelay} +command to allow additional time for a modem or ISDN call to complete. This is designed to improve timekeeping quality with the @@ -260,7 +268,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 +@code{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 @@ -293,6 +303,11 @@ option to a lower limit of 4 (16 s). @item @code{noselect} Marks the server as unused, except for display purposes. The server is discarded by the selection algroithm. +@item @code{preempt} +Says the association can be preempted. +@item @code{true} +Marks the server as a truechimer. +Use this option only for testing. @item @code{prefer} Marks the server as preferred. All other things being equal, @@ -305,6 +320,11 @@ page provided in @file{/usr/share/doc/ntp}) for further information. +@item @code{true} +Forces the association to always survive the selection and clustering algorithms. +This option should almost certainly +@emph{only} +be used while testing an association. @item @code{ttl} @kbd{ttl} This option is used only with broadcast server and manycast client modes. @@ -323,6 +343,12 @@ Specifies the version number to be used for outgoing NTP packets. Versions 1-4 are the choices, with version 4 the default. +@item @code{xleave} +Valid in +@code{peer} +and +@code{broadcast} +modes only, this flag enables interleave mode. @end table @subsubsection Auxiliary Commands @table @asis @@ -469,7 +495,7 @@ and commands and also by remote configuration commands sent by a @code{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 @@ -649,7 +675,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 @@ -836,8 +862,8 @@ the link @file{ntpkey_key_}@kbd{hostname} in the keys directory. @item @code{iffpar} @kbd{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 @file{ntpkey_iff_}@kbd{hostname} in the keys directory. @item @code{leap} @kbd{file} @@ -847,8 +873,7 @@ This overrides the link in the keys directory. @item @code{mvpar} @kbd{file} Specifies the location of the optional MV parameters file. -This -overrides the link +This overrides the link @file{ntpkey_mv_}@kbd{hostname} in the keys directory. @item @code{pw} @kbd{password} @@ -990,7 +1015,7 @@ supported. Statistic files are managed using file generation sets and scripts in the @file{./scripts} -directory of this distribution. +directory of the source code distribution. Using these facilities and @sc{unix} @@ -1319,7 +1344,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 @code{C}, -and the pid of the ntpd server process. +and the pid of the +@code{ntpd(1ntpdmdoc)} +server process. When the number of links is greater than one, the file is unlinked. This @@ -1363,7 +1390,9 @@ Source address based restrictions are easily circumvented by a determined cracker. 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 +@code{restrict} +command or implicitly as the result of cryptographic or rate limit violations. Cryptographic violations include certificate @@ -1373,9 +1402,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. @subsubsection The Kiss-of-Death Packet Ordinarily, packets denied service are simply dropped with no @@ -1429,7 +1458,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 +@code{monitor} +subcommand specifies the probability of discard for packets that overflow the rate-control window. @item @code{restrict} @code{address} @code{[@code{mask} @kbd{mask}]} @code{[@kbd{flag} @kbd{...}]} The @@ -1485,7 +1516,9 @@ If another KoD packet occurs within one second after the last one, the packet is dropped. @item @code{limited} Deny service if the packet spacing violates the lower limits specified -in the discard command. +in the +@code{discard} +command. A history of clients is kept using the monitoring capability of @code{ntpd(1ntpdmdoc)}. @@ -1545,7 +1578,9 @@ queries. @item @code{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 +@code{ntpq(1ntpqmdoc)} +control message protocol which is intended for use by remote event logging programs. @item @code{notrust} Deny service unless the packet is cryptographically authenticated. @@ -1613,8 +1648,11 @@ The library can also be used with other NTPv4 modes as well and is highly recommended, especially for broadcast modes. 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 +@code{manycastclient} +command, which is similar to the +@code{server} +command but with a multicast (IPv4 class @code{D} or IPv6 prefix @code{FF}) @@ -1684,7 +1722,9 @@ command and, under normal circumstances, increments to the @code{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 +@code{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. @@ -2293,7 +2333,8 @@ drift file is located in, and that file system links, symbolic or otherwise, should be avoided. @item @code{dscp} @kbd{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. @item @code{enable} @code{[@code{auth} | @code{bclient} | @code{calibrate} | @code{kernel} | @code{mode7} | @code{monitor} | @code{ntp} | @code{stats} | @code{unpeer_crypto_early} | @code{unpeer_crypto_nak_early} | @code{unpeer_digest_early}]} @item @code{disable} @code{[@code{auth} | @code{bclient} | @code{calibrate} | @code{kernel} | @code{mode7} | @code{monitor} | @code{ntp} | @code{stats} | @code{unpeer_crypto_early} | @code{unpeer_crypto_nak_early} | @code{unpeer_digest_early}]} Provides a way to enable or disable various server options. @@ -2502,7 +2543,8 @@ A message class may also be followed by the @code{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: @verbatim logconfig =syncstatus +sysevents @@ -2526,7 +2568,9 @@ This command specifies the location of an alternate log file to be used instead of the default system @code{syslog(3)} facility. -This is the same operation as the -l command line option. +This is the same operation as the +@code{-l} +command line option. @item @code{setvar} @kbd{variable} @code{[@code{default}]} This command adds an additional system variable. These @@ -2654,7 +2698,8 @@ Specifies the maximum size of the process stack on systems with the function. Defaults to 50 4k pages (200 4k pages in OpenBSD). @item @code{filenum} @kbd{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. @end table @item @code{trap} @kbd{host_address} @code{[@code{port} @kbd{port_number}]} @code{[@code{interface} @kbd{interface_address}]} This command configures a trap receiver at the given host |