mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-23 18:23:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2021-09-27 09:09:30 +02:00
parent 18c7a1eb6c
commit d8e1613ed2
11 changed files with 83 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
man/systemd.automount.xml
View File

@ -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>

7
man/systemd.device.xml
View File

@ -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>

14
man/systemd.mount.xml
View File

@ -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>

13
man/systemd.path.xml
View File

@ -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>

8
man/systemd.scope.xml
View File

@ -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>

11
man/systemd.service.xml
View File

@ -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>

8
man/systemd.slice.xml
View File

@ -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>

15
man/systemd.socket.xml
View File

@ -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>

14
man/systemd.swap.xml
View File

@ -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>

8
man/systemd.target.xml
View File

@ -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>

11
man/systemd.timer.xml
View File

@ -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>