summaryrefslogtreecommitdiffstats
path: root/man/systemctl.xml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 03:50:40 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-12 03:50:40 +0000
commitfc53809803cd2bc2434e312b19a18fa36776da12 (patch)
treeb4b43bd6538f51965ce32856e9c053d0f90919c8 /man/systemctl.xml
parentAdding upstream version 255.5. (diff)
downloadsystemd-fc53809803cd2bc2434e312b19a18fa36776da12.tar.xz
systemd-fc53809803cd2bc2434e312b19a18fa36776da12.zip
Adding upstream version 256.upstream/256
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/systemctl.xml')
-rw-r--r--man/systemctl.xml426
1 files changed, 265 insertions, 161 deletions
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 9bdd882..70fd91f 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -1,6 +1,6 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
@@ -350,7 +350,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
"fragment" and "drop-ins" (source files) of units. Each
file is preceded by a comment which includes the file
name. Note that this shows the contents of the backing files
- on disk, which may not match the system manager's
+ on disk, which might not match the system manager's
understanding of these units if any unit files were
updated on disk and the <command>daemon-reload</command>
command wasn't issued since.</para>
@@ -513,7 +513,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
don't document that. -->
- <xi:include href="version-info.xml" xpointer="v229"/>
+ <xi:include href="version-info.xml" xpointer="v229"/>
</listitem>
</varlistentry>
<varlistentry>
@@ -569,6 +569,51 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
these three types of resources are generally redundant and reproducible on the next invocation of
the unit). Note that the specified units must be stopped to invoke this operation.</para>
+ <table>
+ <title>
+ Possible values for <option>--what=</option>
+ </title>
+
+ <tgroup cols='2'>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Unit Setting</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>runtime</literal></entry>
+ <entry><varname>RuntimeDirectory=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>state</literal></entry>
+ <entry><varname>StateDirectory=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>cache</literal></entry>
+ <entry><varname>CacheDirectory=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>logs</literal></entry>
+ <entry><varname>LogsDirectory=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>configuration</literal></entry>
+ <entry><varname>ConfigurationDirectory=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>fdstore</literal></entry>
+ <entry><varname>FileDescriptorStorePreserve=</varname></entry>
+ </row>
+ <row>
+ <entry><literal>all</literal></entry>
+ <entry>All of the above</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
@@ -1066,8 +1111,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</tgroup>
</table>
- <xi:include href="version-info.xml" xpointer="v238"/>
-
+ <xi:include href="version-info.xml" xpointer="v238"/>
</listitem>
</varlistentry>
@@ -1171,7 +1215,6 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<command>enable</command>.</para>
<xi:include href="version-info.xml" xpointer="v217"/>
-
</listitem>
</varlistentry>
@@ -1179,38 +1222,40 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><command>edit <replaceable>UNIT</replaceable>…</command></term>
<listitem>
- <para>Edit a drop-in snippet or a whole replacement file if
- <option>--full</option> is specified, to extend or override the
- specified unit.</para>
+ <para>Edit or replace a drop-in snippet or the main unit file, to extend or override the
+ definition of the specified unit.</para>
- <para>Depending on whether <option>--system</option> (the default),
- <option>--user</option>, or <option>--global</option> is specified,
- this command creates a drop-in file for each unit either for the system,
- for the calling user, or for all futures logins of all users. Then,
- the editor (see the "Environment" section below) is invoked on
- temporary files which will be written to the real location if the
- editor exits successfully.</para>
+ <para>Depending on whether <option>--system</option> (the default), <option>--user</option>, or
+ <option>--global</option> is specified, this command will operate on the system unit files, unit
+ files for the calling user, or the unit files shared between all users.</para>
+
+ <para>The editor (see the "Environment" section below) is invoked on temporary files which will
+ be written to the real location if the editor exits successfully. After the editing is finished,
+ configuration is reloaded, equivalent to <command>systemctl daemon-reload --system</command> or
+ <command>systemctl daemon-reload --user</command>. For <command>edit --global</command>, the
+ reload is not performed and the edits will take effect only for subsequent logins (or after a
+ reload is requested in a different way).</para>
+
+ <para>If <option>--full</option> is specified, a replacement for the main unit file will be
+ created or edited. Otherwise, a drop-in file will be created or edited.</para>
<para>If <option>--drop-in=</option> is specified, the given drop-in file name
will be used instead of the default <filename>override.conf</filename>.</para>
- <para>If <option>--full</option> is specified, this will copy the
- original units instead of creating drop-in files.</para>
-
- <para>If <option>--force</option> is specified and any units do
- not already exist, new unit files will be opened for editing.</para>
+ <para>The unit must exist, i.e. its main unit file must be present. If <option>--force</option>
+ is specified, this requirement is ignored and a new unit may be created (with
+ <option>--full</option>), or a drop-in for a nonexistent unit may be created.</para>
<para>If <option>--runtime</option> is specified, the changes will
be made temporarily in <filename>/run/</filename> and they will be
lost on the next reboot.</para>
+ <para>If <option>--stdin</option> is specified, the new contents will be read from standard
+ input. In this mode, the old contents of the file are discarded.</para>
+
<para>If the temporary file is empty upon exit, the modification of
the related unit is canceled.</para>
- <para>After the units have been edited, systemd configuration is
- reloaded (in a way that is equivalent to <command>daemon-reload</command>).
- </para>
-
<para>Note that this command cannot be used to remotely edit units
and that you cannot temporarily edit units which are in
<filename>/etc/</filename>, since they take precedence over
@@ -1583,7 +1628,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</tgroup>
</table>
- <xi:include href="version-info.xml" xpointer="v215"/>
+ <xi:include href="version-info.xml" xpointer="v215"/>
</listitem>
</varlistentry>
@@ -1774,12 +1819,34 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</varlistentry>
<varlistentry>
+ <term><command>sleep</command></term>
+
+ <listitem>
+ <para>Put the system to sleep, through <command>suspend</command>, <command>hibernate</command>,
+ <command>hybrid-sleep</command>, or <command>suspend-then-hibernate</command>. The sleep operation
+ to use is automatically selected by <citerefentry>
+ <refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+ By default, <command>suspend-then-hibernate</command> is used, and falls back to <command>suspend</command>
+ and then <command>hibernate</command> if not supported. Refer to <varname>SleepOperation=</varname>
+ setting in <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ for more details. This command is asynchronous, and will return after the sleep operation is
+ successfully enqueued. It will not wait for the sleep/resume cycle to complete.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><command>suspend</command></term>
<listitem>
<para>Suspend the system. This will trigger activation of the special target unit
<filename>suspend.target</filename>. This command is asynchronous, and will return after the suspend
operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.</para>
+
+ <para>If <option>--force</option> is specified, and <command>systemd-logind</command> returned
+ error for the operation, the error will be ignored and the operation will be tried again directly
+ through starting the target unit.</para>
</listitem>
</varlistentry>
@@ -1790,6 +1857,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<para>Hibernate the system. This will trigger activation of the special target unit
<filename>hibernate.target</filename>. This command is asynchronous, and will return after the hibernation
operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.</para>
+
+ <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para>
</listitem>
</varlistentry>
@@ -1801,6 +1870,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<filename>hybrid-sleep.target</filename>. This command is asynchronous, and will return after the hybrid
sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.</para>
+ <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para>
+
<xi:include href="version-info.xml" xpointer="v196"/>
</listitem>
</varlistentry>
@@ -1809,12 +1880,15 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><command>suspend-then-hibernate</command></term>
<listitem>
- <para>Suspend the system and hibernate it after the delay specified in <filename>systemd-sleep.conf</filename>.
- This will trigger activation of the special target unit <filename>suspend-then-hibernate.target</filename>.
- This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
+ <para>Suspend the system and hibernate it when the battery is low, or when the delay specified
+ in <filename>systemd-sleep.conf</filename> elapsed. This will trigger activation of the special
+ target unit <filename>suspend-then-hibernate.target</filename>. This command is asynchronous,
+ and will return after the hybrid sleep operation is successfully enqueued.
It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para>
- <xi:include href="version-info.xml" xpointer="v240"/>
+ <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
</variablelist>
@@ -1855,7 +1929,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
for more details. The patterns are matched against the primary names of
units currently in memory, and patterns which do not match anything
are silently skipped. For example:
- <programlisting># systemctl stop sshd@*.service</programlisting>
+ <programlisting># systemctl stop "sshd@*.service"</programlisting>
will stop all <filename>sshd@.service</filename> instances. Note that alias names of units, and units that aren't
in memory are not considered for glob expansion.
</para>
@@ -1944,12 +2018,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><option>-P</option></term>
<listitem>
- <para>Equivalent to <option>--value</option> <option>--property=</option>, i.e. shows the
- value of the property without the property name or <literal>=</literal>. Note that using
- <option>-P</option> once will also affect all properties listed with
- <option>-p</option>/<option>--property=</option>.</para>
-
- <xi:include href="version-info.xml" xpointer="v246"/>
+ <xi:include href="standard-options.xml" xpointer="xpointer(//varlistentry[@id='option-P']/listitem/para)" />
+ <xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
@@ -2091,7 +2161,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<para>When printing properties with <command>show</command>, only print the value, and skip the
property name and <literal>=</literal>. Also see option <option>-P</option> above.</para>
- <xi:include href="version-info.xml" xpointer="v230"/>
+ <xi:include href="version-info.xml" xpointer="v230"/>
</listitem>
</varlistentry>
@@ -2101,7 +2171,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<listitem>
<para>When showing sockets, show the type of the socket.</para>
- <xi:include href="version-info.xml" xpointer="v202"/>
+ <xi:include href="version-info.xml" xpointer="v202"/>
</listitem>
</varlistentry>
@@ -2109,72 +2179,72 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><option>--job-mode=</option></term>
<listitem>
- <para>When queuing a new job, this option controls how to deal with
- already queued jobs. It takes one of <literal>fail</literal>,
- <literal>replace</literal>,
- <literal>replace-irreversibly</literal>,
- <literal>isolate</literal>,
- <literal>ignore-dependencies</literal>,
- <literal>ignore-requirements</literal>,
- <literal>flush</literal>,
- <literal>triggering</literal>, or
- <literal>restart-dependencies</literal>. Defaults to
- <literal>replace</literal>, except when the
- <command>isolate</command> command is used which implies the
- <literal>isolate</literal> job mode.</para>
-
- <para>If <literal>fail</literal> is specified and a requested
- operation conflicts with a pending job (more specifically:
- causes an already pending start job to be reversed into a stop
- job or vice versa), cause the operation to fail.</para>
-
- <para>If <literal>replace</literal> (the default) is
- specified, any conflicting pending job will be replaced, as
- necessary.</para>
-
- <para>If <literal>replace-irreversibly</literal> is specified,
- operate like <literal>replace</literal>, but also mark the new
- jobs as irreversible. This prevents future conflicting
- transactions from replacing these jobs (or even being enqueued
- while the irreversible jobs are still pending). Irreversible
- jobs can still be cancelled using the <command>cancel</command>
- command. This job mode should be used on any transaction which
- pulls in <filename>shutdown.target</filename>.</para>
-
- <para><literal>isolate</literal> is only valid for start
- operations and causes all other units to be stopped when the
- specified unit is started. This mode is always used when the
- <command>isolate</command> command is used.</para>
-
- <para><literal>flush</literal> will cause all queued jobs to
- be canceled when the new job is enqueued.</para>
-
- <para>If <literal>ignore-dependencies</literal> is specified,
- then all unit dependencies are ignored for this new job and
- the operation is executed immediately. If passed, no required
- units of the unit passed will be pulled in, and no ordering
- dependencies will be honored. This is mostly a debugging and
- rescue tool for the administrator and should not be used by
- applications.</para>
-
- <para><literal>ignore-requirements</literal> is similar to
- <literal>ignore-dependencies</literal>, but only causes the
- requirement dependencies to be ignored, the ordering
- dependencies will still be honored.</para>
-
- <para><literal>triggering</literal> may only be used with
- <command>systemctl stop</command>. In this mode, the specified
- unit and any active units that trigger it are stopped. See the
- discussion of
- <varname>Triggers=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- for more information about triggering units.</para>
-
- <para><literal>restart-dependencies</literal> may only be used with
- <command>systemctl start</command>. In this mode, dependencies of
- the specified unit will receive restart propagation, as if a restart
- job had been enqueued for the unit.</para>
-
- <xi:include href="version-info.xml" xpointer="v209"/>
+ <para>When queuing a new job, this option controls how to deal with
+ already queued jobs. It takes one of <literal>fail</literal>,
+ <literal>replace</literal>,
+ <literal>replace-irreversibly</literal>,
+ <literal>isolate</literal>,
+ <literal>ignore-dependencies</literal>,
+ <literal>ignore-requirements</literal>,
+ <literal>flush</literal>,
+ <literal>triggering</literal>, or
+ <literal>restart-dependencies</literal>. Defaults to
+ <literal>replace</literal>, except when the
+ <command>isolate</command> command is used which implies the
+ <literal>isolate</literal> job mode.</para>
+
+ <para>If <literal>fail</literal> is specified and a requested
+ operation conflicts with a pending job (more specifically:
+ causes an already pending start job to be reversed into a stop
+ job or vice versa), cause the operation to fail.</para>
+
+ <para>If <literal>replace</literal> (the default) is
+ specified, any conflicting pending job will be replaced, as
+ necessary.</para>
+
+ <para>If <literal>replace-irreversibly</literal> is specified,
+ operate like <literal>replace</literal>, but also mark the new
+ jobs as irreversible. This prevents future conflicting
+ transactions from replacing these jobs (or even being enqueued
+ while the irreversible jobs are still pending). Irreversible
+ jobs can still be cancelled using the <command>cancel</command>
+ command. This job mode should be used on any transaction which
+ pulls in <filename>shutdown.target</filename>.</para>
+
+ <para><literal>isolate</literal> is only valid for start
+ operations and causes all other units to be stopped when the
+ specified unit is started. This mode is always used when the
+ <command>isolate</command> command is used.</para>
+
+ <para><literal>flush</literal> will cause all queued jobs to
+ be canceled when the new job is enqueued.</para>
+
+ <para>If <literal>ignore-dependencies</literal> is specified,
+ then all unit dependencies are ignored for this new job and
+ the operation is executed immediately. If passed, no required
+ units of the unit passed will be pulled in, and no ordering
+ dependencies will be honored. This is mostly a debugging and
+ rescue tool for the administrator and should not be used by
+ applications.</para>
+
+ <para><literal>ignore-requirements</literal> is similar to
+ <literal>ignore-dependencies</literal>, but only causes the
+ requirement dependencies to be ignored, the ordering
+ dependencies will still be honored.</para>
+
+ <para><literal>triggering</literal> may only be used with
+ <command>systemctl stop</command>. In this mode, the specified
+ unit and any active units that trigger it are stopped. See the
+ discussion of
+ <varname>Triggers=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ for more information about triggering units.</para>
+
+ <para><literal>restart-dependencies</literal> may only be used with
+ <command>systemctl start</command>. In this mode, dependencies of
+ the specified unit will receive restart propagation, as if a restart
+ job had been enqueued for the unit.</para>
+
+ <xi:include href="version-info.xml" xpointer="v209"/>
</listitem>
</varlistentry>
@@ -2190,7 +2260,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
completion of the listed jobs might ultimately entail more jobs than the listed ones.</para>
- <xi:include href="version-info.xml" xpointer="v242"/>
+ <xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
@@ -2237,7 +2307,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<listitem>
<para>Shortcut for <option>--check-inhibitors=no</option>.</para>
- <xi:include href="version-info.xml" xpointer="v198"/>
+ <xi:include href="version-info.xml" xpointer="v198"/>
</listitem>
</varlistentry>
@@ -2289,7 +2359,10 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</listitem>
<listitem>
<para>when a <command>stop</command>-ped, <command>disable</command>-d, or <command>mask</command>-ed
- unit still has active triggering units.</para>
+ unit still has active triggering units,</para>
+ </listitem>
+ <listitem>
+ <para>when a unit file is changed and requires <command>daemon-reload</command>.</para>
</listitem>
</itemizedlist>
</para>
@@ -2315,14 +2388,16 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><option>--wait</option></term>
<listitem>
- <para>Synchronously wait for started units to terminate again.
- This option may not be combined with <option>--no-block</option>.
- Note that this will wait forever if any given unit never terminates
- (by itself or by getting stopped explicitly); particularly services
- which use <literal>RemainAfterExit=yes</literal>.</para>
+ <para>When used with <command>start</command> or <command>restart</command>, synchronously wait for
+ started units to terminate again. This option may not be combined with <option>--no-block</option>.
+ Note that this will wait forever if any given unit never terminates (by itself or by getting
+ stopped explicitly); particularly services which use <literal>RemainAfterExit=yes</literal>.</para>
- <para>When used with <command>is-system-running</command>, wait
- until the boot process is completed before returning.</para>
+ <para>When used with <command>is-system-running</command>, wait until the boot process is completed
+ before returning.</para>
+
+ <para>When used with <command>kill</command>, wait until the signalled units terminate. Note that
+ this will wait forever if any given unit never terminates.</para>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
@@ -2414,12 +2489,12 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<filename>&UMOUNT_PATH;</filename>), but no main process is defined. If omitted, defaults to
<option>all</option>.</para>
- <xi:include href="version-info.xml" xpointer="v252"/>
+ <xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--kill-value=</option><replaceable>INT</replaceable></term>
+ <term><option>--kill-value=<replaceable>INT</replaceable></option></term>
<listitem><para>If used with the <command>kill</command> command, enqueues a signal along with the
specified integer value parameter to the specified process(es). This operation is only available for
@@ -2458,7 +2533,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<varname>FileDescriptorStorePreserve=</varname> option is enabled, since the file descriptor store
is otherwise cleaned automatically when the unit is stopped.</para>
- <xi:include href="version-info.xml" xpointer="v243"/>
+ <xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
@@ -2467,22 +2542,28 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><option>--force</option></term>
<listitem>
- <para>When used with <command>enable</command>, overwrite
- any existing conflicting symlinks.</para>
-
- <para>When used with <command>edit</command>, create all of the
- specified units which do not already exist.</para>
-
- <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command> or
- <command>kexec</command>, execute the selected operation without shutting down all units. However, all
- processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
- drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified
- twice for these operations (with the exception of <command>kexec</command>), they will be executed
- immediately, without terminating any processes or unmounting any file systems. Warning: specifying
- <option>--force</option> twice with any of these operations might result in data loss. Note that when
- <option>--force</option> is specified twice the selected operation is executed by
- <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
- succeed even when the system manager has crashed.</para>
+ <para>When used with <command>enable</command>, overwrite any existing conflicting symlinks.</para>
+
+ <para>When used with <command>edit</command>, create all of the specified units which do not already exist.</para>
+
+ <para>When used with <command>suspend</command>, <command>hibernate</command>, <command>hybrid-sleep</command>,
+ or <command>suspend-then-hibernate</command>, the error returned by <command>systemd-logind</command>
+ will be ignored, and the operation will be performed directly through starting the corresponding units.
+ </para>
+
+ <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command>,
+ or <command>kexec</command>, execute the selected operation without shutting down all units. However,
+ all processes will be killed forcibly and all file systems are unmounted or remounted read-only.
+ This is hence a drastic but relatively safe option to request an immediate reboot. If <option>--force</option>
+ is specified twice for these operations (with the exception of <command>kexec</command>), they will
+ be executed immediately, without terminating any processes or unmounting any file systems.</para>
+
+ <warning>
+ <para>Specifying <option>--force</option> twice with any of these operations might result in data loss.
+ Note that when <option>--force</option> is specified twice the selected operation is executed by
+ <command>systemctl</command> itself, and the system manager is not contacted. This means the command
+ should succeed even when the system manager has crashed.</para>
+ </warning>
</listitem>
</varlistentry>
@@ -2494,7 +2575,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
short message explaining the reason for the operation. The message will be logged together with the default
shutdown message.</para>
- <xi:include href="version-info.xml" xpointer="v225"/>
+ <xi:include href="version-info.xml" xpointer="v225"/>
</listitem>
</varlistentry>
@@ -2508,7 +2589,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
or stop operation is only carried out when the respective enable or
disable operation has been successful.</para>
- <xi:include href="version-info.xml" xpointer="v220"/>
+ <xi:include href="version-info.xml" xpointer="v220"/>
</listitem>
</varlistentry>
@@ -2575,7 +2656,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
enabled according to the preset rules, or only enabled, or
only disabled.</para>
- <xi:include href="version-info.xml" xpointer="v215"/>
+ <xi:include href="version-info.xml" xpointer="v215"/>
</listitem>
</varlistentry>
@@ -2612,7 +2693,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
setup interface for the next boot. Note that this functionality is not available on all systems.
</para>
- <xi:include href="version-info.xml" xpointer="v220"/>
+ <xi:include href="version-info.xml" xpointer="v220"/>
</listitem>
</varlistentry>
@@ -2626,7 +2707,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
in order to disable the menu timeout. Note that not all boot loaders support this functionality.
</para>
- <xi:include href="version-info.xml" xpointer="v242"/>
+ <xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
@@ -2640,7 +2721,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
or <literal>help</literal> in order to list available entries. Note that not all boot loaders
support this functionality.</para>
- <xi:include href="version-info.xml" xpointer="v242"/>
+ <xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
@@ -2648,11 +2729,12 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<term><option>--reboot-argument=</option></term>
<listitem>
- <para>This switch is used with <command>reboot</command>. The value is architecture and firmware specific. As an example, <literal>recovery</literal>
- might be used to trigger system recovery, and <literal>fota</literal> might be used to trigger a
- <quote>firmware over the air</quote> update.</para>
+ <para>This switch is used with <command>reboot</command>. The value is architecture and firmware
+ specific. As an example, <literal>recovery</literal> might be used to trigger system recovery, and
+ <literal>fota</literal> might be used to trigger a <quote>firmware over the air</quote>
+ update.</para>
- <xi:include href="version-info.xml" xpointer="v246"/>
+ <xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
@@ -2665,7 +2747,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
the output is printed as a list instead of a tree, and the bullet
circles are omitted.</para>
- <xi:include href="version-info.xml" xpointer="v203"/>
+ <xi:include href="version-info.xml" xpointer="v203"/>
</listitem>
</varlistentry>
@@ -2723,7 +2805,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</varlistentry>
</variablelist>
- <xi:include href="version-info.xml" xpointer="v247"/>
+ <xi:include href="version-info.xml" xpointer="v247"/>
</listitem>
</varlistentry>
@@ -2762,7 +2844,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
</varlistentry>
<varlistentry>
- <term><option>--drop-in=</option><replaceable>NAME</replaceable></term>
+ <term><option>--drop-in=<replaceable>NAME</replaceable></option></term>
<listitem><para>When used with <command>edit</command>, use <replaceable>NAME</replaceable> as the
drop-in file name instead of <filename>override.conf</filename>.</para>
@@ -2782,12 +2864,34 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
section "PARSING TIMESTAMPS". Specially, if <literal>show</literal> is given, the currently scheduled
action will be shown, which can be canceled by passing an empty string or <literal>cancel</literal>.</para>
- <xi:include href="version-info.xml" xpointer="v254"/>
+ <xi:include href="version-info.xml" xpointer="v254"/>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--stdin</option></term>
+
+ <listitem>
+ <para>When used with <command>edit</command>, the contents of the file will be read from standard
+ input and the editor will not be launched. In this mode, the old contents of the file are
+ completely replaced. This is useful to "edit" unit files from scripts:</para>
+
+ <programlisting>$ systemctl edit --drop-in=limits.conf --stdin some-service.service &lt;&lt;EOF
+[Unit]
+AllowedCPUs=7,11
+EOF
+ </programlisting>
+
+ <para>Multiple drop-ins may be "edited" in this mode; the same contents will be written to all of
+ them.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<xi:include href="user-system-options.xml" xpointer="host" />
<xi:include href="user-system-options.xml" xpointer="machine" />
+ <xi:include href="user-system-options.xml" xpointer="capsule" />
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="legend" />
@@ -2888,19 +2992,19 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
+ <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
+ <member><citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>