summaryrefslogtreecommitdiff
path: root/man/systemd.socket.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2021-09-27 09:09:30 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2021-09-27 09:19:02 +0200
commitd8e1613ed2b657f3ac6d490ebad829c292cf2365 (patch)
tree398285808596e38eab90977dcad617acae2742d0 /man/systemd.socket.xml
parent18c7a1eb6c7ede7255309d71a28b995d86de9444 (diff)
downloadsystemd-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/systemd.socket.xml')
-rw-r--r--man/systemd.socket.xml15
1 files changed, 7 insertions, 8 deletions
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>