X Tutup
Skip to content

Commit c91ebcd

Browse files
committed
man: explain settings in timesyncd.conf(5)
Fixes systemd#18508.
1 parent d5630d2 commit c91ebcd

File tree

1 file changed

+33
-28
lines changed

1 file changed

+33
-28
lines changed

man/timesyncd.conf.xml

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -47,54 +47,59 @@
4747

4848
<varlistentry>
4949
<term><varname>NTP=</varname></term>
50-
<listitem><para>A space-separated list of NTP server host
51-
names or IP addresses. During runtime this list is combined
52-
with any per-interface NTP servers acquired from
50+
<listitem><para>A space-separated list of NTP server host names or IP addresses. During runtime this
51+
list is combined with any per-interface NTP servers acquired from
5352
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
54-
systemd-timesyncd will contact all configured system or
55-
per-interface servers in turn until one is found that
56-
responds. When the empty string is assigned, the list of
57-
NTP servers is reset, and all assignments prior to this one
58-
will have no effect. This setting defaults to an empty
59-
list.</para></listitem>
53+
<command>systemd-timesyncd</command> will contact all configured system or per-interface servers in
54+
turn, until one responds. When the empty string is assigned, the list of NTP servers is reset, and
55+
all prior assignments will have no effect. This setting defaults to an empty list.</para></listitem>
6056
</varlistentry>
6157

6258
<varlistentry>
6359
<term><varname>FallbackNTP=</varname></term>
64-
<listitem><para>A space-separated list of NTP server host
65-
names or IP addresses to be used as the fallback NTP servers.
66-
Any per-interface NTP servers obtained from
60+
<listitem><para>A space-separated list of NTP server host names or IP addresses to be used as the
61+
fallback NTP servers. Any per-interface NTP servers obtained from
6762
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
68-
take precedence over this setting, as do any servers set via
69-
<varname>NTP=</varname> above. This setting is hence only used
70-
if no other NTP server information is known. When the empty
71-
string is assigned, the list of NTP servers is reset,
72-
and all assignments prior to this one will have no effect.
73-
If this option is not given, a compiled-in list of NTP servers
74-
is used instead.</para></listitem>
63+
take precedence over this setting, as do any servers set via <varname>NTP=</varname> above. This
64+
setting is hence only relevant if no other NTP server information is known. When the empty string is
65+
assigned, the list of NTP servers is reset, and all prior assignments will have no effect. If this
66+
option is not given, a compiled-in list of NTP servers is used.</para></listitem>
7567
</varlistentry>
7668

7769
<varlistentry>
7870
<term><varname>RootDistanceMaxSec=</varname></term>
79-
<listitem><para>Maximum acceptable root distance. Takes a time value (in seconds).
71+
<listitem><para>Maximum acceptable root distance, i.e. the maximum estimated time required for a
72+
packet to travel to the server we are connected to from the server with the reference clock. If
73+
the current server does not satisfy this limit, <command>systemd-timesyncd</command> will switch
74+
to a different server.</para>
75+
76+
<para>Takes a time value. The default unit is seconds, but other units may be specified, see
77+
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
8078
Defaults to 5 seconds.</para></listitem>
8179
</varlistentry>
8280

8381
<varlistentry>
8482
<term><varname>PollIntervalMinSec=</varname></term>
8583
<term><varname>PollIntervalMaxSec=</varname></term>
86-
<listitem><para>The minimum and maximum poll intervals for NTP messages.
87-
Each setting takes a time value (in seconds).
88-
<varname>PollIntervalMinSec=</varname> must not be smaller than 16 seconds.
89-
<varname>PollIntervalMaxSec=</varname> must be larger than <varname>PollIntervalMinSec=</varname>.
90-
<varname>PollIntervalMinSec=</varname> defaults to 32 seconds, and
91-
<varname>PollIntervalMaxSec=</varname> defaults to 2048 seconds.</para></listitem>
84+
<listitem><para>The minimum and maximum poll intervals for NTP messages. Polling starts at the
85+
minimum poll interval, and is adjusted within the specified limits in response to received packets.
86+
</para>
87+
88+
<para>Each setting takes a time value. The default unit is seconds, but other units may be specified,
89+
see <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
90+
<varname>PollIntervalMinSec=</varname> defaults to 32 seconds and must not be smaller than
91+
16 seconds. <varname>PollIntervalMaxSec=</varname> defaults to 34 min 8 s (2048 seconds) and must be
92+
larger than <varname>PollIntervalMinSec=</varname>.</para></listitem>
9293
</varlistentry>
9394

9495
<varlistentry>
9596
<term><varname>ConnectionRetrySec=</varname></term>
96-
<listitem><para>Specifies the delaying attempts to contact servers after network is online. Takes a time value (in seconds).
97-
Defaults to 30 seconds and must not be smaller than 1 seconds.</para></listitem>
97+
<listitem><para>Specifies the minimum delay before subsequent attempts to contact a new NTP server
98+
are made.</para>
99+
100+
<para>Takes a time value. The default unit is seconds, but other units may be specified, see
101+
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
102+
Defaults to 30 seconds and must not be smaller than 1 second.</para></listitem>
98103
</varlistentry>
99104

100105
</variablelist>

0 commit comments

Comments
 (0)
X Tutup