diff options
Diffstat (limited to 'doc/chrony.conf.man.in')
| -rw-r--r-- | doc/chrony.conf.man.in | 93 |
1 files changed, 80 insertions, 13 deletions
diff --git a/doc/chrony.conf.man.in b/doc/chrony.conf.man.in index 66d2358..8b04427 100644 --- a/doc/chrony.conf.man.in +++ b/doc/chrony.conf.man.in @@ -2,12 +2,12 @@ .\" Title: chrony.conf .\" Author: [see the "AUTHOR(S)" section] .\" Generator: Asciidoctor 2.0.20 -.\" Date: 2023-12-05 +.\" Date: 2024-08-29 .\" Manual: Configuration Files .\" Source: chrony @CHRONY_VERSION@ .\" Language: English .\" -.TH "CHRONY.CONF" "5" "2023-12-05" "chrony @CHRONY_VERSION@" "Configuration Files" +.TH "CHRONY.CONF" "5" "2024-08-29" "chrony @CHRONY_VERSION@" "Configuration Files" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 @@ -144,6 +144,15 @@ mechanism. Unlike with the \fBkey\fP option, the server and client do not need t share a key in a key file. NTS has a Key Establishment (NTS\-KE) protocol using the Transport Layer Security (TLS) protocol to get the keys and cookies required by NTS for authentication of NTP packets. +.sp +With this option, the hostname specified in the server or pool directive is the +NTS\-KE server or pool of NTS\-KE servers respectively. The NTP server usually +runs on the same host, but it can be separated from the NTS\-KE server (the +hostname or address of the NTP server is provided to the client by the NTS\-KE +server). +.sp +The NTS\-KE server can be specified by IP address if it is included in the +server\(cqs certificate as a Subject Alternative Name (SAN). .RE .sp \fBcertset\fP \fIID\fP @@ -280,7 +289,7 @@ enable measurements to start.) .sp \fBprefer\fP .RS 4 -Prefer this source over sources without the \fBprefer\fP option. +Prefer this source over other selectable sources without the \fBprefer\fP option. .RE .sp \fBnoselect\fP @@ -450,6 +459,13 @@ field should be enabled only for servers known to be running \fBchronyd\fP versi .RE .RE .sp +\fBipv4\fP, \fBipv6\fP +.RS 4 +These options force \fBchronyd\fP to use only IPv4 or IPv6 addresses respectively +for this source. They do not override the \fB\-4\fP or \fB\-6\fP option on the \fBchronyd\fP +command line. +.RE +.sp .RS 4 .RE @@ -877,7 +893,7 @@ maximum value is adjusted to the number of driver polls per source poll, i.e. .sp \fBprefer\fP .RS 4 -Prefer this source over sources without the prefer option. +Prefer this source over other selectable sources without the \fBprefer\fP option. .RE .sp \fBnoselect\fP @@ -908,9 +924,10 @@ trusted and required source. .RS 4 This option indicates that the reference clock keeps time in TAI instead of UTC and that \fBchronyd\fP should correct its offset by the current TAI\-UTC offset. The -\fBleapsectz\fP directive must be used with this option and the -database must be kept up to date in order for this correction to work as -expected. This option does not make sense with PPS refclocks. +\fBleapsectz\fP or \fBleapseclist\fP directive must be +used with this option and the database must be kept up to date in order for +this correction to work as expected. This option does not make sense with PPS +refclocks. .RE .sp \fBlocal\fP @@ -1652,6 +1669,25 @@ Wed Dec 31 23:59:60 UTC 2008 .if n .RE .RE .sp +\fBleapseclist\fP \fIfile\fP +.RS 4 +This directive specifies the path to a file containing a list of leap seconds +and TAI\-UTC offsets in NIST/IERS format. It is recommended to use +the file \fIleap\-seconds.list\fP usually included with the system timezone +database. The behaviour of this directive is otherwise equivalent to +\fBleapsectz\fP. +.sp +An example of this directive is: +.sp +.if n .RS 4 +.nf +.fam C +leapseclist /usr/share/zoneinfo/leap\-seconds.list +.fam +.fi +.if n .RE +.RE +.sp \fBmakestep\fP \fIthreshold\fP \fIlimit\fP .RS 4 Normally \fBchronyd\fP will cause the system to gradually correct any time offset, @@ -2132,6 +2168,17 @@ distance = delay / 2 + dispersion .if n .RE .RE .sp +\fBactivate\fP \fIdistance\fP +.RS 4 +This option sets an activating root distance for the local reference. The +local reference will not be used until the root distance drops below the +configured value for the first time. This can be used to prevent the local +reference from being activated on a server which has never been synchronised +with an upstream server. The default value of 0.0 causes no activating +distance to be used, such that the local reference is always eligible for +activation. +.RE +.sp \fBorphan\fP .RS 4 This option enables a special \(oqorphan\(cq mode, where sources with stratum equal @@ -2161,7 +2208,7 @@ An example of the directive is: .if n .RS 4 .nf .fam C -local stratum 10 orphan distance 0.1 +local stratum 10 orphan distance 0.1 activate 0.5 .fam .fi .if n .RE @@ -2369,6 +2416,17 @@ rate is defined as a power of 1/2 and it is 2 by default, i.e. on average at least every fourth request has a response. The minimum value is 1 and the maximum value is 4. .RE +.sp +\fBkod\fP \fIrate\fP +.RS 4 +This option sets the rate at which Kiss\-o\*(Aq\-Death (KoD) RATE responses are +randomly sent when the limits specified by the \fBinterval\fP and \fBburst\fP options +are exceeded. It is an additional stream of responses to the \fBleak\fP option. A +KoD RATE response is a request for the client to reduce its polling rate. Few +implementations actually support it. The rate is defined as a power of 1/2. The +default value is 0, which means disabled. The minimum value is 0 and the +maximum value is 4. +.RE .RE .sp @@ -2393,7 +2451,7 @@ packets, by up to 75% (with default \fBleak\fP of 2). .RS 4 This directive enables rate limiting of NTS\-KE requests. It is similar to the \fBratelimit\fP directive, except the default interval is 6 -(1 connection per 64 seconds). +(1 connection per 64 seconds) and the \fBkod\fP option is not supported. .sp An example of the use of the directive is: .sp @@ -2582,8 +2640,8 @@ need to be run with the \fB\-p 257\fP option to inter\-operate correctly.) .RS 4 This directive enables response rate limiting for command packets. It is similar to the \fBratelimit\fP directive, except responses to -localhost are never limited and the default interval is \-4 (16 packets per -second). +localhost are never limited, the default interval is \-4 (16 packets per +second), and the \fBkod\fP option is not supported. .sp An example of the use of the directive is: .sp @@ -2861,8 +2919,8 @@ RFC 5905 tests 5 through 7 (1=pass, 0=fail) [111] Results of the \fBmaxdelay\fP, \fBmaxdelayratio\fP, and \fBmaxdelaydevratio\fP (or \fBmaxdelayquant\fP) tests, and a test for synchronisation loop (1=pass, 0=fail). The first test from these four also checks the server precision, -response time, and whether an interleaved response is acceptable for -synchronisation. [1111] +response time, validity of the measured offset, and whether an interleaved +response is acceptable for synchronisation. [1111] .RE .sp .RS 4 @@ -4520,6 +4578,8 @@ pidfile /run/chronyd.pid .fam .fi .if n .RE +.sp +Setting this directive to \fI/\fP disables writing and checking of the PID file. .RE .sp \fBptpport\fP \fIport\fP @@ -4557,6 +4617,13 @@ ptpport 319 .if n .RE .RE .sp +\fBptpdomain\fP \fIdomain\fP +.RS 4 +The \fBptpdomain\fP directive sets the PTP domain number of transmitted and +accepted NTP\-over\-PTP messages. Messages from other domains are ignored. +The default is 123, the minimum is 0, and the maximum is 255. +.RE +.sp \fBsched_priority\fP \fIpriority\fP .RS 4 On Linux, FreeBSD, NetBSD, and illumos, the \fBsched_priority\fP directive will |