chiark / gitweb /
man: drop unused <authorgroup> tags from man sources
[elogind.git] / man / elogind-time-wait-sync.service.xml
index 559379b2e566dd491f07e5c9ecf20a440f7e7959..fb1a68b7183904f79609af3843fb51d9a6553de0 100644 (file)
@@ -5,9 +5,7 @@
 <!--
   SPDX-License-Identifier: LGPL-2.1+
 
-  This file is part of elogind.
-
-  Copyright 2018 Peter A. Bigot
+  Copyright © 2018 Peter A. Bigot
 -->
 
 <refentry id="elogind-time-wait-sync.service" conditional='ENABLE_TIMESYNCD'>
   <refentryinfo>
     <title>elogind-time-wait-sync.service</title>
     <productname>elogind</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Peter</firstname>
-        <surname>Bigot</surname>
-        <email>pab@pabigot.com</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
     <title>Description</title>
 
     <para><filename>elogind-time-wait-sync</filename> is a system service that delays the start of units that depend on
-    <filename>time-sync.target</filename> until <filename>elogind-timesyncd.service</filename> or something else has
-    set the system time and marked it as synchronized.  Reaching this state generally requires synchronization with an
-    external source, such as an NTP server.</para>
+    <filename>time-sync.target</filename> until the system time has been synchronized with an accurate time source by
+    <filename>elogind-timesyncd.service</filename>.</para>
 
-    <para>When this unit is not enabled the <filename>time-sync.target</filename> synchronization point may be reached
-    as soon as the system time is advanced by <filename>elogind-timesyncd.service</filename> to the time stored at the
-    last shutdown.  That time may not meet the expectations of dependent services that require an accurate
-    clock.</para>
+    <para><filename>elogind-timesyncd.service</filename> notifies on successful synchronization.
+    <filename>elogind-time-wait-sync</filename> also tries to detect when the kernel marks the time as synchronized,
+    but this detection is not reliable and is intended only as a fallback for other servies that can be used to
+    synchronize time (e.g., ntpd, chronyd).</para>
 
   </refsect1>
 
   <refsect1>
-    <title>Notes</title>
+    <title>Files</title>
+
+    <variablelist>
+      <varlistentry>
+        <term><filename>/run/systemd/timesync/synchronized</filename></term>
+
+        <listitem>
+          <para>The presence of this file indicates to this service that the system clock has been synchronized.</para>
+        </listitem>
+
+      </varlistentry>
+    </variablelist>
 
-    <para>This service works correctly with a time synchronization service like
-    <filename>elogind-timesyncd.service</filename> that uses the same protocol as NTP to set the time from a
-    synchronized source.  When used with time synchronization services that follow a different protocol the event of
-    setting synchronized time may not be detected in which case this service will not complete.</para>
   </refsect1>
 
   <refsect1>