summaryrefslogtreecommitdiffstats
path: root/man/systemd.unit.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2023-05-03 10:33:01 +0200
committerLennart Poettering <lennart@poettering.net>2023-06-02 18:43:10 +0200
commit4de665812aa83fffcdf7395eccc7e0b1d74ef4c2 (patch)
tree25ced01a62bf3e81cf17a77706f2e786788360c0 /man/systemd.unit.xml
parentfstab-util: consider /run/nextroot/ among extrinsic mounts (diff)
downloadsystemd-4de665812aa83fffcdf7395eccc7e0b1d74ef4c2.tar.xz
systemd-4de665812aa83fffcdf7395eccc7e0b1d74ef4c2.zip
man: document the soft reboot operation
Diffstat (limited to 'man/systemd.unit.xml')
-rw-r--r--man/systemd.unit.xml49
1 files changed, 28 insertions, 21 deletions
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index fcd1f914a8..77c3cd24f8 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -999,27 +999,34 @@
<term><varname>FailureAction=</varname></term>
<term><varname>SuccessAction=</varname></term>
- <listitem><para>Configure the action to take when the unit stops and enters a failed state or inactive state.
- Takes one of <option>none</option>, <option>reboot</option>, <option>reboot-force</option>,
- <option>reboot-immediate</option>, <option>poweroff</option>, <option>poweroff-force</option>,
- <option>poweroff-immediate</option>, <option>exit</option>, and <option>exit-force</option>. In system mode,
- all options are allowed. In user mode, only <option>none</option>, <option>exit</option>, and
- <option>exit-force</option> are allowed. Both options default to <option>none</option>.</para>
-
- <para>If <option>none</option> is set, no action will be triggered. <option>reboot</option> causes a reboot
- following the normal shutdown procedure (i.e. equivalent to <command>systemctl reboot</command>).
- <option>reboot-force</option> causes a forced reboot which will terminate all processes forcibly but should
- cause no dirty file systems on reboot (i.e. equivalent to <command>systemctl reboot -f</command>) and
- <option>reboot-immediate</option> causes immediate execution of the
- <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, which
- might result in data loss (i.e. equivalent to <command>systemctl reboot -ff</command>). Similarly,
- <option>poweroff</option>, <option>poweroff-force</option>, <option>poweroff-immediate</option> have the effect
- of powering down the system with similar semantics. <option>exit</option> causes the manager to exit following
- the normal shutdown procedure, and <option>exit-force</option> causes it terminate without shutting down
- services. When <option>exit</option> or <option>exit-force</option> is used by default the exit status of the
- main process of the unit (if this applies) is returned from the service manager. However, this may be overridden
- with <varname>FailureActionExitStatus=</varname>/<varname>SuccessActionExitStatus=</varname>, see
- below.</para></listitem>
+ <listitem><para>Configure the action to take when the unit stops and enters a failed state or
+ inactive state. Takes one of <option>none</option>, <option>reboot</option>,
+ <option>reboot-force</option>, <option>reboot-immediate</option>, <option>poweroff</option>,
+ <option>poweroff-force</option>, <option>poweroff-immediate</option>, <option>exit</option>,
+ <option>exit-force</option>, <option>soft-reboot</option> and <option>soft-reboot-force</option>. In
+ system mode, all options are allowed. In user mode, only <option>none</option>,
+ <option>exit</option>, <option>exit-force</option>, <option>soft-reboot</option> and
+ <option>soft-reboot-force</option> are allowed. Both options default to <option>none</option>.</para>
+
+ <para>If <option>none</option> is set, no action will be triggered. <option>reboot</option> causes a
+ reboot following the normal shutdown procedure (i.e. equivalent to <command>systemctl
+ reboot</command>). <option>reboot-force</option> causes a forced reboot which will terminate all
+ processes forcibly but should cause no dirty file systems on reboot (i.e. equivalent to
+ <command>systemctl reboot -f</command>) and <option>reboot-immediate</option> causes immediate
+ execution of the
+ <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
+ call, which might result in data loss (i.e. equivalent to <command>systemctl reboot
+ -ff</command>). Similarly, <option>poweroff</option>, <option>poweroff-force</option>,
+ <option>poweroff-immediate</option> have the effect of powering down the system with similar
+ semantics. <option>exit</option> causes the manager to exit following the normal shutdown procedure,
+ and <option>exit-force</option> causes it terminate without shutting down services. When
+ <option>exit</option> or <option>exit-force</option> is used by default the exit status of the main
+ process of the unit (if this applies) is returned from the service manager. However, this may be
+ overridden with
+ <varname>FailureActionExitStatus=</varname>/<varname>SuccessActionExitStatus=</varname>, see
+ below. <option>soft-reboot</option> will trigger a userspace reboot
+ operation. <option>soft-reboot-force</option> does that too, but does not go through the shutdown
+ transaction beforehand.</para></listitem>
</varlistentry>
<varlistentry>