man: mention pages with more settings at end of each option list

For some unit types we have hundreds of options, and the reader may easily miss
that more options are described in other pages. We already mentioned this in
the introduction and then at the top of the option list, but it can't hurt to
repeat the information.

Also, add an (almost empty) Options section for the unit types which don't have
any custom options. It is nicer to have the same page structure in all cases,
so people can jump between pages for different types more easily.

diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml
index a6bc81e216b50f292ee8cf7ffc3fef787caacfa0..37fd7435522d9dc3b9632fc23f3da7a1dab0f3e2 100644 (file)
--- a/man/systemd.automount.xml
+++ b/man/systemd.automount.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.automount">
+<refentry id="systemd.automount" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.automount</title>
     <productname>systemd</productname>
@@ -124,7 +124,11 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Automount files must include an [Automount] section, which
+    <para>Automount unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Automount unit files must include an [Automount] section, which
     carries information about the file system automount points it
     supervises. The options specific to the [Automount] section of
     automount units are the following:</para>
@@ -157,6 +161,8 @@
         default.</para></listitem>
       </varlistentry>
     </variablelist>
+
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.device.xml b/man/systemd.device.xml
index 596d334d5df575a7a601d839159d4fb140ce433f..a4128207e4e15a2235bed34fd658ff6e34e340e6 100644 (file)
--- a/man/systemd.device.xml
+++ b/man/systemd.device.xml
@@ -147,7 +147,14 @@
       </varlistentry>
 
     </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
 
+    <para>Device unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. No
+    options specific to this file type are supported.</para>
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index 8b71c96ab5e369a67f52cf705ee5dd6f0fa41d8c..6b0efb68df43f1028403cad6eda1a8e63481801a 100644 (file)
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.mount">
+<refentry id="systemd.mount" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.mount</title>
     <productname>systemd</productname>
@@ -442,7 +442,11 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Mount files must include a [Mount] section, which carries
+    <para>Mount unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Mount unit files must include a [Mount] section, which carries
     information about the file system mount points it supervises. A
     number of options that may be used in this section are shared with
     other unit types. These options are documented in
@@ -567,11 +571,7 @@
       </varlistentry>
     </variablelist>
 
-    <para>Check
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    for more settings.</para>
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.path.xml b/man/systemd.path.xml
index bca1514b3368a4b4439032adc4e9549e43776486..44afba08c9a4ff8411ea734e9dbd06bfca94cfc0 100644 (file)
--- a/man/systemd.path.xml
+++ b/man/systemd.path.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.path">
+<refentry id="systemd.path" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.path</title>
     <productname>systemd</productname>
@@ -103,9 +103,12 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Path files must include a [Path] section, which carries
-    information about the path(s) it monitors. The options specific to
-    the [Path] section of path units are the following:</para>
+    <para>Path unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Path unit files must include a [Path] section, which carries information about the path or paths it
+    monitors. The options specific to the [Path] section of path units are the following:</para>
 
     <variablelist class='unit-directives'>
       <varlistentry>
@@ -184,6 +187,8 @@
         to <option>0755</option>.</para></listitem>
       </varlistentry>
     </variablelist>
+
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml
index 7d7b32df46d7f3c9c1da68994660f3bc61046863..6d991b915fdc99b6c57014310f1e384d02eb5818 100644 (file)
--- a/man/systemd.scope.xml
+++ b/man/systemd.scope.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.scope">
+<refentry id="systemd.scope" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.scope</title>
     <productname>systemd</productname>
@@ -89,6 +89,10 @@
   <refsect1>
     <title>Options</title>
 
+    <para>Socket files may include a [Unit] section, which is described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
     <para>Scope files may include a [Scope]
     section, which carries information about the scope and the
     units it contains. A number of options that may be used in
@@ -109,6 +113,8 @@
         <literal>infinity</literal> (the default) to configure no runtime limit.</para></listitem>
       </varlistentry>
     </variablelist>
