From d8e1613ed2b657f3ac6d490ebad829c292cf2365 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 27 Sep 2021 09:09:30 +0200 Subject: [PATCH] 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. --- man/systemd.automount.xml | 10 ++++++++-- man/systemd.device.xml | 7 +++++++ man/systemd.mount.xml | 14 +++++++------- man/systemd.path.xml | 13 +++++++++---- man/systemd.scope.xml | 8 +++++++- man/systemd.service.xml | 11 ++++++++--- man/systemd.slice.xml | 8 ++++++++ man/systemd.socket.xml | 15 +++++++-------- man/systemd.swap.xml | 14 ++++++-------- man/systemd.target.xml | 8 ++++++++ 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 a6bc81e216b..37fd7435522 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"> - + systemd.automount systemd @@ -124,7 +124,11 @@ Options - Automount files must include an [Automount] section, which + Automount unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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: @@ -157,6 +161,8 @@ default. + + diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 596d334d5df..a4128207e4e 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -147,7 +147,14 @@ + + + Options + + Device unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. No + options specific to this file type are supported. diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 8b71c96ab5e..6b0efb68df4 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"> - + systemd.mount systemd @@ -442,7 +442,11 @@ Options - Mount files must include a [Mount] section, which carries + Mount unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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 @@ - Check - systemd.exec5 - and - systemd.kill5 - for more settings. + diff --git a/man/systemd.path.xml b/man/systemd.path.xml index bca1514b336..44afba08c9a 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"> - + systemd.path systemd @@ -103,9 +103,12 @@ Options - 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: + Path unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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: @@ -184,6 +187,8 @@ to . + + diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index 7d7b32df46d..6d991b915fd 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"> - + systemd.scope systemd @@ -89,6 +89,10 @@ Options + Socket files may include a [Unit] section, which is described in + systemd.unit5. + + 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 @@ infinity (the default) to configure no runtime limit. + + diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 1745dbb49b6..4891f27ebad 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -134,7 +134,11 @@ Options - Service files must include a [Service] + Service unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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 @@ - Check - systemd.exec5 and + Check + systemd.unit5, + systemd.exec5, and systemd.kill5 for more settings. diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index 0d3616f8b11..ed066d2a820 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -98,6 +98,14 @@ + + Options + + Slice unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + No options specific to this file type are supported. + + See Also diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 1600656fdbb..f977f115415 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"> - + systemd.socket systemd @@ -159,7 +159,11 @@ Options - Socket files must include a [Socket] section, which carries + Socket unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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 @@ - Check - systemd.exec5 - and - systemd.kill5 - for more settings. - + diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 2a867f92e97..8287382eb68 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"> - - + systemd.swap systemd @@ -169,6 +167,10 @@ Options + Swap unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + 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 @@ - Check - systemd.exec5 - and - systemd.kill5 - for more settings. + diff --git a/man/systemd.target.xml b/man/systemd.target.xml index bd618d8e93b..604b14e4383 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -84,6 +84,14 @@ + + Options + + Target unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + No options specific to this file type are supported. + + Example diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 84c5bb564cc..49bcb18be52 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"> - + systemd.timer systemd @@ -94,7 +94,11 @@ Options - Timer files must include a [Timer] section, which carries + Timer unit files may include [Unit] and [Install] sections, which are described in + systemd.unit5. + + + 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: @@ -178,7 +182,6 @@ precise time configured with these settings, as they are subject to the AccuracySec= setting below. - @@ -357,6 +360,8 @@ . + +