summaryrefslogtreecommitdiffstats
path: root/man/systemd.service.xml
diff options
context:
space:
mode:
authorAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-22 18:52:36 +0200
committerAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-29 15:07:24 +0200
commitec07c3c80b2b1bfa6788500202006ff85f5ae4f4 (patch)
treeab6fb6ca9620a58fc32cdf3dba9b8a0f77d48d18 /man/systemd.service.xml
parentman: Add xinclude namespace (diff)
downloadsystemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.tar.xz
systemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.zip
man: add version info
This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
Diffstat (limited to 'man/systemd.service.xml')
-rw-r--r--man/systemd.service.xml78
1 files changed, 60 insertions, 18 deletions
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index e9c431bd68..10e6da5837 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -321,6 +321,8 @@
<option>cgroup</option> is meant for applications whose forking model is not known ahead of time and which
might not have a specific main process. It is well suited for transient or automatically generated services,
such as graphical applications inside of a desktop environment.</para>
+
+ <xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
@@ -465,6 +467,8 @@
also applies to <varname>ExecCondition=</varname>. <varname>ExecCondition=</varname> will also run the commands
in <varname>ExecStopPost=</varname>, as part of stopping the service, in the case of any non-zero or abnormal
exits, like the ones described above.</para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
@@ -579,7 +583,9 @@
of auto-restarts from <varname>RestartSec=</varname> to <varname>RestartMaxDelaySec=</varname>.
Takes a positive integer or 0 to disable it. Defaults to 0.</para>
- <para>This setting is effective only if <varname>RestartMaxDelaySec=</varname> is also set.</para></listitem>
+ <para>This setting is effective only if <varname>RestartMaxDelaySec=</varname> is also set.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
@@ -589,7 +595,9 @@
in the same format as <varname>RestartSec=</varname>, or <literal>infinity</literal>
to disable the setting. Defaults to <literal>infinity</literal>.</para>
- <para>This setting is effective only if <varname>RestartSteps=</varname> is also set.</para></listitem>
+ <para>This setting is effective only if <varname>RestartSteps=</varname> is also set.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
@@ -612,7 +620,9 @@
provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified
until the service startup status is finished by <literal>READY=1</literal>. (see
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v188"/></listitem>
</varlistentry>
<varlistentry>
@@ -641,7 +651,9 @@
provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified,
or terminates itself (see
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v188"/></listitem>
</varlistentry>
<varlistentry>
@@ -672,7 +684,9 @@
provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified,
or terminates itself (see
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
@@ -702,7 +716,9 @@
By using <option>kill</option> the service is immediately terminated by sending
<varname>FinalKillSignal=</varname> without any further timeout. This setting can be used to expedite the
shutdown of failing services.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v246"/></listitem>
</varlistentry>
<varlistentry>
@@ -722,7 +738,9 @@
provided the service repeats <literal>EXTEND_TIMEOUT_USEC=…</literal> within the interval specified
until the service shutdown is achieved by <literal>STOPPING=1</literal> (or termination). (see
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v229"/></listitem>
</varlistentry>
<varlistentry>
@@ -731,7 +749,9 @@
<listitem><para>This option modifies <varname>RuntimeMaxSec=</varname> by increasing the maximum runtime by an
evenly distributed duration between 0 and the specified value (in seconds). If <varname>RuntimeMaxSec=</varname> is
unspecified, then this feature will be disabled.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v250"/></listitem>
</varlistentry>
<varlistentry>
@@ -942,6 +962,8 @@
<para>This option is useful in cases where a dependency can fail temporarily
but we don't want these temporary failures to make the dependent units fail.
When this option is set to <option>direct</option>, dependent units are not notified of these temporary failures.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
@@ -981,7 +1003,9 @@
</example>
<para>Note: <command>systemd-analyze exit-status</command> may be used to list exit statuses and
- translate between numerical status values and names.</para></listitem>
+ translate between numerical status values and names.</para>
+
+ <xi:include href="version-info.xml" xpointer="v189"/></listitem>
</varlistentry>
<varlistentry>
@@ -1005,7 +1029,9 @@
<varname>ExecStopPost=</varname> or <varname>ExecReload=</varname>, but only on the main service
process, i.e. either the one invoked by <varname>ExecStart=</varname> or (depending on
<varname>Type=</varname>, <varname>PIDFile=</varname>, …) the otherwise configured main
- process.</para></listitem>
+ process.</para>
+
+ <xi:include href="version-info.xml" xpointer="v189"/></listitem>
</varlistentry>
<varlistentry>
@@ -1015,7 +1041,9 @@
service restarts, regardless of the restart setting configured
with <varname>Restart=</varname>. The argument format is
similar to
- <varname>RestartPreventExitStatus=</varname>.</para></listitem>
+ <varname>RestartPreventExitStatus=</varname>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v215"/></listitem>
</varlistentry>
<varlistentry>
@@ -1142,7 +1170,9 @@
<para>If this option is set to a non-zero value the <varname>$FDSTORE</varname> environment variable
will be set for processes invoked for this service. See
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
- details.</para></listitem>
+ details.</para>
+
+ <xi:include href="version-info.xml" xpointer="v219"/></listitem>
</varlistentry>
<varlistentry>
@@ -1158,7 +1188,9 @@
file descriptor store pinned until the service manager exits.</para>
<para>Use <command>systemctl clean --what=fdstore …</command> to release the file descriptor store
- explicitly.</para></listitem>
+ explicitly.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
@@ -1171,7 +1203,9 @@
socket unit with <varname>ListenUSBFunction=</varname>
configured. The contents of this file are written to the
<filename>ep0</filename> file after it is
- opened.</para></listitem>
+ opened.</para>
+
+ <xi:include href="version-info.xml" xpointer="v227"/></listitem>
</varlistentry>
<varlistentry>
@@ -1179,7 +1213,9 @@
<listitem><para>Configure the location of a file containing
USB FunctionFS strings. Behavior is similar to
<varname>USBFunctionDescriptors=</varname>
- above.</para></listitem>
+ above.</para>
+
+ <xi:include href="version-info.xml" xpointer="v227"/></listitem>
</varlistentry>
<varlistentry id='oom-policy'>
@@ -1217,7 +1253,9 @@
<para>This setting also applies to
<citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
Similarly to the kernel OOM kills performed by the kernel, this setting determines the state of the
- unit after <command>systemd-oomd</command> kills a cgroup associated with it.</para></listitem>
+ unit after <command>systemd-oomd</command> kills a cgroup associated with it.</para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
@@ -1248,7 +1286,9 @@
(due to running in a separate mount namespace, not having privileges, ...).</para>
<para>This setting can be specified multiple times, in which case all the specified paths are opened and the file descriptors passed to the service.
- If the empty string is assigned, the entire list of open files defined prior to this is reset.</para></listitem>
+ If the empty string is assigned, the entire list of open files defined prior to this is reset.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
<varlistentry>
@@ -1256,7 +1296,9 @@
<listitem><para>Configures the UNIX process signal to send to the service's main process when asked
to reload the service's configuration. Defaults to <constant>SIGHUP</constant>. This option has no
effect unless <varname>Type=</varname><option>notify-reload</option> is used, see
- above.</para></listitem>
+ above.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
</variablelist>