diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-09-27 09:09:30 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-09-27 09:19:02 +0200 |
commit | d8e1613ed2b657f3ac6d490ebad829c292cf2365 (patch) | |
tree | 398285808596e38eab90977dcad617acae2742d0 /man | |
parent | 18c7a1eb6c7ede7255309d71a28b995d86de9444 (diff) | |
download | systemd-d8e1613ed2b657f3ac6d490ebad829c292cf2365.tar.gz |
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.
Diffstat (limited to 'man')
-rw-r--r-- | man/systemd.automount.xml | 10 | ||||
-rw-r--r-- | man/systemd.device.xml | 7 | ||||
-rw-r--r-- | man/systemd.mount.xml | 14 | ||||
-rw-r--r-- | man/systemd.path.xml | 13 | ||||
-rw-r--r-- | man/systemd.scope.xml | 8 | ||||
-rw-r--r-- | man/systemd.service.xml | 11 | ||||
-rw-r--r-- | man/systemd.slice.xml | 8 | ||||
-rw-r--r-- | man/systemd.socket.xml | 15 | ||||
-rw-r--r-- | man/systemd.swap.xml | 14 | ||||
-rw-r--r-- | man/systemd.target.xml | 8 | ||||
-rw-r--r-- | man/systemd.timer.xml | 11 |
11 files changed, 83 insertions, 36 deletions
diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index a6bc81e216..37fd743552 100644 --- 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 596d334d5d..a4128207e4 100644 --- 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 8b71c96ab5..6b0efb68df 100644 --- 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 bca1514b33..44afba08c9 100644 --- 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 7d7b32df46..6d991b915f 100644 --- 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 1745dbb49b..4891f27eba 100644 --- 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 0d3616f8b1..ed066d2a82 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -99,6 +99,14 @@ </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> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 1600656fdb..f977f11541 100644 --- 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 2a867f92e9..8287382eb6 100644 --- 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 bd618d8e93..604b14e438 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -85,6 +85,14 @@ </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> <example> diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 84c5bb564c..49bcb18be5 100644 --- 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> |