Merge pull request #11427 from kragniz/10659-env-file-quotes

[thirdparty/systemd.git] / man / timesyncd.conf.xml

diff --git a/man/timesyncd.conf.xml b/man/timesyncd.conf.xml
index 10c2de89f6a36dcf65810b053f45853d0c5bc3c7..8ba639f3ae88178fc641689f5b5757420a442f77 100644 (file)
--- a/man/timesyncd.conf.xml
+++ b/man/timesyncd.conf.xml
@@ -3,22 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
-
-  Copyright 2014 Lennart Poettering
-
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
-
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+  SPDX-License-Identifier: LGPL-2.1+
 -->
 
 <refentry id="timesyncd.conf" conditional='ENABLE_TIMESYNCD'
@@ -26,15 +11,6 @@
   <refentryinfo>
     <title>timesyncd.conf</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
@@ -58,9 +34,9 @@
   <refsect1>
     <title>Description</title>
 
-    <para>These configuration files control NTP network time
-    synchronization.</para>
-
+    <para>These configuration files control NTP network time synchronization. See
+    <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a general description of the syntax.</para>
   </refsect1>
 
   <xi:include href="standard-conf.xml" xpointer="main-conf" />
@@ -68,6 +44,8 @@
   <refsect1>
     <title>Options</title>
 
+    <para>The following settings are configured in the <literal>[Time]</literal> section:</para>
+
     <variablelist class='network-directives'>
 
       <varlistentry>
@@ -78,7 +56,9 @@
         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
         systemd-timesyncd will contact all configured system or
         per-interface servers in turn until one is found that
-        responds. This setting defaults to an empty
+        responds. When the empty string is assigned, the list of
+        NTP servers is reset, and all assignments prior to this one
+        will have no effect. This setting defaults to an empty
         list.</para></listitem>
       </varlistentry>
 
@@ -90,9 +70,28 @@
         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
         take precedence over this setting, as do any servers set via
         <varname>NTP=</varname> above. This setting is hence only used
-        if no other NTP server information is known. If this option is
-        not given, a compiled-in list of NTP servers is used
-        instead.</para></listitem>
+        if no other NTP server information is known. When the empty
+        string is assigned, the list of NTP servers is reset,
+        and all assignments prior to this one will have no effect.
+        If this option is not given, a compiled-in list of NTP servers
+        is used instead.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>RootDistanceMaxSec=</varname></term>
+        <listitem><para>Maximum acceptable root distance. Takes a time value (in seconds).
+        Defaults to 5 seconds.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>PollIntervalMinSec=</varname></term>
+        <term><varname>PollIntervalMaxSec=</varname></term>
+        <listitem><para>The minimum and maximum poll intervals for NTP messages.
+        Each setting takes a time value (in seconds).
+        <varname>PollIntervalMinSec=</varname> must not be smaller than 16 seconds.
+        <varname>PollIntervalMaxSec=</varname> must be larger than <varname>PollIntervalMinSec=</varname>.
+        <varname>PollIntervalMinSec=</varname> defaults to 32 seconds, and
+        <varname>PollIntervalMaxSec=</varname> defaults to 2048 seconds.</para></listitem>
       </varlistentry>
 
     </variablelist>