summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2015-08-16 18:26:03 +0200
committerLennart Poettering <lennart@poettering.net>2015-08-16 18:29:54 +0200
commit8731be1a529272e8010505627316161adb476842 (patch)
tree8ac25094ca4854601c2de7a70dccda38594235f0
parente6a26d8c972d45a0927ad0b7c654c830daa2243e (diff)
man: extend documentation for timedatectl's set-ntp command
This extends on the relationship between timedatectl's set-ntp command and its effect on the systemd-timesyncd.service unit. This also links that unit back to the timedatectl man page. Closes #798.
-rw-r--r--man/systemd-timesyncd.service.xml4
-rw-r--r--man/timedatectl.xml27
2 files changed, 25 insertions, 6 deletions
diff --git a/man/systemd-timesyncd.service.xml b/man/systemd-timesyncd.service.xml
index ac1af2d136..01ed0b8149 100644
--- a/man/systemd-timesyncd.service.xml
+++ b/man/systemd-timesyncd.service.xml
@@ -71,6 +71,10 @@
files, and the per-link dynamic settings received over DHCP. See
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more details.</para>
+
+ <para><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
+ <command>set-ntp</command> command may be used to enable and
+ start, or disable and stop this service.</para>
</refsect1>
<refsect1>
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 2d42b41d5e..9a86c4126a 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -166,12 +166,27 @@
<term><command>set-ntp [BOOL]</command></term>
<listitem><para>Takes a boolean argument. Controls whether
- network time synchronization is enabled (if available). This
- enables or disables the
- <filename>systemd-timesyncd.service</filename> unit. Note that
- even if this command turns time synchronization off a
- different system service might still synchronize the clock
- with the network.</para></listitem>
+ network time synchronization is active and enabled (if
+ available). This enables and starts, or disables and stops the
+ <filename>systemd-timesyncd.service</filename> unit. It does
+ not affect the state of any other, unrelated network time
+ synchronization services that might be installed on the
+ system. This command is hence mostly equivalent to:
+ <command>systemctl enable --now
+ systemd-timesyncd.service</command> and <command>systemctl
+ disable --now systemd-timesyncd.service</command>, but is
+ protected by a different access policy.</para>
+
+ <para>Note that even if time synchronization is turned off
+ with this command another, unrelated system service might
+ still synchronize the clock with the network. Also note that
+ strictly speaking
+ <filename>systemd-timesyncd.service</filename> does more than
+ just network time synchronization as it ensures a monotonic
+ clock on systems without RTC even if no network is
+ available. See
+ <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ for details about this.</para></listitem>
</varlistentry>
</variablelist>