+
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 1745dbb49b6c99f9719ab2f31ea0fc9e83897a9f..4891f27ebad81407f9929e2a6ddc3952a1a3c568 100644 (file)
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -134,7 +134,11 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Service files must include a [Service]
+    <para>Service unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Service unit files must include a [Service]
     section, which carries information about the service and the
     process it supervises. A number of options that may be used in
     this section are shared with other unit types. These options are
@@ -1107,8 +1111,9 @@
 
     </variablelist>
 
-    <para>Check
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+    <para id='shared-unit-options'>Check
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
     <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
     settings.</para>
   </refsect1>

diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml
index 0d3616f8b11af8a1eb2635101662a506a933a60b..ed066d2a8203ded04d4b444ea1d401a8425e6688 100644 (file)
--- a/man/systemd.slice.xml
+++ b/man/systemd.slice.xml
@@ -98,6 +98,14 @@
     </refsect2>
   </refsect1>
 
+  <refsect1>
+    <title>Options</title>
+
+    <para>Slice unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    No options specific to this file type are supported.</para>
+  </refsect1>
+
   <refsect1>
     <title>See Also</title>
     <para>

diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 1600656fdbb9123af67d0e28dca7da5375926755..f977f1154153c8d13df489f81fcde9285898145b 100644 (file)
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.socket">
+<refentry id="systemd.socket" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.socket</title>
     <productname>systemd</productname>
@@ -159,7 +159,11 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Socket files must include a [Socket] section, which carries
+    <para>Socket unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Socket unit files must include a [Socket] section, which carries
     information about the socket or FIFO it supervises. A number of
     options that may be used in this section are shared with other
     unit types. These options are documented in
@@ -839,12 +843,7 @@
 
     </variablelist>
 
-    <para>Check
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    for more settings.</para>
-
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 2a867f92e9777fc4cc236faaac06e08c0fa215cb..8287382eb686a95ac7751e10146e942260e57ec4 100644 (file)
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -3,9 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.swap"
-          xmlns:xi="http://www.w3.org/2001/XInclude">
-
+<refentry id="systemd.swap" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.swap</title>
     <productname>systemd</productname>
@@ -169,6 +167,10 @@
   <refsect1>
     <title>Options</title>
 
+    <para>Swap unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
     <para>Swap unit files must include a [Swap] section, which carries
     information about the swap device it supervises. A number of
     options that may be used in this section are shared with other
@@ -235,11 +237,7 @@
       </varlistentry>
     </variablelist>
 
-    <para>Check
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    for more settings.</para>
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>

diff --git a/man/systemd.target.xml b/man/systemd.target.xml
index bd618d8e93b1e7c790490ee3db0a4ac8e80324da..604b14e438339ffac71d49a432354e9c9d4b7446 100644 (file)
--- a/man/systemd.target.xml
+++ b/man/systemd.target.xml
@@ -84,6 +84,14 @@
     </refsect2>
   </refsect1>
 
+  <refsect1>
+    <title>Options</title>
+
+    <para>Target unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    No options specific to this file type are supported.</para>
+  </refsect1>
+
   <refsect1>
     <title>Example</title>
 

diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 84c5bb564cc0a316bfbc4a0a69453e7e29be6296..49bcb18be52b7add99cb8b78c25a1d66d96d5ef8 100644 (file)
--- a/man/systemd.timer.xml
+++ b/man/systemd.timer.xml
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="systemd.timer">
+<refentry id="systemd.timer" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>systemd.timer</title>
     <productname>systemd</productname>
@@ -94,7 +94,11 @@
   <refsect1>
     <title>Options</title>
 
-    <para>Timer files must include a [Timer] section, which carries
+    <para>Timer unit files may include [Unit] and [Install] sections, which are described in
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    </para>
+
+    <para>Timer unit files must include a [Timer] section, which carries
     information about the timer it defines. The options specific to
     the [Timer] section of timer units are the following:</para>
 
@@ -178,7 +182,6 @@
         precise time configured with these settings, as they are
         subject to the <varname>AccuracySec=</varname> setting
         below.</para></listitem>
-
       </varlistentry>
 
       <varlistentry>
@@ -357,6 +360,8 @@
         <option>true</option>.</para></listitem>
       </varlistentry>
     </variablelist>
+
+    <xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
   </refsect1>
 
   <refsect1>