mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-27 20:23:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
b59052be26
systemd/man/systemctl.xml

2587 lines
134 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 05:15:39 +08:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
man: generate configured paths in manpages In particular, use /lib/systemd instead of /usr/lib/systemd in distributions like Debian which still have not adopted a /usr merge setup. Use XML entities from man/custom-entities.ent to replace configured paths while doing XSLT processing of the original XML files. There was precedent of some files (such as systemd.generator.xml) which were already using this approach. This addresses most of the (manual) fixes from this patch: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220 The idea of using generic XML entities was presented here: http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html This patch solves almost all the issues, with the exception of: - Path to /bin/mount and /bin/umount. - Generic statements about preference of /lib over /etc. These will be handled separately by follow up patches. Tested: - With default configure settings, ran "make install" to two separate directories and compared the output to confirm they matched exactly. - Used a set of configure flags including $CONFFLAGS from Debian: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules Installed the tree and confirmed the paths use /lib/systemd instead of /usr/lib/systemd and that no other unexpected differences exist. - Confirmed that `make distcheck` still passes.
2015-05-27 17:38:19 +08:00
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: use xinclude to de-deduplicate common text I only tested with python-lxml. I'm not sure if xml.etree should be deprecated.
2014-02-12 13:55:38 +08:00
<refentry id="systemctl"
xmlns:xi="http://www.w3.org/2001/XInclude">
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
<refentryinfo>
<title>systemctl</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemctl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemctl</refname>
<refpurpose>Control the systemd system and service manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemctl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">COMMAND</arg>
systemctl,man: use UNIT as the placeholder for a unit name NAME is kind of meaningless, because everything has a name. "Unit" makes it more obvious that a name of a unit is necessary. I was always momentarily baffled by "set-property NAME ASSIGNMENT...", where there are two objects (the unit and the property), and it's not clear which of the two "NAME" is supposed to signify.
2018-02-22 19:58:53 +08:00
<arg choice="opt" rep="repeat">UNIT</arg>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: make it more clear that the concepts systemctl(1) manage are introduced in systemd(1) Based on a suggestion of Ken Coar.
2014-09-05 03:41:54 +08:00
<para><command>systemctl</command> may be used to introspect and
control the state of the <literal>systemd</literal> system and
service manager. Please refer to
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
man: make it more clear that the concepts systemctl(1) manage are introduced in systemd(1) Based on a suggestion of Ken Coar.
2014-09-05 03:41:54 +08:00
for an introduction into the basic concepts and functionality this
tool manages.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
</refsect1>
<refsect1>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<title>Commands</title>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>The following commands are understood:</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect2>
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
<title>Unit Commands (Introspection and Modification)</title>
systemctl: allow multiple arguments to --type This mirrors --property, and is generally useful. New functionality is used in bash completion. In case of zsh completion, new functionality is less useful because of caching. Nevertheless, zsh completion for restart is made to behave more-or-less the same as bash completion. At least sockets can be restarted.
2013-04-11 10:40:58 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
<varlistentry>
<term><command>list-units</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>List units that <command>systemd</command> currently has in memory. This includes units that are
either referenced directly or through a dependency, units that are pinned by applications programmatically,
or units that were active in the past and have failed. By default only units which are active, have pending
jobs, or have failed are shown; this can be changed with option <option>--all</option>. If one or more
<replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown. The units
that are shown are additionally filtered by <option>--type=</option> and <option>--state=</option> if those
options are specified.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
man: clarify the situation of unit templates regarding "systemctl list-units" + "systemctl list-unit-files" Fixes: #21075
2021-10-28 16:45:02 +08:00
<para>Note that this command does not show unit templates, but only instances of unit
templates. Units templates that aren't instantiated are not runnable, and will thus never show up
in the output of this command. Specifically this means that <filename>foo@.service</filename>
will never be shown in this list — unless instantiated, e.g. as
<filename>foo@bar.service</filename>. Use <command>list-unit-files</command> (see below) for
listing installed unit template files.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Produces output similar to
<programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
sys-module-fuse.device loaded active plugged /sys/module/fuse
-.mount loaded active mounted Root Mount
boot-efi.mount loaded active mounted /boot/efi
systemd-journald.service loaded active running Journal Service
systemd-logind.service loaded active running Login Service
● user@1000.service loaded failed failed User Manager for UID 1000
…
systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
systemctl: option to list units by state This allows to show only units with specified LOAD or SUB or ACTIVE state.
2013-07-18 19:24:12 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
LOAD = Reflects whether the unit definition was properly loaded.
ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
SUB = The low-level unit activation state, values depend on unit type.
systemctl: add --state=help This mirrors --type=help and simplifies completion scripts. The array of states is dense, so the is no need to check if the string is null.
2015-09-29 01:29:03 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
123 loaded units listed. Pass --all to see loaded but inactive units, too.
man: clarify the situation of unit templates regarding "systemctl list-units" + "systemctl list-unit-files" Fixes: #21075
2021-10-28 16:45:02 +08:00
To show all installed unit files use 'systemctl list-unit-files'.</programlisting></para>
<para>The header and the last unit of a given type are underlined if the terminal supports
that. A colored dot is shown next to services which were masked, not found, or otherwise
failed.</para>
systemctl: option to list units by state This allows to show only units with specified LOAD or SUB or ACTIVE state.
2013-07-18 19:24:12 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>The LOAD column shows the load state, one of <constant>loaded</constant>,
<constant>not-found</constant>, <constant>bad-setting</constant>, <constant>error</constant>,
<constant>masked</constant>. The ACTIVE columns shows the general unit state, one of
<constant>active</constant>, <constant>reloading</constant>, <constant>inactive</constant>,
<constant>failed</constant>, <constant>activating</constant>, <constant>deactivating</constant>. The SUB
column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
values. <programlisting>systemctl --state=help</programlisting> command maybe be used to display the
current set of possible values.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This is the default command.</para>
</listitem>
</varlistentry>
man: information about available properties https://bugzilla.redhat.com/show_bug.cgi?id=1144496
2015-06-30 08:19:56 +08:00
man: document systemctl list-automounts
2022-07-15 22:07:31 +08:00
<varlistentry>
<term><command>list-automounts</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
<listitem>
<para>List automount units currently in memory, ordered by mount path. If one or more
<replaceable>PATTERN</replaceable>s are specified, only automount units matching one of them are shown.
Produces output similar to
<programlisting>
WHAT WHERE MOUNTED IDLE TIMEOUT UNIT
/dev/sdb1 /mnt/test no 120s mnt-test.automount
binfmt_misc /proc/sys/fs/binfmt_misc yes 0 proc-sys-fs-binfmt_misc.automount
2 automounts listed.</programlisting>
</para>
<para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
</listitem>
</varlistentry>
man: document systemctl list-paths
2023-02-21 02:17:14 +08:00
<varlistentry>
<term><command>list-paths</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
<listitem>
<para>List path units currently in memory, ordered by path. If one or more
<replaceable>PATTERN</replaceable>s are specified, only path units matching one of them are shown.
Produces output similar to
<programlisting>
PATH CONDITION UNIT ACTIVATES
/run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-plymouth.path systemd-ask-password-plymouth.service
/run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-wall.path systemd-ask-password-wall.service
/var/cache/cups/org.cups.cupsd PathExists cups.path cups.service
3 paths listed.</programlisting>
</para>
<para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>list-sockets</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
man: information about available properties https://bugzilla.redhat.com/show_bug.cgi?id=1144496
2015-06-30 08:19:56 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>List socket units currently in memory, ordered by listening address. If one or more
<replaceable>PATTERN</replaceable>s are specified, only socket units matching one of them are
shown. Produces output similar to
<programlisting>
LISTEN UNIT ACTIVATES
/dev/initctl systemd-initctl.socket systemd-initctl.service
…
[::]:22 sshd.socket sshd.service
kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
5 sockets listed.</programlisting>
Note: because the addresses might contains spaces, this output
is not suitable for programmatic consumption.
</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
</listitem>
</varlistentry>
man: explain what list-units does a bit better (#3324) https://bugzilla.redhat.com/show_bug.cgi?id=1338584
2016-05-23 21:33:44 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>list-timers</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
man: describe list-dependencies --all Meaning of --all was mentioned in list-dependencies description, but the this effect should also be mentioned in the description of the option itself.
2016-08-04 11:49:18 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>List timer units currently in memory, ordered by the time they elapse next. If one or more
<replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown.
Produces output similar to
<programlisting>
NEXT LEFT LAST PASSED UNIT ACTIVATES
various: use "-" instead of "n/a" in tables In the context of a table, both would be generally understood to have the same meaning. "n/a" is a strange beast. It was useful when tables were produced on the typewriter with "---------" used to separate rows. It is visually more pleasing to use "-", and there is no risk of it being mistaken for a row separator.
2022-09-17 17:06:39 +08:00
- - Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service
Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service
Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service
</programlisting>
</para>
man: systemctl: document effect of --all on journal output Based on the journalctl documentation of this option added in 23ad99b519 (#10527), but with the first reference to “fields” replaced by “journal messages”, since I think it’s less common to show other fields with `systemctl status` (though it’s possible with the `-o` option).
2019-01-05 22:41:31 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para><emphasis>NEXT</emphasis> shows the next time the timer will run.</para>
<para><emphasis>LEFT</emphasis> shows how long till the next time the timer runs.</para>
<para><emphasis>LAST</emphasis> shows the last time the timer ran.</para>
<para><emphasis>PASSED</emphasis> shows how long has passed since the timer last ran.</para>
<para><emphasis>UNIT</emphasis> shows the name of the timer</para>
<para><emphasis>ACTIVATES</emphasis> shows the name the service the timer activates when it runs.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Also see <option>--all</option> and <option>--state=</option>.</para>
</listitem>
</varlistentry>
systemctl: introduce -r switch to show units running in local containers in addition to the host
2014-03-17 10:31:38 +08:00
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
<varlistentry>
<term><command>is-active <replaceable>PATTERN</replaceable>…</command></term>
<listitem>
<para>Check whether any of the specified units are active
(i.e. running). Returns an exit code
<constant>0</constant> if at least one is active, or
non-zero otherwise. Unless <option>--quiet</option> is
specified, this will also print the current unit state to
standard output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>is-failed <replaceable>PATTERN</replaceable>…</command></term>
<listitem>
<para>Check whether any of the specified units are in a
"failed" state. Returns an exit code
<constant>0</constant> if at least one has failed,
non-zero otherwise. Unless <option>--quiet</option> is
specified, this will also print the current unit state to
standard output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>status</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…]</optional></term>
<listitem>
systemctl: make show/status honour --state and --type This makes the interface more flexible, by allowing the same filtering for show and status as is done for list-units. Fixes #23207.
2022-05-22 20:32:55 +08:00
<para>Show runtime status information about the whole system or about one or more units followed
by most recent log data from the journal. If no positional arguments are specified, and no unit
filter is given with <option>--type=</option>, <option>--state=</option>, or
<option>--failed</option>, shows the status of the whole system. If combined with
<option>--all</option>, follows that with the status of all units. If positional arguments are
specified, each positional argument is treated as either a unit name to show, or a glob pattern
to show units whose names match that pattern, or a PID to show the unit containing that PID. When
<option>--type=</option>, <option>--state=</option>, or <option>--failed</option> are used, units
are additionally filtered by the TYPE and ACTIVE state.</para>
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
systemctl: clarify that "status" is about the most recent invocation of a service And point people to "journalctl --unit=" for information of prior runs. Inspired by: #24159
2022-08-02 23:27:29 +08:00
<para>This function is intended to generate human-readable output. If you are looking for
computer-parsable output, use <command>show</command> instead. By default, this function only
shows 10 lines of output and ellipsizes lines to fit in the terminal window. This can be changed
with <option>--lines</option> and <option>--full</option>, see above. In addition,
<command>journalctl --unit=<replaceable>NAME</replaceable></command> or <command>journalctl
--user-unit=<replaceable>NAME</replaceable></command> use a similar filter for messages and might
be more convenient.</para>
man: fix docbook
2022-08-04 00:51:45 +08:00
<para>Note that this operation only displays <emphasis>runtime</emphasis> status, i.e. information about
systemctl: clarify that "status" is about the most recent invocation of a service And point people to "journalctl --unit=" for information of prior runs. Inspired by: #24159
2022-08-02 23:27:29 +08:00
the current invocation of the unit (if it is running) or the most recent invocation (if it is not
running anymore, and has not been released from memory). Information about earlier invocations,
invocations from previous system boots, or prior invocations that have already been released from
memory may be retrieved via <command>journalctl --unit=</command>.</para>
<para>systemd implicitly loads units as necessary, so just running the <command>status</command>
will attempt to load a file. The command is thus not useful for determining if something was
already loaded or not. The units may possibly also be quickly unloaded after the operation is
completed if there's no reason to keep it in memory thereafter.</para>
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
<example>
<title>Example output from systemctl status </title>
<programlisting>$ systemctl status bluetooth
● bluetooth.service - Bluetooth service
systemctl: stop saying "vendor preset" We have vendor presets, and local admin presets, and runtime presets (under /usr/lib, /usr/local/lib and /etc, /run, respectively). When we display preset state, it can be configured in any of those places, so we shouldn't say anything about the origin. (Another nice advantage is that it improves alignment: [root@f36 ~]# systemctl list-unit-files multipathd.service UNIT FILE STATE VENDOR PRESET multipathd.service enabled enabled ^ this looks we have a "PRESET" column that is empty.)
2022-04-01 16:15:54 +08:00
Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; preset: enabled)
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
Docs: man:bluetoothd(8)
Main PID: 930 (bluetoothd)
Status: "Running"
Tasks: 1
Memory: 648.0K
CPU: 435ms
CGroup: /system.slice/bluetooth.service
└─930 /usr/lib/bluetooth/bluetoothd
Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
</programlisting>
man: "enabled commands are started at boot" is rubbish it's enabled units, and they might be started by various forms of activation, not just "at boot". Fix that.
2022-07-06 19:14:20 +08:00
<para>The dot ("●") uses color on supported terminals to summarize the unit state at a
glance. Along with its color, its shape varies according to its state:
<literal>inactive</literal> or <literal>maintenance</literal> is a white circle ("○"),
<literal>active</literal> is a green dot ("●"), <literal>deactivating</literal> is a white dot,
<literal>failed</literal> or <literal>error</literal> is a red cross ("×"), and
<literal>reloading</literal> is a green clockwise circle arrow ("↻").</para>
<para>The "Loaded:" line in the output will show <literal>loaded</literal> if the unit has been
loaded into memory. Other possible values for "Loaded:" include: <literal>error</literal> if
there was a problem loading it, <literal>not-found</literal> if no unit file was found for this
unit, <literal>bad-setting</literal> if an essential unit file setting could not be parsed and
<literal>masked</literal> if the unit file has been masked. Along with showing the path to the
unit file, this line will also show the enablement state. Enabled units are included in the
dependency network between units, and thus are started at boot or via some other form of
activation. See the full table of possible enablement states — including the definition of
<literal>masked</literal> — in the documentation for the <command>is-enabled</command> command.
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
</para>
<para>The "Active:" line shows active state. The value is usually <literal>active</literal> or
man: "enabled commands are started at boot" is rubbish it's enabled units, and they might be started by various forms of activation, not just "at boot". Fix that.
2022-07-06 19:14:20 +08:00
<literal>inactive</literal>. Active could mean started, bound, plugged in, etc depending on the
unit type. The unit could also be in process of changing states, reporting a state of
<literal>activating</literal> or <literal>deactivating</literal>. A special
<literal>failed</literal> state is entered when the service failed in some way, such as a crash,
exiting with an error code or timing out. If the failed state is entered the cause will be logged
for later reference.</para>
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
</example>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>JOB</replaceable>…</optional></term>
<listitem>
<para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
<option>--all</option> to show those too. To select specific properties to show, use
<option>--property=</option>. This command is intended to be used whenever computer-parsable output is
required. Use <command>status</command> if you are looking for formatted human-readable output.</para>
<para>Many properties shown by <command>systemctl show</command> map directly to configuration settings of
the system and service manager and its unit files. Note that the properties shown by the command are
generally more low-level, normalized versions of the original configuration settings and expose runtime
state in addition to configuration. For example, properties shown for service units include the service's
current main process identifier as <literal>MainPID</literal> (which is runtime state), and time settings
are always exposed as properties ending in the <literal>…USec</literal> suffix even if a matching
configuration options end in <literal>…Sec</literal>, because microseconds is the normalized time unit used
internally by the system and service manager.</para>
<para>For details about many of these properties, see the documentation of the D-Bus interface
backing these properties, see
<citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cat <replaceable>PATTERN</replaceable>…</command></term>
<listitem>
<para>Show backing files of one or more units. Prints the
"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
understanding of these units if any unit files were
updated on disk and the <command>daemon-reload</command>
command wasn't issued since.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>help <replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…</command></term>
<listitem>
<para>Show manual pages for one or more units, if
available. If a PID is given, the manual pages for the unit
the process belongs to are shown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>list-dependencies</command>
<optional><replaceable>UNIT</replaceable>...</optional>
</term>
<listitem>
<para>Shows units required and wanted by the specified
units. This recursively lists units following the
<varname>Requires=</varname>,
<varname>Requisite=</varname>,
<varname>ConsistsOf=</varname>,
<varname>Wants=</varname>, <varname>BindsTo=</varname>
dependencies. If no units are specified,
<filename>default.target</filename> is implied.</para>
systemctl: list-dependencies: support --type= and --state= Closes #25975
2023-01-13 16:52:29 +08:00
<para>The units that are shown are additionally filtered by <option>--type=</option> and
<option>--state=</option> if those options are specified. Note that we won't be able to
use a tree structure in this case, so <option>--plain</option> is implied.</para>
systemctl: list unit introspection verbs first, modification second The list was rather ad hoc, with "reset-failed" sandwiched between "help" and "list-dependencies". Since a person will usually either want to introspect state in various ways or modify state in a certain way, let's put all the introspection commands together and all the ones that actually have an effect second.
2020-09-09 17:19:38 +08:00
<para>By default, only target units are recursively
expanded. When <option>--all</option> is passed, all other
units are recursively expanded as well.</para>
<para>Options <option>--reverse</option>,
<option>--after</option>, <option>--before</option>
may be used to change what types of dependencies
are shown.</para>
<para>Note that this command only lists units currently loaded into memory by the service manager. In
particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
specific unit, as it won't list the dependencies declared by units currently not loaded.</para>
</listitem>
</varlistentry>
<!-- Commands that modify unit state start here -->
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>start <replaceable>PATTERN</replaceable>…</command></term>
systemctl: introduce -r switch to show units running in local containers in addition to the host
2014-03-17 10:31:38 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
systemctl: emit warning if start is used with globs Fixes #6379.
2019-10-16 23:33:32 +08:00
<para>Start (activate) one or more units specified on the command line.</para>
<para>Note that unit glob patterns expand to names of units currently in memory. Units which are
not active and are not in a failed state usually are not in memory, and will not be matched by
any pattern. In addition, in case of instantiated units, systemd is often unaware of the instance
name until the instance has been started. Therefore, using glob patterns with
<command>start</command> has limited usefulness. Also, secondary alias names of units are not
considered.</para>
<para>Option <option>--all</option> may be used to also operate on inactive units which are
referenced by other loaded units. Note that this is not the same as operating on "all" possible
units, because as the previous paragraph describes, such a list is ill-defined. Nevertheless,
<command>systemctl start --all <replaceable>GLOB</replaceable></command> may be useful if all the
units that should match the pattern are pulled in by some target which is known to be loaded.
</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>stop <replaceable>PATTERN</replaceable>…</command></term>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Stop (deactivate) one or more units specified on the command line.</para>
man: improve wording of systemctl's --after/--before Commit 4a77ca7 was an attempt at fixing the wording of --after and --before, but the new wording was unclear. Split the combined --after/--before section into a separate section for each, explicitly state what each option does, and add information about how these lists are generated. Reported-by: Andrey Borzenkov <arvidjaar@gmail.com> Reported-by: Lennart Poettering <lennart@poettering.net>
2014-03-17 12:03:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command will fail if the unit does not exist or if stopping of the unit is prohibited (see
<varname>RefuseManualStop=</varname> in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
It will <emphasis>not</emphasis> fail if any of the commands configured to stop the unit
(<varname>ExecStop=</varname>, etc.) fail, because the manager will still forcibly terminate the
unit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>reload <replaceable>PATTERN</replaceable>…</command></term>
man: reword list-dependencies description The previous version was a bit too vague. It is better to simply list all dependency types that are followed. Previous version also made an emphasis on dependencies introduced by configuration. But this command (or systemd) don't care about this distinction between configured and automatically added dependencies at all. This distinctionis removed from the main description, and an explanatory paragraph is added to remind the user that all dependencies are shown, no matter where they come from.
2014-11-24 00:07:15 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Asks all units listed on the command line to reload
their configuration. Note that this will reload the
service-specific configuration, not the unit configuration
file of systemd. If you want systemd to reload the
configuration file of a unit, use the
<command>daemon-reload</command> command. In other words:
for the example case of Apache, this will reload Apache's
<filename>httpd.conf</filename> in the web server, not the
<filename>apache.service</filename> systemd unit
file.</para>
systemctl: show waiting jobs when "systemctl list-jobs --after/--before" is called Let's expose the new bus functions we added in the previous commit in systemctl.
2016-11-16 23:44:05 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command should not be confused with the
<command>daemon-reload</command> command.</para>
</listitem>
man: improve wording of systemctl's --after/--before Commit 4a77ca7 was an attempt at fixing the wording of --after and --before, but the new wording was unclear. Split the combined --after/--before section into a separate section for each, explicitly state what each option does, and add information about how these lists are generated. Reported-by: Andrey Borzenkov <arvidjaar@gmail.com> Reported-by: Lennart Poettering <lennart@poettering.net>
2014-03-17 12:03:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><command>restart <replaceable>PATTERN</replaceable>…</command></term>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Stop and then start one or more units specified on the command line. If the units are not running
yet, they will be started.</para>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
resources before it is started again. For example, the per-service file descriptor storage facility (see
<varname>FileDescriptorStoreMax=</varname> in
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
restart operation an explicit <command>systemctl stop</command> command followed by <command>systemctl
start</command> should be issued.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>try-restart <replaceable>PATTERN</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Stop and then start one or more units specified on the
command line if the units are running. This does nothing
if units are not running.</para>
<!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
don't document that. -->
</listitem>
</varlistentry>
<varlistentry>
<term><command>reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
are not running yet, they will be started.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>try-reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
systemctl: add --value option With this option, systemctl will only print the rhs in show: $ systemctl show -p Wants,After systemd-journald --value systemd-journald.socket ... systemd-journald-dev-log.socket ... This is useful in scripts, because the need to call awk or similar is removed.
2015-08-03 02:22:10 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Reload one or more units if they support it. If not, stop and then start them instead. This does
nothing if the units are not running.</para>
<!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
don't document that. -->
</listitem>
</varlistentry>
<varlistentry>
<term><command>isolate <replaceable>UNIT</replaceable></command></term>
systemctl: add --value option With this option, systemctl will only print the rhs in show: $ systemctl show -p Wants,After systemd-journald --value systemd-journald.socket ... systemd-journald-dev-log.socket ... This is useful in scripts, because the need to call awk or similar is removed.
2015-08-03 02:22:10 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Start the unit specified on the command line and its dependencies
and stop all others, unless they have
<option>IgnoreOnIsolate=yes</option> (see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
If a unit name with no extension is given, an extension of
<literal>.target</literal> will be assumed.</para>
systemctl: new verb 'list-sockets' LISTEN UNIT ACTIVATES /dev/initctl systemd-initctl.socket systemd-initctl.service /dev/log systemd-journald.socket systemd-journald.service ... [::]:19531 systemd-journal-gatewayd.socket systemd-journal-gatewayd.service kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service 17 sockets listed. Pass --all to see loaded but inactive sockets, too.
2013-04-12 06:59:18 +08:00
man: do not say that isolate is like switching runlevels We need to do better here, but for now let's at least not trick users into nuking their graphical environment. Inspired by #16548.
2020-07-23 15:03:58 +08:00
<para>This command is dangerous, since it will immediately stop processes that are not enabled in
the new target, possibly including the graphical environment or terminal you are currently using.
</para>
systemctl: new verb 'list-sockets' LISTEN UNIT ACTIVATES /dev/initctl systemd-initctl.socket systemd-initctl.service /dev/log systemd-journald.socket systemd-journald.service ... [::]:19531 systemd-journal-gatewayd.socket systemd-journal-gatewayd.service kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service 17 sockets listed. Pass --all to see loaded but inactive sockets, too.
2013-04-12 06:59:18 +08:00
man: add missing subject in sentence
2022-09-14 17:53:05 +08:00
<para>Note that this operation is allowed only on units where
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<option>AllowIsolate=</option> is enabled. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>kill <replaceable>PATTERN</replaceable>…</command></term>
core, systemctl: add support for irreversible jobs Add a new job mode: replace-irreversibly. Jobs enqueued using this mode cannot be implicitly canceled by later enqueued conflicting jobs. They can however still be canceled with an explicit "systemctl cancel" call.
2013-02-22 18:21:37 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man: document new --kill-value= switch to systemctl
2023-02-16 23:20:48 +08:00
<para>Send a UNIX process signal to one or more processes of the unit. Use
<option>--kill-whom=</option> to select which process to send the signal to. Use
<option>--signal=</option> to select the signal to send. Combine with
<option>--kill-value=</option> to enqueue a POSIX Realtime Signal with an associated
value.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>clean <replaceable>PATTERN</replaceable>…</command></term>
systemctl: replace the three job mode options by a single --job-mode= option Also, expose the new "flush" job mode this way.
2013-11-26 09:14:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Remove the configuration, state, cache, logs or runtime data of the specified units. Use
<option>--what=</option> to select which kind of resource to remove. For service units this may
be used to remove the directories configured with <varname>ConfigurationDirectory=</varname>,
<varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
<varname>LogsDirectory=</varname> and <varname>RuntimeDirectory=</varname>, see
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details. For timer units this may be used to clear out the persistent timestamp data if
<varname>Persistent=</varname> is used and <option>--what=state</option> is selected, see
<citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
command only applies to units that use either of these settings. If <option>--what=</option> is
not specified, both the cache and runtime data are removed (as these two types of data are
generally redundant and reproducible on the next invocation of the unit).</para>
</listitem>
</varlistentry>
core: introduce support for cgroup freezer With cgroup v2 the cgroup freezer is implemented as a cgroup attribute called cgroup.freeze. cgroup can be frozen by writing "1" to the file and kernel will send us a notification through "cgroup.events" after the operation is finished and processes in the cgroup entered quiescent state, i.e. they are not scheduled to run. Writing "0" to the attribute file does the inverse and process execution is resumed. This commit exposes above low-level functionality through systemd's DBus API. Each unit type must provide specialized implementation for these methods, otherwise, we return an error. So far only service, scope, and slice unit types provide the support. It is possible to check if a given unit has the support using CanFreeze() DBus property. Note that DBus API has a synchronous behavior and we dispatch the reply to freeze/thaw requests only after the kernel has notified us that requested operation was completed.
2020-04-29 23:53:43 +08:00
<varlistentry>
<term><command>freeze <replaceable>PATTERN</replaceable>…</command></term>
<listitem>
<para>Freeze one or more units specified on the
command line using cgroup freezer</para>
<para>Freezing the unit will cause all processes contained within the cgroup corresponding to the unit
to be suspended. Being suspended means that unit's processes won't be scheduled to run on CPU until thawed.
Note that this command is supported only on systems that use unified cgroup hierarchy. Unit is automatically
thawed just before we execute a job against the unit, e.g. before the unit is stopped.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>thaw <replaceable>PATTERN</replaceable>…</command></term>
<listitem>
<para>Thaw (unfreeze) one or more units specified on the
command line.</para>
<para>This is the inverse operation to the <command>freeze</command> command and resumes the execution of
processes in the unit's cgroup.</para>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>set-property <replaceable>UNIT</replaceable> <replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable>…</command></term>
systemctl: add --dry-run argument
2017-10-21 16:47:52 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Set the specified unit properties at runtime where
this is supported. This allows changing configuration
parameter properties such as resource control settings at
runtime. Not all properties may be changed at runtime, but
many resource control settings (primarily those in
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
may. The changes are applied immediately, and stored on disk
for future boots, unless <option>--runtime</option> is
passed, in which case the settings only apply until the
next reboot. The syntax of the property assignment follows
closely the syntax of assignments in unit files.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Example: <command>systemctl set-property foobar.service CPUWeight=200</command></para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If the specified unit appears to be inactive, the
changes will be only stored on disk as described
previously hence they will be effective when the unit will
be started.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Note that this command allows changing multiple properties at the same time, which is
preferable over setting them individually.</para>
systemctl: Add --wait option to wait until started units terminate again Fixes #3830
2016-09-05 19:14:36 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Example: <command>systemctl set-property foobar.service CPUWeight=200 MemoryMax=2G IPAccounting=yes</command></para>
systemctl: Add --wait option to wait until started units terminate again Fixes #3830
2016-09-05 19:14:36 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Like with unit file configuration settings, assigning an empty setting usually resets a
property to its defaults.</para>
systemctl: add support for --wait to is-system-running This makes it possible to wait until boot is finished without having to poll for this command repeatedly, instead using the syntax: $ systemctl is-system-running --wait Waiting is implemented by waiting for the StartupFinished signal to be posted on the bus. Register the matcher before checking for the property to avoid race conditions. Tested by artificially delaying startup with a oneshot service and calling this command, checked that it emitted `running` and exited with a 0 return code as soon as the delay service completed startup. Also tested that booting to degraded state unblocks the command. Inserted a delay between getting the property and waiting for the signal and confirmed this seems to work free of race conditions. Updated the --help text (under --wait) and the man page to document the new feature.
2018-08-04 14:10:54 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Example: <command>systemctl set-property avahi-daemon.service IPAddressDeny=</command></para>
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
core: add DBUS method to bind mount new nodes without service restart Allow to setup new bind mounts for a service at runtime (via either DBUS or a new 'systemctl bind' verb) with a new helper that forks into the unit's mount namespace. Add a new integration test to cover this. Useful for zero-downtime addition to services that are running inside mount namespaces, especially when using RootImage/RootDirectory. If a service runs with a read-only root, a tmpfs is added on /run to ensure we can create the airlock directory for incoming mounts under /run/host/incoming.
2020-07-31 02:37:10 +08:00
<varlistentry>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<term>
<command>bind</command>
<replaceable>UNIT</replaceable>
<replaceable>PATH</replaceable>
[<replaceable>PATH</replaceable>]
</term>
<listitem><para>Bind-mounts a file or directory from the host into the specified unit's mount
namespace. The first path argument is the source file or directory on the host, the second path
argument is the destination file or directory in the unit's mount namespace. When the latter is
omitted, the destination path in the unit's mount namespace is the same as the source path on the
host. When combined with the <option>--read-only</option> switch, a ready-only bind mount is
created. When combined with the <option>--mkdir</option> switch, the destination path is first
created before the mount is applied.</para>
<para>Note that this option is currently only supported for units that run within a mount namespace
(e.g.: with <option>RootImage=</option>, <option>PrivateMounts=</option>, etc.). This command
supports bind-mounting directories, regular files, device nodes, <constant>AF_UNIX</constant>
socket nodes, as well as FIFOs. The bind mount is ephemeral, and it is undone as soon as the
current unit process exists. Note that the namespace mentioned here, where the bind mount will be
added to, is the one where the main service process runs. Other processes (those exececuted by
<option>ExecReload=</option>, <option>ExecStartPre=</option>, etc.) run in distinct namespaces.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>mount-image</command>
<replaceable>UNIT</replaceable>
<replaceable>IMAGE</replaceable>
[<replaceable>PATH</replaceable>
[<replaceable>PARTITION_NAME</replaceable>:<replaceable>MOUNT_OPTIONS</replaceable>]]
</term>
<listitem><para>Mounts an image from the host into the specified unit's mount namespace. The first
path argument is the source image on the host, the second path argument is the destination
directory in the unit's mount namespace (i.e. inside
<option>RootImage=</option>/<option>RootDirectory=</option>). The following argument, if any, is
interpreted as a colon-separated tuple of partition name and comma-separated list of mount options
for that partition. The format is the same as the service <option>MountImages=</option>
setting. When combined with the <option>--read-only</option> switch, a ready-only mount is
created. When combined with the <option>--mkdir</option> switch, the destination path is first
created before the mount is applied.</para>
<para>Note that this option is currently only supported for units that run within a mount namespace
(i.e. with <option>RootImage=</option>, <option>PrivateMounts=</option>, etc.). Note that the
namespace mentioned here where the image mount will be added to, is the one where the main service
process runs. Note that the namespace mentioned here, where the bind mount will be
added to, is the one where the main service process runs. Other processes (those exececuted by
<option>ExecReload=</option>, <option>ExecStartPre=</option>, etc.) run in distinct namespaces.
</para>
<para>Example:
systemctl: add new option to mount image inside a running service namespace Use the new DBUS method and follow the same pattern as the systemctl bind command.
2021-01-22 02:37:40 +08:00
<programlisting>systemctl mount-image foo.service /tmp/img.raw /var/lib/image root:ro,nosuid</programlisting>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<programlisting>systemctl mount-image --mkdir bar.service /tmp/img.raw /var/lib/baz/img</programlisting>
</para></listitem>
systemctl: add new option to mount image inside a running service namespace Use the new DBUS method and follow the same pattern as the systemctl bind command.
2021-01-22 02:37:40 +08:00
</varlistentry>
systemctl: add service-log-{level,target} verbs Heavily inspired by #15622. This adds: systemctl service-log-level systemd-resolved systemctl service-log-level systemd-resolved info systemctl service-log-target systemd-resolved systemctl service-log-target systemd-resolved console We already have systemctl verbs log-level, log-target, and service-watchdogs. Those two new verbs tie nicely into this scheme.
2020-09-08 03:25:24 +08:00
<varlistentry>
<term><command>service-log-level</command> <replaceable>SERVICE</replaceable> [<replaceable>LEVEL</replaceable>]</term>
<listitem><para>If the <replaceable>LEVEL</replaceable> argument is not given, print the current
log level as reported by service <replaceable>SERVICE</replaceable>.</para>
<para>If the optional argument <replaceable>LEVEL</replaceable> is provided, then change the
current log level of the service to <replaceable>LEVEL</replaceable>. The log level should be a
typical syslog log level, i.e. a value in the range 0…7 or one of the strings
<constant>emerg</constant>, <constant>alert</constant>, <constant>crit</constant>,
<constant>err</constant>, <constant>warning</constant>, <constant>notice</constant>,
<constant>info</constant>, <constant>debug</constant>; see <citerefentry
project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for details.</para>
<para>The service must have the appropriate
<varname>BusName=<replaceable>destination</replaceable></varname> property and also implement the
generic
<citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
interface. (<filename>systemctl</filename> will use the generic D-Bus protocol to access the
<interfacename>org.freedesktop.LogControl1.LogLevel</interfacename> interface for the D-Bus name
<replaceable>destination</replaceable>.)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>service-log-target</command> <replaceable>SERVICE</replaceable> [<replaceable>TARGET</replaceable>]</term>
<listitem><para>If the <replaceable>TARGET</replaceable> argument is not given, print the current
log target as reported by service <replaceable>SERVICE</replaceable>.</para>
<para>If the optional argument <replaceable>TARGET</replaceable> is provided, then change the
current log target of the service to <replaceable>TARGET</replaceable>. The log target should be
one of the strings <constant>console</constant> (for log output to the service's standard error
stream), <constant>kmsg</constant> (for log output to the kernel log buffer),
<constant>journal</constant> (for log output to
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
using the native journal protocol), <constant>syslog</constant> (for log output to the classic
syslog socket <filename>/dev/log</filename>), <constant>null</constant> (for no log output
whatsoever) or <constant>auto</constant> (for an automatically determined choice, typically
equivalent to <constant>console</constant> if the service is invoked interactively, and
<constant>journal</constant> or <constant>syslog</constant> otherwise).</para>
<para>For most services, only a small subset of log targets make sense. In particular, most
"normal" services should only implement <constant>console</constant>, <constant>journal</constant>,
and <constant>null</constant>. Anything else is only appropriate for low-level services that
are active in very early boot before proper logging is established.</para>
<para>The service must have the appropriate
<varname>BusName=<replaceable>destination</replaceable></varname> property and also implement the
generic
<citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
interface. (<filename>systemctl</filename> will use the generic D-Bus protocol to access the
<interfacename>org.freedesktop.LogControl1.LogLevel</interfacename> interface for the D-Bus name
<replaceable>destination</replaceable>.)</para></listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>reset-failed [<replaceable>PATTERN</replaceable>…]</command></term>
man: document --failed https://bugs.debian.org/767267
2014-11-08 07:11:53 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Reset the <literal>failed</literal> state of the specified units, or if no unit name is passed, reset
the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
terminating abnormally or timing out), it will automatically enter the <literal>failed</literal> state and
its exit code and status is recorded for introspection by the administrator until the service is
stopped/re-started or reset with this command.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>In addition to resetting the <literal>failed</literal> state of a unit it also resets various other
per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
counter of service units. Thus, if a unit's start limit (as configured with
<varname>StartLimitIntervalSec=</varname>/<varname>StartLimitBurst=</varname>) is hit and the unit refuses
to be started again, use this command to make it startable again.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect2>
<title>Unit File Commands</title>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
<varlistentry>
<term><command>list-unit-files</command> <optional><replaceable>PATTERN…</replaceable></optional></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man: clarify the situation of unit templates regarding "systemctl list-units" + "systemctl list-unit-files" Fixes: #21075
2021-10-28 16:45:02 +08:00
<para>List unit files installed on the system, in combination with their enablement state (as
reported by <command>is-enabled</command>). If one or more <replaceable>PATTERN</replaceable>s
are specified, only unit files whose name matches one of them are shown (patterns matching unit
file system paths are not supported).</para>
<para>Unlike <command>list-units</command> this command will list template units in addition to
explicitly instantiated units.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>enable <replaceable>UNIT</replaceable>…</command></term>
<term><command>enable <replaceable>PATH</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
[Install] sections of the indicated unit files. After the symlinks have been created,
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
the system manager configuration is reloaded (in a way equivalent to <command>daemon-reload</command>), in
order to ensure the changes are taken into account immediately. Note that this does
<emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this is
desired, combine this command with the <option>--now</option> switch, or invoke <command>start</command>
with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
the form <filename>foo@bar.service</filename>), symlinks named the same as instances are created in the
unit configuration directory, however they point to the single template unit file they are instantiated
from.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command expects either valid unit names (in which case various unit file directories are
automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
case these files are read directly). If a specified unit file is located outside of the usual unit file
directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
it is found when requested by commands such as <command>start</command>. The file system where the linked
unit files are located must be accessible when systemd is started (e.g. anything underneath
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<filename>/home/</filename> or <filename>/var/</filename> is not allowed, unless those directories are
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
located on the root file system).</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command will print the file system operations executed. This output may be suppressed by passing
<option>--quiet</option>.
</para>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<para>Note that this operation creates only the symlinks suggested in the [Install]
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
section of the unit files. While this command is the recommended way to manipulate the unit configuration
directory, the administrator is free to make additional changes manually by placing or removing symlinks
below this directory. This is particularly useful to create configurations that deviate from the suggested
default installation. In this case, the administrator must make sure to invoke
<command>daemon-reload</command> manually as necessary, in order to ensure the changes are taken into
account.
</para>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
systemctl: allow suppress the warning of no install info using --no-warn In cases like packaging scripts, it might be desired to use enable/disable on units without install info. So, adding an option '--no-warn' to suppress the warning.
2022-11-27 21:18:44 +08:00
<para>When using this operation on units without install information, a warning about it is shown.
<option>--no-warn</option> can be used to suppress the warning.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Enabling units should not be confused with starting (activating) units, as done by the
<command>start</command> command. Enabling and starting units is orthogonal: units may be enabled without
being started and started without being enabled. Enabling simply hooks the unit into various suggested
places (for example, so that the unit is automatically started on boot or when a particular kind of
hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
the socket (in case of socket units), and so on.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Depending on whether <option>--system</option>, <option>--user</option>, <option>--runtime</option>,
or <option>--global</option> is specified, this enables the unit for the system, for the calling user only,
for only this boot of the system, or for all future logins of all users. Note that in the last case, no
systemd daemon configuration is reloaded.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Using <command>enable</command> on masked units is not supported and results in an error.</para>
</listitem>
</varlistentry>
systemctl: Create new unit files with "edit --force" (#3584)
2016-06-24 14:00:35 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>disable <replaceable>UNIT</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
from the unit configuration directory, and hence undoes any changes made by <command>enable</command> or
<command>link</command>. Note that this removes <emphasis>all</emphasis> symlinks to matching unit files,
including manually created symlinks, and not just those actually created by <command>enable</command> or
<command>link</command>. Note that while <command>disable</command> undoes the effect of
<command>enable</command>, the two commands are otherwise not symmetric, as <command>disable</command> may
remove more symlinks than a prior <command>enable</command> invocation of the same unit created.</para>
logind/systemctl: introduce SetWallMessage and --message Enable unprivileged users to set wall message on a shutdown operation. When the message is set via the --message option, it is logged together with the default shutdown message. $ systemctl reboot --message "Applied kernel updates." $ journalctl -b -1 ... systemd-logind[27]: System is rebooting. (Applied kernel updates.) ...
2015-08-24 20:54:22 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command expects valid unit names only, it does not accept paths to unit files.</para>
logind/systemctl: introduce SetWallMessage and --message Enable unprivileged users to set wall message on a shutdown operation. When the message is set via the --message option, it is logged together with the default shutdown message. $ systemctl reboot --message "Applied kernel updates." $ journalctl -b -1 ... systemd-logind[27]: System is rebooting. (Applied kernel updates.) ...
2015-08-24 20:54:22 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>In addition to the units specified as arguments, all units are disabled that are listed in the
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<varname>Also=</varname> setting contained in the [Install] section of any of the unit
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
files being operated on.</para>
systemctl: introduce --now for enable, disable and mask https://bugs.freedesktop.org/show_bug.cgi?id=42940
2015-05-15 15:54:10 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command implicitly reloads the system manager configuration after completing the operation. Note
that this command does not implicitly stop the units that are being disabled. If this is desired, either
combine this command with the <option>--now</option> switch, or invoke the <command>stop</command> command
with appropriate arguments later.</para>
systemctl: introduce --now for enable, disable and mask https://bugs.freedesktop.org/show_bug.cgi?id=42940
2015-05-15 15:54:10 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command will print information about the file system operations (symlink removals)
executed. This output may be suppressed by passing <option>--quiet</option>.
</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
systemctl: allow suppress the warning of no install info using --no-warn In cases like packaging scripts, it might be desired to use enable/disable on units without install info. So, adding an option '--no-warn' to suppress the warning.
2022-11-27 21:18:44 +08:00
<para>This command honors <option>--system</option>, <option>--user</option>, <option>--runtime</option>,
<option>--global</option> and <option>--no-warn</option> in a similar way as <command>enable</command>.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>reenable <replaceable>UNIT</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Reenable one or more units, as specified on the command line. This is a combination of
<command>disable</command> and <command>enable</command> and is useful to reset the symlinks a unit file is
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
enabled with to the defaults configured in its [Install] section. This command expects
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
a unit name only, it does not accept paths to unit files.</para>
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>preset <replaceable>UNIT</replaceable>…</command></term>
man: document the new systemctl cgroup commands
2013-02-28 02:37:04 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Reset the enable/disable status one or more unit files, as specified on
the command line, to the defaults configured in the preset policy files. This
has the same effect as <command>disable</command> or
<command>enable</command>, depending how the unit is listed in the preset
files.</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Use <option>--preset-mode=</option> to control whether units shall be
enabled and disabled, or only enabled, or only disabled.</para>
install: beef up preset logic to limit to only enable or only disable, and do all-unit preset operations The new "systemctl preset-all" command may now be used to put all installed units back into the enable/disable state the vendor/admin encoded in preset files. Also, introduce "systemctl --preset-mode=enable-only" and "systemctl --preset-mode=disable-only" to only apply the enable or only the disable operations of a "systemctl preset" or "systemctl preset-all" operation. "systemctl preset-all" implements this RFE: https://bugzilla.redhat.com/show_bug.cgi?id=630174
2014-06-17 01:49:31 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If the unit carries no install information, it will be silently ignored
by this command. <replaceable>UNIT</replaceable> must be the real unit name,
any alias names are ignored silently.</para>
install: beef up preset logic to limit to only enable or only disable, and do all-unit preset operations The new "systemctl preset-all" command may now be used to put all installed units back into the enable/disable state the vendor/admin encoded in preset files. Also, introduce "systemctl --preset-mode=enable-only" and "systemctl --preset-mode=disable-only" to only apply the enable or only the disable operations of a "systemctl preset" or "systemctl preset-all" operation. "systemctl preset-all" implements this RFE: https://bugzilla.redhat.com/show_bug.cgi?id=630174
2014-06-17 01:49:31 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>For more information on the preset policy format, see
<citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: move content from the wiki to systemd.preset(5) The wiki was slightly stale, and almost all the information there was already present in the man page. I moved the remaing part (discussion) into the man page and adjusted all links to point to the man page instead. daemon(7) has a some examples of packaging scriptlets… I don't think it fits there very well. Most likely they should be moved to systemd.preset(5) or maybe even removed, but I'm leaving that for later.
2021-01-31 23:48:44 +08:00
</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>preset-all</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Resets all installed unit files to the defaults
configured in the preset policy file (see above).</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Use <option>--preset-mode=</option> to control
whether units shall be enabled and disabled, or only
enabled, or only disabled.</para>
</listitem>
</varlistentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>is-enabled <replaceable>UNIT</replaceable>…</command></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Checks whether any of the specified unit files are
enabled (as with <command>enable</command>). Returns an
exit code of 0 if at least one is enabled, non-zero
otherwise. Prints the current enable status (see table).
To suppress this output, use <option>--quiet</option>.
To show installation targets, use <option>--full</option>.
</para>
man: beef up description of systemctl list-units Fixes https://bugs.freedesktop.org/show_bug.cgi?id=88135.
2018-03-09 17:20:52 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<table>
<title>
<command>is-enabled</command> output
</title>
man: beef up description of systemctl list-units Fixes https://bugs.freedesktop.org/show_bug.cgi?id=88135.
2018-03-09 17:20:52 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<tgroup cols='3'>
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
<entry>Exit Code</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>enabled</literal></entry>
<entry morerows='1'>Enabled via <filename>.wants/</filename>, <filename>.requires/</filename> or <varname>Alias=</varname> symlinks (permanently in <filename>/etc/systemd/system/</filename>, or transiently in <filename>/run/systemd/system/</filename>).</entry>
<entry morerows='1'>0</entry>
</row>
<row>
<entry><literal>enabled-runtime</literal></entry>
</row>
<row>
<entry><literal>linked</literal></entry>
<entry morerows='1'>Made available through one or more symlinks to the unit file (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/system/</filename>), even though the unit file might reside outside of the unit file search path.</entry>
<entry morerows='1'>&gt; 0</entry>
</row>
<row>
<entry><literal>linked-runtime</literal></entry>
</row>
systemctl: add new enablement state "alias" For units which are aliases of other units, reporting preset status as "enabled" is rather misleading. For example, dbus.service is an alias of dbus-broker.service. In list-unit-files we'd show both as "enabled". In particular, systemctl preset ignores aliases, so showing any preset status at all is always going to be misleading. Let's introduce a new state "alias" and use that for all aliases. I was trying to avoid adding a new state, to keep compatibility with previous behaviour, but for alias unit files it simply doesn't seem very useful to show any of the existing states. It seems that the clearly showing that those are aliases for other units will be easiest to understand for users.
2020-05-05 01:53:33 +08:00
<row>
<entry><literal>alias</literal></entry>
<entry>The name is an alias (symlink to another unit file).</entry>
<entry>0</entry>
</row>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<row>
<entry><literal>masked</literal></entry>
<entry morerows='1'>Completely disabled, so that any start operation on it fails (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/systemd/</filename>).</entry>
<entry morerows='1'>&gt; 0</entry>
</row>
<row>
<entry><literal>masked-runtime</literal></entry>
</row>
<row>
<entry><literal>static</literal></entry>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<entry>The unit file is not enabled, and has no provisions for enabling in the [Install] unit file section.</entry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<entry>0</entry>
</row>
<row>
<entry><literal>indirect</literal></entry>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the [Install] unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in <varname>Also=</varname>. For template unit files, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<entry>0</entry>
</row>
<row>
<entry><literal>disabled</literal></entry>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<entry>The unit file is not enabled, but contains an [Install] section with installation instructions.</entry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<entry>&gt; 0</entry>
</row>
<row>
<entry><literal>generated</literal></entry>
<entry>The unit file was generated dynamically via a generator tool. See <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Generated unit files may not be enabled, they are enabled implicitly by their generator.</entry>
<entry>0</entry>
</row>
<row>
<entry><literal>transient</literal></entry>
<entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.</entry>
<entry>0</entry>
</row>
<row>
<entry><literal>bad</literal></entry>
<entry>The unit file is invalid or another error occurred. Note that <command>is-enabled</command> will not actually return this state, but print an error message instead. However the unit file listing printed by <command>list-unit-files</command> might show it.</entry>
<entry>&gt; 0</entry>
</row>
systemctl: is-enabled: document the return code change Follow-up for #25689 We've added a new output ("not-found") in #25689.
2022-12-15 00:50:19 +08:00
<row>
<entry><literal>not-found</literal></entry>
<entry>The unit file doesn't exist.</entry>
<entry>4</entry>
</row>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</tbody>
</tgroup>
</table>
man: beef up description of systemctl list-units Fixes https://bugs.freedesktop.org/show_bug.cgi?id=88135.
2018-03-09 17:20:52 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
systemctl: new verb 'list-sockets' LISTEN UNIT ACTIVATES /dev/initctl systemd-initctl.socket systemd-initctl.service /dev/log systemd-journald.socket systemd-journald.service ... [::]:19531 systemd-journal-gatewayd.socket systemd-journal-gatewayd.service kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service 17 sockets listed. Pass --all to see loaded but inactive sockets, too.
2013-04-12 06:59:18 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>mask <replaceable>UNIT</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Mask one or more units, as specified on the command line. This will link these unit files to
<filename>/dev/null</filename>, making it impossible to start them. This is a stronger version of
<command>disable</command>, since it prohibits all kinds of activation of the unit, including enablement
and manual activation. Use this option with care. This honors the <option>--runtime</option> option to only
mask temporarily until the next reboot of the system. The <option>--now</option> option may be used to
ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
file paths.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>unmask <replaceable>UNIT</replaceable>…</command></term>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
<command>mask</command>. This command expects valid unit names only, it does not accept unit file
paths.</para>
</listitem>
</varlistentry>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>link <replaceable>PATH</replaceable>…</command></term>
man: systemctl list-timers: Provide sample output and document it. (#5463) As with `systemctl list-sockets` and `systemctl status`, we provide a sample output for `systemctl list-timers` and document what the columns mean.
2017-02-27 09:03:30 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man: fix count mismatch We said "search path" and "search paths" in the same sentence…
2022-10-20 18:27:29 +08:00
<para>Link a unit file that is not in the unit file search path into the unit file search path. This
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
command expects an absolute path to a unit file. The effect of this may be undone with
<command>disable</command>. The effect of this command is that a unit file is made available for commands
such as <command>start</command>, even though it is not installed directly in the unit search path. The
file system where the linked unit files are located must be accessible when systemd is started
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
(e.g. anything underneath <filename>/home/</filename> or <filename>/var/</filename> is not allowed, unless
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
those directories are located on the root file system).</para>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>revert <replaceable>UNIT</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
files that modify the specified units, as well as any user-configured unit file that overrides a matching
vendor supplied unit file. Specifically, for a unit <literal>foo.service</literal> the matching directories
<literal>foo.service.d/</literal> with all their contained files are removed, both below the persistent and
runtime configuration directories (i.e. below <filename>/etc/systemd/system</filename> and
<filename>/run/systemd/system</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
located below <filename>/usr/</filename>) any matching persistent or runtime unit file that overrides it is
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
<filename>/etc/systemd/system</filename> or <filename>/run/systemd/system</filename>, but not in a unit
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
file stored below <filename>/usr/</filename>), then it is not removed. Also, if a unit is masked, it is
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
unmasked.</para>
<para>Effectively, this command may be used to undo all changes made with <command>systemctl
edit</command>, <command>systemctl set-property</command> and <command>systemctl mask</command> and puts
the original unit file with its settings back in effect.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>add-wants <replaceable>TARGET</replaceable>
<replaceable>UNIT</replaceable>…</command></term>
<term><command>add-requires <replaceable>TARGET</replaceable>
<replaceable>UNIT</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Adds <literal>Wants=</literal> or <literal>Requires=</literal>
dependencies, respectively, to the specified
<replaceable>TARGET</replaceable> for one or more units. </para>
<para>This command honors <option>--system</option>,
<option>--user</option>, <option>--runtime</option> and
<option>--global</option> in a way similar to
<command>enable</command>.</para>
man: add note about systemctl stop return value Fixes #13104. (I know a lot more could be added to that man page. This patch only addresses that once specific complaint.)
2019-07-18 16:14:52 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>edit <replaceable>UNIT</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
systemctl: new option --drop-in for specifying drop-in filename Previously 'systemctl edit' would only operate on 'override.conf', but users may need more than that. Thus the new option '--drop-in' is added to allow users to specify the drop-in file name. Closes #25767
2022-12-17 21:07:32 +08:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If <option>--full</option> is specified, this will copy the
original units instead of creating drop-in files.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If <option>--force</option> is specified and any units do
not already exist, new unit files will be opened for editing.</para>
man: document the interaction of "systemctl restart" and the FD store See: #7126
2017-11-15 18:22:25 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If <option>--runtime</option> is specified, the changes will
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
be made temporarily in <filename>/run/</filename> and they will be
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
lost on the next reboot.</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
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<filename>/etc/</filename>, since they take precedence over
<filename>/run/</filename>.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>get-default</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Return the default target to boot into. This returns
the target unit name <filename>default.target</filename>
is aliased (symlinked) to.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>set-default <replaceable>TARGET</replaceable></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Set the default target to boot into. This sets
(symlinks) the <filename>default.target</filename> alias
to the given target unit.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</variablelist>
</refsect2>
<refsect2>
<title>Machine Commands</title>
<variablelist>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>list-machines</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>List the host and all running local containers with
their state. If one or more
<replaceable>PATTERN</replaceable>s are specified, only
containers matching one of them are shown.
</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</variablelist>
</refsect2>
<refsect2>
<title>Job Commands</title>
<variablelist>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>list-jobs <optional><replaceable>PATTERN…</replaceable></optional></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>List jobs that are in progress. If one or more
<replaceable>PATTERN</replaceable>s are specified, only
jobs for units matching one of them are shown.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>When combined with <option>--after</option> or <option>--before</option> the list is augmented with
information on which other job each job is waiting for, and which other jobs are waiting for it, see
above.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>cancel <replaceable>JOB</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Cancel one or more jobs specified on the command line
by their numeric job IDs. If no job ID is specified, cancel
all pending jobs.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</variablelist>
</refsect2>
<refsect2>
<title>Environment Commands</title>
man: document what variables are allowed
2020-10-23 21:47:33 +08:00
<para><command>systemd</command> supports an environment block that is passed to processes the manager
spawns. The names of the variables can contain ASCII letters, digits, and the underscore
character. Variable names cannot be empty or start with a digit. In variable values, most characters
Allow control characters in environment variable values So far, we would allow certain control characters (NL since b4346b9a77bc6129dd3e, TAB since 6294aa76d818e831de45), but not others. Having other control characters in environment variable *value* is expected and widely used, for various prompts like $LESS, $LESS_TERMCAP_*, and other similar variables. The typical environment exported by bash already contains a dozen or so such variables, so programs need to handle them. We handle then correctly too, for example in 'systemctl show-environment', since 804ee07c1370d49aa9a. But we would still disallow setting such variables by the user, in unit file Environment= and in set-environment/import-environment operations. This is unexpected and confusing and doesn't help with anything because such variables are present in the environment through other means. When printing such variables, 'show-environment' escapes all special characters, so variables with control characters are plainly visible. In other uses, e.g. 'cat -v' can be used in similar fashion. This would already need to be done to suppress color codes starting with \[. Note that we still forbid invalid utf-8 with this patch. (Control characters are valid, since they are valid 7-bit ascii.) I'm not sure if we should do that, but since people haven't been actually asking for invalid utf-8, and only for control characters, and invalid utf-8 causes other issues, I think it's OK to leave this unchanged. Fixes #4446, https://gitlab.gnome.org/GNOME/gnome-session/-/issues/45.
2021-01-04 05:26:52 +08:00
are allowed, but the whole sequence must be valid UTF-8. (Note that control characters like newline
(<constant>NL</constant>), tab (<constant>TAB</constant>), or the escape character
(<constant>ESC</constant>), <emphasis>are</emphasis> valid ASCII and thus valid UTF-8). The total
length of the environment block is limited to <constant>_SC_ARG_MAX</constant> value defined by
man: document what variables are allowed
2020-10-23 21:47:33 +08:00
<citerefentry project='man-pages'><refentrytitle>sysconf</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>show-environment</command></term>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Dump the systemd manager environment block. This is the environment
block that is passed to all processes the manager spawns. The environment
docs: s/straight-forward/straightforward/ Inspired by https://github.com/systemd/systemd/pull/20156#discussion_r810878846
2022-03-16 00:04:36 +08:00
block will be dumped in straightforward form suitable for sourcing into
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
most shells. If no special characters or whitespace is present in the variable
values, no escaping is performed, and the assignments have the form
<literal>VARIABLE=value</literal>. If whitespace or characters which have
special meaning to the shell are present, dollar-single-quote escaping is
used, and assignments have the form <literal>VARIABLE=$'value'</literal>.
This syntax is known to be supported by
<citerefentry project='die-net'><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>zsh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>ksh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
and
<citerefentry project='die-net'><refentrytitle>busybox</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<citerefentry project='die-net'><refentrytitle>ash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
but not
<citerefentry project='die-net'><refentrytitle>dash</refentrytitle><manvolnum>1</manvolnum></citerefentry>
or
<citerefentry project='die-net'><refentrytitle>fish</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
man: document what variables are allowed
2020-10-23 21:47:33 +08:00
<para>Set one or more systemd manager environment variables, as specified on the command
line. This command will fail if variable names and values do not conform to the rules listed
above.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>unset-environment <replaceable>VARIABLE</replaceable>…</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Unset one or more systemd manager environment
variables. If only a variable name is specified, it will be
removed regardless of its value. If a variable and a value
are specified, the variable is only removed if it has the
specified value.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term>
<command>import-environment</command>
systemctl: deprecate blanket import-environment Importing the full environment is convenient, but it doesn't work too well in practice, because we get a metric ton of shell-specific crap that should never end up in the global environment block: $ systemctl --user show-environment ... SHELL=/bin/zsh AUTOJUMP_ERROR_PATH=/home/zbyszek/.local/share/autojump/errors.log AUTOJUMP_SOURCED=1 CONDA_SHLVL=0 CVS_RSH=ssh DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus DESKTOP_SESSION=gnome DISPLAY=:0 FPATH=/usr/share/Modules/init/zsh-functions:/usr/local/share/zsh/site-functions:/usr/share/zsh/site-functions:/usr/share/zsh/5.8/functions GDMSESSION=gnome GDM_LANG=en_US.UTF-8 GNOME_SETUP_DISPLAY=:1 GUESTFISH_INIT=$'\\e[1;34m' GUESTFISH_OUTPUT=$'\\e[0m' GUESTFISH_PS1=$'\\[\\e[1;32m\\]><fs>\\[\\e[0;31m\\] ' GUESTFISH_RESTORE=$'\\e[0m' HISTCONTROL=ignoredups HISTSIZE=1000 LOADEDMODULES= OLDPWD=/home/zbyszek PWD=/home/zbyszek QTDIR=/usr/lib64/qt-3.3 QTINC=/usr/lib64/qt-3.3/include QTLIB=/usr/lib64/qt-3.3/lib QT_IM_MODULE=ibus SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS=0 SESSION_MANAGER=local/unix:@/tmp/.ICE-unix/2612,unix/unix:/tmp/.ICE-unix/2612 SHLVL=0 STEAM_FRAME_FORCE_CLOSE=1 TERM=xterm-256color USERNAME=zbyszek WISECONFIGDIR=/usr/share/wise2/ ... Plenty of shell-specific and terminal-specific stuff that have no global significance. Let's start warning when this is used to push people towards importing only specific variables. Putative NEWS entry: * systemctl import-environment will now emit a warning when called without any arguments (i.e. to import the full environment block of the called program). This command will usually be invoked from a shell, which means that it'll inherit a bunch of variables which are specific to that shell, and usually to the tty the shell is connected to, and don't have any meaning in the global context of the system or user service manager. Instead, only specific variables should be imported into the manager environment block. Similarly, programs which update the manager environment block by directly calling the D-Bus API of the manager, should also push specific variables, and not the full inherited environment.
2021-01-05 18:24:03 +08:00
<replaceable>VARIABLE…</replaceable>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
man: document what variables are allowed
2020-10-23 21:47:33 +08:00
<para>Import all, one or more environment variables set on the client into the systemd manager
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
environment block. If a list of environment variable names is passed, client-side values are then
imported into the manager's environment block. If any names are not valid environment variable
names or have invalid values according to the rules described above, an error is raised. If no
arguments are passed, the entire environment block inherited by the <command>systemctl</command>
process is imported. In this mode, any inherited invalid environment variables are quietly
ignored.</para>
systemctl: deprecate blanket import-environment Importing the full environment is convenient, but it doesn't work too well in practice, because we get a metric ton of shell-specific crap that should never end up in the global environment block: $ systemctl --user show-environment ... SHELL=/bin/zsh AUTOJUMP_ERROR_PATH=/home/zbyszek/.local/share/autojump/errors.log AUTOJUMP_SOURCED=1 CONDA_SHLVL=0 CVS_RSH=ssh DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus DESKTOP_SESSION=gnome DISPLAY=:0 FPATH=/usr/share/Modules/init/zsh-functions:/usr/local/share/zsh/site-functions:/usr/share/zsh/site-functions:/usr/share/zsh/5.8/functions GDMSESSION=gnome GDM_LANG=en_US.UTF-8 GNOME_SETUP_DISPLAY=:1 GUESTFISH_INIT=$'\\e[1;34m' GUESTFISH_OUTPUT=$'\\e[0m' GUESTFISH_PS1=$'\\[\\e[1;32m\\]><fs>\\[\\e[0;31m\\] ' GUESTFISH_RESTORE=$'\\e[0m' HISTCONTROL=ignoredups HISTSIZE=1000 LOADEDMODULES= OLDPWD=/home/zbyszek PWD=/home/zbyszek QTDIR=/usr/lib64/qt-3.3 QTINC=/usr/lib64/qt-3.3/include QTLIB=/usr/lib64/qt-3.3/lib QT_IM_MODULE=ibus SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS=0 SESSION_MANAGER=local/unix:@/tmp/.ICE-unix/2612,unix/unix:/tmp/.ICE-unix/2612 SHLVL=0 STEAM_FRAME_FORCE_CLOSE=1 TERM=xterm-256color USERNAME=zbyszek WISECONFIGDIR=/usr/share/wise2/ ... Plenty of shell-specific and terminal-specific stuff that have no global significance. Let's start warning when this is used to push people towards importing only specific variables. Putative NEWS entry: * systemctl import-environment will now emit a warning when called without any arguments (i.e. to import the full environment block of the called program). This command will usually be invoked from a shell, which means that it'll inherit a bunch of variables which are specific to that shell, and usually to the tty the shell is connected to, and don't have any meaning in the global context of the system or user service manager. Instead, only specific variables should be imported into the manager environment block. Similarly, programs which update the manager environment block by directly calling the D-Bus API of the manager, should also push specific variables, and not the full inherited environment.
2021-01-05 18:24:03 +08:00
<para>Importing of the full inherited environment block (calling this command without any
arguments) is deprecated. A shell will set dozens of variables which only make sense locally and
are only meant for processes which are descendants of the shell. Such variables in the global
environment block are confusing to other processes.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</variablelist>
</refsect2>
<refsect2>
systemctl: add log-level and log-target commands This copies the commands log-level and log-target (to query and set the current settings) from systemd-analyze to systemctl, essentially reverting a65615ca5d78be0dcd7d9c9b4a663fa75f758606. Controllling the log level settings of the manager is basic functionality, that should be available even if systemd-analyze (which is more of an analysis tool) is not installed. This is like dmesg and journalctl, which should be available even if a debugger and more advanced tools to analyze the kernel are not available. (Note that dmesg is used to control the log level too, not just to browse the kernel logs.) I chose to copy&paste the methods from analyze.c to the new location. There isn't enough code to share, because acquire_bus() in both places has a different signature despite the same name, so the only part that is common is the invocation of sd_bus_set_property().
2019-11-15 16:39:50 +08:00
<title>Manager State Commands</title>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>daemon-reload</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Reload the systemd manager configuration. This will
rerun all generators (see
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
reload all unit files, and recreate the entire dependency
tree. While the daemon is being reloaded, all sockets
systemd listens on behalf of user configuration will stay
accessible.</para>
man: document that "systemctl show" shows low-level properties Fixes: #4654
2016-12-07 02:33:36 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>This command should not be confused with the
<command>reload</command> command.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
systemctl: add log-level and log-target commands This copies the commands log-level and log-target (to query and set the current settings) from systemd-analyze to systemctl, essentially reverting a65615ca5d78be0dcd7d9c9b4a663fa75f758606. Controllling the log level settings of the manager is basic functionality, that should be available even if systemd-analyze (which is more of an analysis tool) is not installed. This is like dmesg and journalctl, which should be available even if a debugger and more advanced tools to analyze the kernel are not available. (Note that dmesg is used to control the log level too, not just to browse the kernel logs.) I chose to copy&paste the methods from analyze.c to the new location. There isn't enough code to share, because acquire_bus() in both places has a different signature despite the same name, so the only part that is common is the invocation of sd_bus_set_property().
2019-11-15 16:39:50 +08:00
systemctl: add "systemctl cat"
2013-12-01 08:09:26 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>daemon-reexec</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
systemctl: add "systemctl cat"
2013-12-01 08:09:26 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Reexecute the systemd manager. This will serialize the
manager state, reexecute the process and deserialize the
state again. This command is of little use except for
debugging and package upgrades. Sometimes, it might be
helpful as a heavy-weight <command>daemon-reload</command>.
While the daemon is being reexecuted, all sockets systemd listening
on behalf of user configuration will stay accessible.
</para>
systemctl: add "systemctl cat"
2013-12-01 08:09:26 +08:00
</listitem>
</varlistentry>
systemctl: add log-level and log-target commands This copies the commands log-level and log-target (to query and set the current settings) from systemd-analyze to systemctl, essentially reverting a65615ca5d78be0dcd7d9c9b4a663fa75f758606. Controllling the log level settings of the manager is basic functionality, that should be available even if systemd-analyze (which is more of an analysis tool) is not installed. This is like dmesg and journalctl, which should be available even if a debugger and more advanced tools to analyze the kernel are not available. (Note that dmesg is used to control the log level too, not just to browse the kernel logs.) I chose to copy&paste the methods from analyze.c to the new location. There isn't enough code to share, because acquire_bus() in both places has a different signature despite the same name, so the only part that is common is the invocation of sd_bus_set_property().
2019-11-15 16:39:50 +08:00
resolve: allow setting the log level dynamically as in pid1 This is useful to raise the log level for a single transaction or a few, without affecting other state of the resolved as a restart would. The log level can only be set, I didn't bother with having the ability to restore the original as in pid1.
2020-04-20 17:02:39 +08:00
<varlistentry id='log-level'>
systemctl: add log-level and log-target commands This copies the commands log-level and log-target (to query and set the current settings) from systemd-analyze to systemctl, essentially reverting a65615ca5d78be0dcd7d9c9b4a663fa75f758606. Controllling the log level settings of the manager is basic functionality, that should be available even if systemd-analyze (which is more of an analysis tool) is not installed. This is like dmesg and journalctl, which should be available even if a debugger and more advanced tools to analyze the kernel are not available. (Note that dmesg is used to control the log level too, not just to browse the kernel logs.) I chose to copy&paste the methods from analyze.c to the new location. There isn't enough code to share, because acquire_bus() in both places has a different signature despite the same name, so the only part that is common is the invocation of sd_bus_set_property().
2019-11-15 16:39:50 +08:00
<term><command>log-level</command> [<replaceable>LEVEL</replaceable>]</term>
<listitem><para>If no argument is given, print the current log level of the manager. If an
optional argument <replaceable>LEVEL</replaceable> is provided, then the command changes the
current log level of the manager to <replaceable>LEVEL</replaceable> (accepts the same values as
<option>--log-level=</option> described in
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
</para></listitem>
</varlistentry>
<varlistentry>
<term><command>log-target</command> [<replaceable>TARGET</replaceable>]</term>
<listitem><para>If no argument is given, print the current log target of the manager. If an
optional argument <replaceable>TARGET</replaceable> is provided, then the command changes the
current log target of the manager to <replaceable>TARGET</replaceable> (accepts the same values as
<option>--log-target=</option>, described in
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
</para></listitem>
</varlistentry>
systemctl: add service-watchdogs command The rationale is the same as for log-level/log-target: this controls the behaviour of the manager, and belongs in systemctl.
2019-11-15 17:14:57 +08:00
<varlistentry>
<term><command>service-watchdogs</command> [yes|no]</term>
<listitem><para>If no argument is given, print the current state of service runtime watchdogs of
the manager. If an optional boolean argument is provided, then globally enables or disables the
service runtime watchdogs (<option>WatchdogSec=</option>) and emergency actions (e.g.
<option>OnFailure=</option> or <option>StartLimitAction=</option>); see
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
The hardware watchdog is not affected by this setting.</para></listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</variablelist>
</refsect2>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect2>
<title>System Commands</title>
core: allow 'SetUnitProperties()' to run on inactive units too 'set-property' has been primarly designed to change some properties of *active* units. However it can easily work on inactive units as well. In that case changes are only saved in a drop-in for futur uses and changes will be effective when unit will be started. Actually it already works on inactive units but that was not documented and not fully supported. Indeed the inactive units had to be known by the manager otherwise it was reported as not loaded: $ systemctl status my-test.service * my-test.service - My Testing Unit Loaded: loaded (/etc/systemd/system/my-test.service; static; vendor preset: disabled) Drop-In: /etc/systemd/system/my-test.service.d Active: inactive (dead) $ systemctl set-property my-test.service MemoryLimit=1000000 Failed to set unit properties on my-test.service: Unit my-test.service is not loaded. [ Note: that the unit load state reported by the 'status' command might be confusing since it claimed the unit as loaded but 'set-property' reported the contrary. ] One can possibily workaround this by making the unit a dependency of another active unit so the manager will keep it around: $ systemctl add-wants multi-user.target my-test.service Created symlink from /etc/systemd/system/multi-user.target.wants/my-test.service to /etc/systemd/system/my-test.service. $ systemctl set-property my-test.service MemoryLimit=1000000 $ systemctl status my-test.service * my-test.service - My Testing Unit Loaded: loaded (/etc/systemd/system/my-test.service; enabled; vendor preset: disabled) Drop-In: /etc/systemd/system/my-test.service.d `-50-MemoryLimit.conf Active: inactive (dead) This patch simply forces 'SetUnitProperties()' to load the unit if it's not already the case. It also documents the fact that 'set-property' can be used on inactive units.
2015-11-04 01:25:46 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
<varlistentry>
<term><command>is-system-running</command></term>
man: add example for setting multiple properties at once Fixes: #4908
2019-07-12 15:55:05 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Checks whether the system is operational. This
returns success (exit code 0) when the system is fully up
and running, specifically not in startup, shutdown or
maintenance mode, and with no failed services. Failure is
returned otherwise (exit code non-zero). In addition, the
current state is printed in a short string to standard
output, see the table below. Use <option>--quiet</option> to
suppress this output.</para>
man: add example for setting multiple properties at once Fixes: #4908
2019-07-12 15:55:05 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Use <option>--wait</option> to wait until the boot
process is completed before printing the current state and
returning the appropriate error status. If <option>--wait</option>
is in use, states <varname>initializing</varname> or
<varname>starting</varname> will not be reported, instead
the command will block until a later state (such as
<varname>running</varname> or <varname>degraded</varname>)
is reached.</para>
man: add example for setting multiple properties at once Fixes: #4908
2019-07-12 15:55:05 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<table>
<title><command>is-system-running</command> output</title>
<tgroup cols='3'>
<colspec colname='name'/>
<colspec colname='description'/>
<colspec colname='exit-code'/>
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
<entry>Exit Code</entry>
</row>
</thead>
<tbody>
<row>
<entry><varname>initializing</varname></entry>
<entry><para>Early bootup, before
<filename>basic.target</filename> is reached
or the <varname>maintenance</varname> state entered.
</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>starting</varname></entry>
<entry><para>Late bootup, before the job queue
becomes idle for the first time, or one of the
rescue targets are reached.</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>running</varname></entry>
<entry><para>The system is fully
operational.</para></entry>
<entry>0</entry>
</row>
<row>
<entry><varname>degraded</varname></entry>
<entry><para>The system is operational but one or more
units failed.</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>maintenance</varname></entry>
<entry><para>The rescue or emergency target is
active.</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>stopping</varname></entry>
<entry><para>The manager is shutting
down.</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>offline</varname></entry>
<entry><para>The manager is not
running. Specifically, this is the operational
state if an incompatible program is running as
system manager (PID 1).</para></entry>
<entry>&gt; 0</entry>
</row>
<row>
<entry><varname>unknown</varname></entry>
<entry><para>The operational state could not be
determined, due to lack of resources or another
error cause.</para></entry>
<entry>&gt; 0</entry>
</row>
</tbody>
</tgroup>
</table>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>default</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Enter default mode. This is equivalent to <command>systemctl isolate default.target</command>. This
operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>rescue</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Enter rescue mode. This is equivalent to <command>systemctl isolate rescue.target</command>. This
operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>emergency</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Enter emergency mode. This is equivalent to <command>systemctl isolate
emergency.target</command>. This operation is blocking by default, use <option>--no-block</option> to
request asynchronous behavior.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>halt</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Shut down and halt the system. This is mostly equivalent to <command>systemctl start halt.target
--job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This command is
asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
on. Use <command>systemctl poweroff</command> for powering off the system (see below).</para>
<para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
system halt. If <option>--force</option> is specified twice, the operation is immediately executed without
terminating any processes or unmounting any file systems. This may result in data loss. Note that when
<option>--force</option> is specified twice the halt 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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>poweroff</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Shut down and power-off the system. This is mostly equivalent to <command>systemctl start
poweroff.target --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all
users. This command is asynchronous; it will return after the power-off operation is enqueued, without
waiting for it to complete.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
powering off. If <option>--force</option> is specified twice, the operation is immediately executed without
terminating any processes or unmounting any file systems. This may result in data loss. Note that when
<option>--force</option> is specified twice the power-off 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>
</listitem>
</varlistentry>
<varlistentry>
#15773 add --reboot-argument to systemctl reboot
2020-05-30 01:15:34 +08:00
<term><command>reboot</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man: cross-advertize bootctl and systemctl boot loader support
2022-04-28 22:44:40 +08:00
<para>Shut down and reboot the system.</para>
<para>This command mostly equivalent to <command>systemctl start reboot.target
--job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all
users. This command is asynchronous; it will return after the reboot operation is enqueued,
without waiting for it to complete.</para>
man: update systemctl man page for unit file commands, in particular "systemctl enable" Clarify that "systemctl enable" can operate either on unit names or on unit file paths (also, adjust the --help text to clarify this). Say that "systemctl enable" on unit file paths also links the unit into the search path. Many other fixes. This should improve the documentation to avoid further confusion around #3706.
2016-07-25 21:10:15 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
reboot. If <option>--force</option> is specified twice, the operation is immediately executed without
terminating any processes or unmounting any file systems. This may result in data loss. Note that when
<option>--force</option> is specified twice the reboot 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>
man: update systemctl man page for unit file commands, in particular "systemctl enable" Clarify that "systemctl enable" can operate either on unit names or on unit file paths (also, adjust the --help text to clarify this). Say that "systemctl enable" on unit file paths also links the unit into the search path. Many other fixes. This should improve the documentation to avoid further confusion around #3706.
2016-07-25 21:10:15 +08:00
#15773 add --reboot-argument to systemctl reboot
2020-05-30 01:15:34 +08:00
<para>If the switch <option>--reboot-argument=</option> is given, it will be passed as the optional
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
argument to the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
#15773 add --reboot-argument to systemctl reboot
2020-05-30 01:15:34 +08:00
system call.</para>
man: cross-advertize bootctl and systemctl boot loader support
2022-04-28 22:44:40 +08:00
<para>Options <option>--boot-loader-entry=</option>, <option>--boot-loader-menu=</option>, and
<option>--firmware-setup</option> can be used to select what to do <emphasis>after</emphasis> the
reboot. See the descriptions of those options for details.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>kexec</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Shut down and reboot the system via <command>kexec</command>. This is equivalent to
<command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block</command>. This command is
asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
complete.</para>
man: update systemctl man page for unit file commands, in particular "systemctl enable" Clarify that "systemctl enable" can operate either on unit names or on unit file paths (also, adjust the --help text to clarify this). Say that "systemctl enable" on unit file paths also links the unit into the search path. Many other fixes. This should improve the documentation to avoid further confusion around #3706.
2016-07-25 21:10:15 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
reboot.</para>
</listitem>
</varlistentry>
man: update systemctl man page for unit file commands, in particular "systemctl enable" Clarify that "systemctl enable" can operate either on unit names or on unit file paths (also, adjust the --help text to clarify this). Say that "systemctl enable" on unit file paths also links the unit into the search path. Many other fixes. This should improve the documentation to avoid further confusion around #3706.
2016-07-25 21:10:15 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>exit</command> <optional><replaceable>EXIT_CODE</replaceable></optional></term>
man: update systemctl man page for unit file commands, in particular "systemctl enable" Clarify that "systemctl enable" can operate either on unit names or on unit file paths (also, adjust the --help text to clarify this). Say that "systemctl enable" on unit file paths also links the unit into the search path. Many other fixes. This should improve the documentation to avoid further confusion around #3706.
2016-07-25 21:10:15 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
conjunction with the <option>--user</option> option) or in containers and is equivalent to
<command>poweroff</command> otherwise. This command is asynchronous; it will return after the exit
operation is enqueued, without waiting for it to complete.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>The service manager will exit with the specified exit code, if
<replaceable>EXIT_CODE</replaceable> is passed.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>switch-root</command> <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<listitem>
man: "the initial RAM disk" → "the initrd" In many places we spelled out the phrase behind "initrd" in full, but this isn't terribly useful. In fact, no "RAM disk" is used, so emphasizing this is just confusing to the reader. Let's just say "initrd" everywhere, people understand what this refers to, and that it's in fact an initramfs image. Also, s/i.e./e.g./ where appropriate. Also, don't say "in RAM", when in fact it's virtual memory, whose pages may or may not be loaded in page frames in RAM, and we have no control over this. Also, add <filename></filename> and other minor cleanups.
2022-09-15 20:43:59 +08:00
<para>Switches to a different root directory and executes a new system manager process below it.
This is intended for use in the initrd, and will transition from the initrd's system manager
process (a.k.a. "init" process) to the main system manager process which is loaded from the
actual host root files system. This call takes two arguments: the directory that is to become the
new root directory, and the path to the new system manager binary below it to execute as PID 1.
If the latter is omitted or the empty string, a systemd binary will automatically be searched for
and used as init. If the system manager path is omitted, equal to the empty string or identical
to the path to the systemd binary, the state of the initrd's system manager process is passed to
the main system manager, which allows later introspection of the state of the services involved
in the initrd boot phase.</para>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>suspend</command></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
</listitem>
</varlistentry>
systemctl,pid1: do not warn about missing install info with "preset" When "preset" was executed for a unit without install info, we'd warn similarly as for "enable" and "disable". But "preset" is usually called for all units, because the preset files are provided by the distribution, and the units are under control of individual programs, and it's reasonable to call "preset" for all units rather then try to do it only for the ones that can be installed. We also don't warn about missing info for "preset-all". Thus it seems reasonable to silently ignore units w/o install info when presetting. (In addition, when more than one unit was specified, we'd issue the warning only if none of them had install info. But this is probably something to fix for enable/disable too.)
2016-04-22 08:04:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><command>hibernate</command></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<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>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
</listitem>
</varlistentry>
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>hybrid-sleep</command></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Hibernate and suspend the system. This will trigger activation of the special target unit
<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>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<term><command>suspend-then-hibernate</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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.
It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect2>
<title>Parameter Syntax</title>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Unit commands listed above take either a single unit name (designated as <replaceable>UNIT</replaceable>),
or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>…). In the first case, the
unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"),
systemctl will append a suitable suffix, <literal>.service</literal> by default, and a type-specific suffix in
case of commands which operate only on specific unit types. For example,
<programlisting># systemctl start sshd</programlisting> and
<programlisting># systemctl start sshd.service</programlisting>
are equivalent, as are
<programlisting># systemctl isolate default</programlisting>
and
<programlisting># systemctl isolate default.target</programlisting>
Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
paths to mount unit names.
<programlisting># systemctl status /dev/sda
# systemctl status /home</programlisting>
are equivalent to:
<programlisting># systemctl status dev-sda.device
# systemctl status home.mount</programlisting>
In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
names always refer to exactly one unit, but globs may match zero units and this is not considered an
error.</para>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Glob patterns use
<citerefentry project='man-pages'><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
so normal shell-style globbing rules are used, and
<literal>*</literal>, <literal>?</literal>,
<literal>[]</literal> may be used. See
<citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
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>
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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>For unit file commands, the specified <replaceable>UNIT</replaceable> should be the name of the unit file
(possibly abbreviated, see above), or the absolute path to the unit file:
<programlisting># systemctl enable foo.service</programlisting>
or
<programlisting># systemctl link /path/to/foo.service</programlisting>
</para>
</refsect2>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</refsect1>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<refsect1>
<title>Options</title>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>The following options are understood:</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<variablelist>
<varlistentry>
<term><option>-t</option></term>
<term><option>--type=</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
systemctl: make show/status honour --state and --type This makes the interface more flexible, by allowing the same filtering for show and status as is done for list-units. Fixes #23207.
2022-05-22 20:32:55 +08:00
<para>The argument is a comma-separated list of unit types such as <option>service</option> and
<option>socket</option>. When units are listed with <command>list-units</command>,
systemctl: list-dependencies: support --type= and --state= Closes #25975
2023-01-13 16:52:29 +08:00
<command>list-dependencies</command>, <command>show</command>, or <command>status</command>,
only units of the specified types will be shown. By default, units of all types are shown.</para>
core,systemctl: add new "systemctl revert" command This allows dropping all user configuration and reverting back to the vendor default of a unit file. It basically undoes what "systemctl edit", "systemctl set-property" and "systemctl mask" do.
2016-04-09 00:00:36 +08:00
systemctl: make show/status honour --state and --type This makes the interface more flexible, by allowing the same filtering for show and status as is done for list-units. Fixes #23207.
2022-05-22 20:32:55 +08:00
<para>As a special case, if one of the arguments is <option>help</option>, a list of allowed values
will be printed and the program will exit.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
core,systemctl: add new "systemctl revert" command This allows dropping all user configuration and reverting back to the vendor default of a unit file. It basically undoes what "systemctl edit", "systemctl set-property" and "systemctl mask" do.
2016-04-09 00:00:36 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--state=</option></term>
core,systemctl: add new "systemctl revert" command This allows dropping all user configuration and reverting back to the vendor default of a unit file. It basically undoes what "systemctl edit", "systemctl set-property" and "systemctl mask" do.
2016-04-09 00:00:36 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
systemctl: make show/status honour --state and --type This makes the interface more flexible, by allowing the same filtering for show and status as is done for list-units. Fixes #23207.
2022-05-22 20:32:55 +08:00
<para>The argument is a comma-separated list of unit LOAD, SUB, or ACTIVE states. When listing
systemctl: list-dependencies: support --type= and --state= Closes #25975
2023-01-13 16:52:29 +08:00
units with <command>list-units</command>, <command>list-dependencies</command>, <command>show</command>
or <command>status</command>, show only those in the specified states. Use <option>--state=failed</option>
or <option>--failed</option> to show only failed units.</para>
systemctl: make show/status honour --state and --type This makes the interface more flexible, by allowing the same filtering for show and status as is done for list-units. Fixes #23207.
2022-05-22 20:32:55 +08:00
<para>As a special case, if one of the arguments is <option>help</option>, a list of allowed values
will be printed and the program will exit.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-p</option></term>
<term><option>--property=</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When showing unit/job/manager properties with the
<command>show</command> command, limit display to properties
specified in the argument. The argument should be a
comma-separated list of property names, such as
<literal>MainPID</literal>. Unless specified, all known
properties are shown. If specified more than once, all
properties with the specified names are shown. Shell
completion is implemented for property names.</para>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>For the manager itself,
docs: Clarify systemctl show manual The manual incorrectly asserted that the properties in systemctl show matched the the options in systemd-system.conf, which is not always true. Add clarification on the equivalence of the properties in systemctl show and systemd-system.conf Fixed #21230
2021-11-09 22:06:01 +08:00
<command>systemctl show</command>
will show all available properties, most of which are derived or closely match the options described in
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Properties for units vary by unit type, so showing any
unit (even a non-existent one) is a way to list properties
pertaining to this type. Similarly, showing any job will list
properties pertaining to all jobs. Properties for units are
documented in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
and the pages for individual unit types
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
etc.</para>
</listitem>
</varlistentry>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
systemctl: add -P as short for --value --property=
2020-04-02 00:29:00 +08:00
<varlistentry>
<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>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-a</option></term>
<term><option>--all</option></term>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When listing units with <command>list-units</command>, also show inactive units and
units which are following other units. When showing unit/job/manager properties, show all
properties regardless whether they are set or not.</para>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>To list all units installed in the file system, use the
<command>list-unit-files</command> command instead.</para>
systemctl: Create new unit files with "edit --force" (#3584)
2016-06-24 14:00:35 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>When listing units with <command>list-dependencies</command>, recursively show
dependencies of all dependent units (by default only dependencies of target units are
shown).</para>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>When used with <command>status</command>, show journal messages in full, even if they include
unprintable characters or are very long. By default, fields with unprintable characters are
abbreviated as "blob data". (Note that the pager may escape unprintable characters again.)</para>
</listitem>
</varlistentry>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-r</option></term>
<term><option>--recursive</option></term>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When listing units, also show units of local
containers. Units of local containers will be prefixed with
the container name, separated by a single colon character
(<literal>:</literal>).</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--reverse</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Show reverse dependencies between units with
<command>list-dependencies</command>, i.e. follow
dependencies of type <varname>WantedBy=</varname>,
<varname>RequiredBy=</varname>,
<varname>PartOf=</varname>, <varname>BoundBy=</varname>,
instead of <varname>Wants=</varname> and similar.
</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--after</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>With <command>list-dependencies</command>, show the
units that are ordered before the specified unit. In other
words, recursively list units following the
<varname>After=</varname> dependency.</para>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Note that any <varname>After=</varname> dependency is
automatically mirrored to create a
<varname>Before=</varname> dependency. Temporal dependencies
may be specified explicitly, but are also created implicitly
for units which are <varname>WantedBy=</varname> targets
(see
<citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
and as a result of other directives (for example
<varname>RequiresMountsFor=</varname>). Both explicitly
and implicitly introduced dependencies are shown with
<command>list-dependencies</command>.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs are
waiting for it. May be combined with <option>--before</option> to show both the jobs waiting for each job as
well as all jobs each job is waiting for.</para>
</listitem>
</varlistentry>
systemctl: add new "list-machines" command "systemctl list-machines" shows one line per local container which includes the current system state of the container, the number of failed units as well as the number of currently queued jobs.
2014-03-13 04:13:58 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--before</option></term>
systemctl: add new "list-machines" command "systemctl list-machines" shows one line per local container which includes the current system state of the container, the number of failed units as well as the number of currently queued jobs.
2014-03-13 04:13:58 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>With <command>list-dependencies</command>, show the
units that are ordered after the specified unit. In other
words, recursively list units following the
<varname>Before=</varname> dependency.</para>
systemctl: add new "list-machines" command "systemctl list-machines" shows one line per local container which includes the current system state of the container, the number of failed units as well as the number of currently queued jobs.
2014-03-13 04:13:58 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs it
is waiting for. May be combined with <option>--after</option> to show both the jobs waiting for each job as
well as all jobs each job is waiting for.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
man: Document systemctl --with-dependencies switch
2019-12-09 17:40:47 +08:00
<varlistentry>
<term><option>--with-dependencies</option></term>
<listitem>
<para>When used with <command>status</command>,
<command>cat</command>, <command>list-units</command>, and
<command>list-unit-files</command>, those commands print all
specified units and the dependencies of those units.</para>
<para>Options <option>--reverse</option>,
<option>--after</option>, <option>--before</option>
may be used to change what types of dependencies
are shown.</para>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-l</option></term>
<term><option>--full</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Do not ellipsize unit names, process tree entries,
journal output, or truncate unit descriptions in the output
of <command>status</command>, <command>list-units</command>,
<command>list-jobs</command>, and
<command>list-timers</command>.</para>
<para>Also, show installation targets in the output of
<command>is-enabled</command>.</para>
</listitem>
</varlistentry>
systemctl: show waiting jobs when "systemctl list-jobs --after/--before" is called Let's expose the new bus functions we added in the previous commit in systemctl.
2016-11-16 23:44:05 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--value</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
systemctl: add -P as short for --value --property=
2020-04-02 00:29:00 +08:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--show-types</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When showing sockets, show the type of the socket.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--job-mode=</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>,
man: Document --job-mode=triggering switch
2019-11-01 16:47:37 +08:00
<literal>ignore-requirements</literal>,
<literal>flush</literal>, or
<literal>triggering</literal>. Defaults to
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<literal>replace</literal>, except when the
<command>isolate</command> command is used which implies the
<literal>isolate</literal> job mode.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
systemctl: introduce new "import-environment" command This may be used in graphical session start-up scripts to upload environment variables such as $DISPLAY into the systemd manager easily.
2014-01-15 15:21:29 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>If <literal>replace</literal> (the default) is
specified, any conflicting pending job will be replaced, as
necessary.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para><literal>flush</literal> will cause all queued jobs to
be canceled when the new job is enqueued.</para>
man: add systemd.generator(7) This is largely based on http://www.freedesktop.org/wiki/Software/systemd/Generators/, and obsoletes that page. It seems that we do a much better job of keeping man pages up-to-date compared to wiki pages. Man pages are also easier to find for users. https://bugs.freedesktop.org/show_bug.cgi?id=89048
2015-02-11 12:17:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
</listitem>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
man: Document --job-mode=triggering switch
2019-11-01 16:47:37 +08:00
<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>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-T</option></term>
<term><option>--show-transaction</option></term>
systemctl: add new "is-system-running" command to check whether system is fully up https://bugs.freedesktop.org/show_bug.cgi?id=66926
2014-06-25 18:31:03 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When enqueuing a unit job (for example as effect of a <command>systemctl start</command>
invocation or similar), show brief information about all jobs enqueued, covering both the requested
job and any added because of unit dependencies. Note that the output will only include jobs
immediately part of the transaction requested. It is possible that service start-up program code
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>
</listitem>
</varlistentry>
man: add table of manager states
2014-10-28 10:16:11 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--fail</option></term>
systemctl: add support for --wait to is-system-running This makes it possible to wait until boot is finished without having to poll for this command repeatedly, instead using the syntax: $ systemctl is-system-running --wait Waiting is implemented by waiting for the StartupFinished signal to be posted on the bus. Register the matcher before checking for the property to avoid race conditions. Tested by artificially delaying startup with a oneshot service and calling this command, checked that it emitted `running` and exited with a 0 return code as soon as the delay service completed startup. Also tested that booting to degraded state unblocks the command. Inserted a delay between getting the property and waiting for the signal and confirmed this seems to work free of race conditions. Updated the --help text (under --wait) and the man page to document the new feature.
2018-08-04 14:10:54 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Shorthand for <option>--job-mode=</option>fail.</para>
<para>When used with the <command>kill</command> command,
if no units were killed, the operation results in an error.
</para>
</listitem>
</varlistentry>
systemctl: add new "is-system-running" command to check whether system is fully up https://bugs.freedesktop.org/show_bug.cgi?id=66926
2014-06-25 18:31:03 +08:00
Added option --check-inhibitors for non-tty usage As described in #2680, systemctl did ignore inhibitors if it is not attached to a tty to allow scripts to ignore inhibitors automatically. This pull request preserves this behavior but allows scripts to explicit check inhibitors if required. The new parameter '--check-inhibitors=yes' enables this feature. The old parameter '-i'/'--ignore-inhibitors' was deprecated in favor of '--check-inhibitors=no', the default behaviour can be specified with '--check-inhibitors=auto'. The new parameter is also described in the documentations and shell completions found here.
2020-10-29 19:48:48 +08:00
<varlistentry>
<term><option>--check-inhibitors=</option></term>
<listitem>
man/systemctl: improve grammar in description of --check-inhibitors
2022-05-31 16:30:09 +08:00
<para>When system shutdown or sleep state is requested, this option controls checking of inhibitor
locks. It takes one of <literal>auto</literal>, <literal>yes</literal> or
Added option --check-inhibitors for non-tty usage As described in #2680, systemctl did ignore inhibitors if it is not attached to a tty to allow scripts to ignore inhibitors automatically. This pull request preserves this behavior but allows scripts to explicit check inhibitors if required. The new parameter '--check-inhibitors=yes' enables this feature. The old parameter '-i'/'--ignore-inhibitors' was deprecated in favor of '--check-inhibitors=no', the default behaviour can be specified with '--check-inhibitors=auto'. The new parameter is also described in the documentations and shell completions found here.
2020-10-29 19:48:48 +08:00
<literal>no</literal>. Defaults to <literal>auto</literal>, which will behave like
man/systemctl: improve grammar in description of --check-inhibitors
2022-05-31 16:30:09 +08:00
<literal>yes</literal> for interactive invocations (i.e. from a TTY) and <literal>no</literal> for
non-interactive invocations. <literal>yes</literal> lets the request respect inhibitor locks.
<literal>no</literal> lets the request ignore inhibitor locks.</para>
<para>Applications can establish inhibitor locks to prevent certain important operations (such as
CD burning) from being interrupted by system shutdown or sleep. Any user may take these locks and
privileged users may override these locks. If any locks are taken, shutdown and sleep state
requests will normally fail (unless privileged). However, if <literal>no</literal> is specified or
<literal>auto</literal> is specified on a non-interactive requests, the operation will be
attempted. If locks are present, the operation may require additional privileges.</para>
<para>Option <option>--force</option> provides another way to override inhibitors.</para>
Added option --check-inhibitors for non-tty usage As described in #2680, systemctl did ignore inhibitors if it is not attached to a tty to allow scripts to ignore inhibitors automatically. This pull request preserves this behavior but allows scripts to explicit check inhibitors if required. The new parameter '--check-inhibitors=yes' enables this feature. The old parameter '-i'/'--ignore-inhibitors' was deprecated in favor of '--check-inhibitors=no', the default behaviour can be specified with '--check-inhibitors=auto'. The new parameter is also described in the documentations and shell completions found here.
2020-10-29 19:48:48 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-i</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
Added option --check-inhibitors for non-tty usage As described in #2680, systemctl did ignore inhibitors if it is not attached to a tty to allow scripts to ignore inhibitors automatically. This pull request preserves this behavior but allows scripts to explicit check inhibitors if required. The new parameter '--check-inhibitors=yes' enables this feature. The old parameter '-i'/'--ignore-inhibitors' was deprecated in favor of '--check-inhibitors=no', the default behaviour can be specified with '--check-inhibitors=auto'. The new parameter is also described in the documentations and shell completions found here.
2020-10-29 19:48:48 +08:00
<para>Shortcut for <option>--check-inhibitors=no</option>.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
systemctl: add new "is-system-running" command to check whether system is fully up https://bugs.freedesktop.org/show_bug.cgi?id=66926
2014-06-25 18:31:03 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--dry-run</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Just print what would be done. Currently supported by verbs
<command>halt</command>, <command>poweroff</command>, <command>reboot</command>,
<command>kexec</command>, <command>suspend</command>, <command>hibernate</command>,
<command>hybrid-sleep</command>, <command>suspend-then-hibernate</command>,
<command>default</command>, <command>rescue</command>,
<command>emergency</command>, and <command>exit</command>.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Suppress printing of the results of various commands
and also the hints about truncated log lines. This does not
suppress output of commands for which the printed output is
the only result (like <command>show</command>). Errors are
always printed.</para>
</listitem>
</varlistentry>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
systemctl: allow suppress the warning of no install info using --no-warn In cases like packaging scripts, it might be desired to use enable/disable on units without install info. So, adding an option '--no-warn' to suppress the warning.
2022-11-27 21:18:44 +08:00
<varlistentry>
<term><option>--no-warn</option></term>
<listitem>
systemctl: suppress warning about missing /proc/ when --no-warn Follow-up for 0f958c8d4fc13ed1c1af928b2a7d91d31c7576eb. systemctl is called many times by dnf or so, and missing /proc/ is not a user's fault, but package manager's issue. With this commit, we can suppress the warning by updating rpm macros if necessary.
2022-12-07 12:59:01 +08:00
<para>Don't generate the warnings shown by default in the following cases:
<itemizedlist>
<listitem>
<para>when <command>systemctl</command> is invoked without procfs mounted on
<filename>/proc/</filename>,</para>
</listitem>
<listitem>
<para>when using <command>enable</command> or <command>disable</command> on units without
install information (i.e. don't have or have an empty [Install] section).</para>
</listitem>
</itemizedlist>
</para>
systemctl: allow suppress the warning of no install info using --no-warn In cases like packaging scripts, it might be desired to use enable/disable on units without install info. So, adding an option '--no-warn' to suppress the warning.
2022-11-27 21:18:44 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--no-block</option></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Do not synchronously wait for the requested operation
to finish. If this is not specified, the job will be
verified, enqueued and <command>systemctl</command> will
wait until the unit's start-up is completed. By passing this
argument, it is only verified and enqueued. This option may not be
combined with <option>--wait</option>.</para>
</listitem>
</varlistentry>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<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>is-system-running</command>, wait
until the boot process is completed before returning.</para>
</listitem>
</varlistentry>
<xi:include href="user-system-options.xml" xpointer="user" />
<xi:include href="user-system-options.xml" xpointer="system" />
<varlistentry>
<term><option>--failed</option></term>
<listitem>
<para>List units in failed state. This is equivalent to
<option>--state=failed</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-wall</option></term>
<listitem>
<para>Do not send wall message before halt, power-off and reboot.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--global</option></term>
<listitem>
<para>When used with <command>enable</command> and
<command>disable</command>, operate on the global user
configuration directory, thus enabling or disabling a unit
file globally for all future logins of all users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-reload</option></term>
<listitem>
<para>When used with <command>enable</command> and
<command>disable</command>, do not implicitly reload daemon
configuration after executing the changes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-ask-password</option></term>
<listitem>
<para>When used with <command>start</command> and related
commands, disables asking for passwords. Background services
may require input of a password or passphrase string, for
example to unlock system hard disks or cryptographic
certificates. Unless this option is specified and the
command is invoked from a terminal,
<command>systemctl</command> will query the user on the
terminal for the necessary secrets. Use this option to
switch this behavior off. In this case, the password must be
supplied by some other means (for example graphical password
agents) or the service might fail. This also disables
querying the user for authentication for privileged
operations.</para>
</listitem>
</varlistentry>
<varlistentry>
tree-wide: change --kill-who to --kill-whom getopt allows non-ambiguous abbreviations, so backwards-compat is maintained, and people can use --kill-who (or even shorter abbreviations). English is flexible, so in common speach people would use both forms, even if "whom" is technically more correct. The advantage of using the longer form in the code is that we effectively allow both forms, so we stop punishing people who DTGCT¹, but still allow people to use the spoken form if they prefer. 1. Do the gramatically correct thing
2022-08-24 16:41:30 +08:00
<term><option>--kill-whom=</option></term>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man: document new --kill-value= switch to systemctl
2023-02-16 23:20:48 +08:00
<para>When used with <command>kill</command>, choose which processes to send a UNIX process signal
to. Must be one of <option>main</option>, <option>control</option> or <option>all</option> to
select whether to kill only the main process, the control process or all processes of the unit. The
main process of the unit is the one that defines the life-time of it. A control process of a unit
is one that is invoked by the manager to induce state changes of it. For example, all processes
started due to the <varname>ExecStartPre=</varname>, <varname>ExecStop=</varname> or
<varname>ExecReload=</varname> settings of service units are control processes. Note that there is
only one control process per unit at a time, as only one state change is executed at a time. For
services of type <varname>Type=forking</varname>, the initial process started by the manager for
<varname>ExecStart=</varname> is a control process, while the process ultimately forked off by that
one is then considered the main process of the unit (if it can be determined). This is different
for service units of other types, where the process forked off by the manager for
<varname>ExecStart=</varname> is always the main process itself. A service unit consists of zero or
one main process, zero or one control process plus any number of additional processes. Not all unit
types manage processes of these types however. For example, for mount units, control processes are
defined (which are the invocations of <filename>&MOUNT_PATH;</filename> and
<filename>&UMOUNT_PATH;</filename>), but no main process is defined. If omitted, defaults to
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<option>all</option>.</para>
</listitem>
</varlistentry>
man: document new --kill-value= switch to systemctl
2023-02-16 23:20:48 +08:00
<varlistentry>
<term><option>--kill-value=</option><replaceable>INT</replaceable></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
POSIX Realtime Signals (i.e. <option>--signal=SIGRTMIN+…</option> or
<option>--signal=SIGRTMAX-…</option>), and ensures the signals are generated via the <citerefentry
project='man-pages'><refentrytitle>sigqueue</refentrytitle><manvolnum>3</manvolnum></citerefentry>
system call, rather than <citerefentry
project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>3</manvolnum></citerefentry>. The
specified value must be a 32bit signed integer, and may be specified either in decimal, in
tree-wide: fix typo
2023-02-22 13:46:19 +08:00
hexadecimal (if prefixed with <literal>0x</literal>), octal (if prefixed with <literal>0o</literal>)
man: document new --kill-value= switch to systemctl
2023-02-16 23:20:48 +08:00
or binary (if prefixed with <literal>0b</literal>)</para>
<para>If this option is used the signal will only be enqueued on the control or main process of the
unit, never on other processes belonging to the unit, i.e. <option>--kill-whom=all</option> will only
affect main and control processes but no other processes.</para></listitem>
</varlistentry>
systemctl,loginctl,machinectl: use a shared helper for arg_signal I seems frivolous to yet another two -util.[ch] files, but the helper should be in shared/ and it doesn't seem to fit anywhere else.
2021-02-13 22:55:10 +08:00
<xi:include href="standard-options.xml" xpointer="signal" />
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--what=</option></term>
<listitem>
<para>Select what type of per-unit resources to remove when the <command>clean</command> command is
invoked, see below. Takes one of <constant>configuration</constant>, <constant>state</constant>,
<constant>cache</constant>, <constant>logs</constant>, <constant>runtime</constant> to select the
type of resource. This option may be specified more than once, in which case all specified resource
types are removed. Also accepts the special value <constant>all</constant> as a shortcut for
Fix several typos in documentation Found by lintian
2019-12-24 20:50:04 +08:00
specifying all five resource types. If this option is not specified defaults to the combination of
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<constant>cache</constant> and <constant>runtime</constant>, i.e. the two kinds of resources that
are generally considered to be redundant and can be reconstructed on next invocation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<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>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--message=</option></term>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with <command>halt</command>, <command>poweroff</command> or <command>reboot</command>, set a
short message explaining the reason for the operation. The message will be logged together with the default
shutdown message.</para>
</listitem>
</varlistentry>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--now</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with <command>enable</command>, the units
will also be started. When used with <command>disable</command> or
<command>mask</command>, the units will also be stopped. The start
or stop operation is only carried out when the respective enable or
disable operation has been successful.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--root=</option></term>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with
<command>enable</command>/<command>disable</command>/<command>is-enabled</command>
(and related commands), use the specified root path when looking for unit
files. If this option is present, <command>systemctl</command> will operate on
the file system directly, instead of communicating with the <command>systemd</command>
daemon to carry out changes.</para>
</listitem>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
systemctl: add support for --image option All tools that support --root= should also learn --image= so that they can operate on disk images directly.
2022-09-07 18:53:09 +08:00
<varlistentry>
<term><option>--image=<replaceable>image</replaceable></option></term>
<listitem><para>Takes a path to a disk image file or block device node. If specified, all operations
are applied to file system in the indicated disk image. This option is similar to
<option>--root=</option>, but operates on file systems stored in disk images or block devices. The
disk image should either contain just a file system or a set of file systems within a GPT partition
tree-wide: BLS and DPS are now on uapi-group website
2022-11-14 16:44:39 +08:00
table, following the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
systemctl: add support for --image option All tools that support --root= should also learn --image= so that they can operate on disk images directly.
2022-09-07 18:53:09 +08:00
Specification</ulink>. For further information on supported disk images, see
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
switch of the same name.</para></listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--runtime</option></term>
man: document which special "systemctl" commands are synchronous and which asynchronous. This documents the status quo, clarifying when we are synchronous and when asynchronous by default and when --no-block is support to force asynchronous operation. See: #6479
2017-09-29 22:10:27 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with <command>enable</command>,
<command>disable</command>, <command>edit</command>,
(and related commands), make changes only temporarily, so
that they are lost on the next reboot. This will have the
effect that changes are not made in subdirectories of
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<filename>/etc/</filename> but in <filename>/run/</filename>,
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
with identical immediate effects, however, since the latter
is lost on reboot, the changes are lost too.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<para>Similarly, when used with
<command>set-property</command>, make changes only
temporarily, so that they are lost on the next
reboot.</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--preset-mode=</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>Takes one of <literal>full</literal> (the default),
<literal>enable-only</literal>,
<literal>disable-only</literal>. When used with the
<command>preset</command> or <command>preset-all</command>
commands, controls whether units shall be disabled and
enabled according to the preset rules, or only enabled, or
only disabled.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-n</option></term>
<term><option>--lines=</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<para>When used with <command>status</command>, controls the number of journal lines to show,
counting from the most recent ones. Takes a positive integer argument, or 0 to disable journal
output. Defaults to 10.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>-o</option></term>
<term><option>--output=</option></term>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with <command>status</command>, controls the
formatting of the journal entries that are shown. For the
available choices, see
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
Defaults to <literal>short</literal>.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--firmware-setup</option></term>
man: add systemctl suspend-then-hibernate (#10194) This commit tries to document the systemctl suspend-then-hibernate documentation in the systemctl(1) manpage. Fixes #10192.
2018-09-28 21:56:48 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<para>When used with the <command>reboot</command> command, indicate to the system's firmware to
reboot into the firmware setup interface. Note that this functionality is not available on all
systems.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: add systemctl suspend-then-hibernate (#10194) This commit tries to document the systemctl suspend-then-hibernate documentation in the systemctl(1) manpage. Fixes #10192.
2018-09-28 21:56:48 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
man: cross-advertize bootctl and systemctl boot loader support
2022-04-28 22:44:40 +08:00
<term><option>--boot-loader-menu=<replaceable>timeout</replaceable></option></term>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<para>When used with the <command>reboot</command> command, indicate to the system's boot loader to
show the boot loader menu on the following boot. Takes a time value as parameter — indicating the
menu timeout. Pass zero in order to disable the menu timeout. Note that not all boot loaders
support this functionality.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
man: explain the precise syntax and feature set of unit names at the end of the man page, given that it is detail information
2013-11-26 09:25:34 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
man: cross-advertize bootctl and systemctl boot loader support
2022-04-28 22:44:40 +08:00
<term><option>--boot-loader-entry=<replaceable>ID</replaceable></option></term>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
man/systemctl: rework descriptions of bind and mount-image The text used "unit's view" to mean mount namespace. But we talk about mount namespaces in the later part of the paragraph anyway, so trying to use an "approachable term" only makes the whole thing harder to understand. Let's use the precise term. Some paragraph-breaking and re-indentation is done too.
2021-07-27 15:42:09 +08:00
<para>When used with the <command>reboot</command> command, indicate to the system's boot loader to
boot into a specific boot loader entry on the following boot. Takes a boot loader entry identifier
as argument, or <literal>help</literal> in order to list available entries. Note that not all boot
loaders support this functionality.</para>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</listitem>
</varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
#15773 add --reboot-argument to systemctl reboot
2020-05-30 01:15:34 +08:00
<varlistentry>
<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>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<varlistentry>
<term><option>--plain</option></term>
man: explain the precise syntax and feature set of unit names at the end of the man page, given that it is detail information
2013-11-26 09:25:34 +08:00
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<listitem>
<para>When used with <command>list-dependencies</command>,
<command>list-units</command> or <command>list-machines</command>,
the output is printed as a list instead of a tree, and the bullet
circles are omitted.</para>
</listitem>
</varlistentry>
systemctl: add --timestamp to change timestamp print format Timestamps for unit start/stop are recorded with microsecond granularity, but status and show truncate to second granularity by default. Add a --timestamp=pretty|us|utc option to allow including the microseconds or to use the UTC TZ to all timestamps printed by systemctl.
2020-06-19 18:26:22 +08:00
<varlistentry>
<term><option>--timestamp=</option></term>
<listitem>
man: rework description of --timestamp Existing markup would be rendered improperly by groff. For #18397.
2021-01-29 02:37:28 +08:00
<para>Change the format of printed timestamps. The following values may be used:
</para>
<variablelist>
<varlistentry>
<term><option>pretty</option> (this is the default)</term>
<listitem><para><literal>Day YYYY-MM-DD HH:MM:SS TZ</literal></para></listitem>
</varlistentry>
</variablelist>
systemctl,man: update docs for `--timestamp=`
2022-02-21 20:14:18 +08:00
<variablelist>
<varlistentry>
<term><option>unix</option></term>
<listitem><para><literal>@seconds-since-the-epoch</literal></para></listitem>
</varlistentry>
</variablelist>
man: rework description of --timestamp Existing markup would be rendered improperly by groff. For #18397.
2021-01-29 02:37:28 +08:00
<variablelist>
<varlistentry>
<term><option>us</option></term>
<term><option>µs</option></term>
<listitem><para><literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ</literal></para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><option>utc</option></term>
<listitem><para><literal>Day YYYY-MM-DD HH:MM:SS UTC</literal></para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><option>us+utc</option></term>
<term><option>µs+utc</option></term>
<listitem><para><literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC</literal></para></listitem>
</varlistentry>
</variablelist>
systemctl: add --timestamp to change timestamp print format Timestamps for unit start/stop are recorded with microsecond granularity, but status and show truncate to second granularity by default. Add a --timestamp=pretty|us|utc option to allow including the microseconds or to use the UTC TZ to all timestamps printed by systemctl.
2020-06-19 18:26:22 +08:00
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
core: add DBUS method to bind mount new nodes without service restart Allow to setup new bind mounts for a service at runtime (via either DBUS or a new 'systemctl bind' verb) with a new helper that forks into the unit's mount namespace. Add a new integration test to cover this. Useful for zero-downtime addition to services that are running inside mount namespaces, especially when using RootImage/RootDirectory. If a service runs with a read-only root, a tmpfs is added on /run to ensure we can create the airlock directory for incoming mounts under /run/host/incoming.
2020-07-31 02:37:10 +08:00
<varlistentry>
<term><option>--mkdir</option></term>
<listitem><para>When used with <command>bind</command>, creates the destination file or directory before
applying the bind mount. Note that even though the name of this option suggests that it is suitable only for
directories, this option also creates the destination file node to mount over if the object to mount is not
a directory, but a regular file, device node, socket or FIFO.</para></listitem>
</varlistentry>
systemctl: add "reload-or-restart --marked" This is almost equivalent to 'busctl call-method org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager EnqueueMarkedJobs', but waits for the jobs to finish.
2021-02-05 20:54:33 +08:00
<varlistentry>
<term><option>--marked</option></term>
<listitem><para>Only allowed with <command>reload-or-restart</command>. Enqueues restart jobs for all
units that have the <literal>needs-restart</literal> mark, and reload jobs for units that have the
<literal>needs-reload</literal> mark. When a unit marked for reload does not support reload, restart
man: use the correct 'Markers' property name for marking units Follow-up to c9615f7352 and 70666e28a1.
2022-11-02 18:48:23 +08:00
will be queued. Those properties can be set using <command>set-property Markers=…</command>.</para>
systemctl: add "reload-or-restart --marked" This is almost equivalent to 'busctl call-method org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager EnqueueMarkedJobs', but waits for the jobs to finish.
2021-02-05 20:54:33 +08:00
<para>Unless <option>--no-block</option> is used, <command>systemctl</command> will wait for the
queued jobs to finish.</para></listitem>
</varlistentry>
core: add DBUS method to bind mount new nodes without service restart Allow to setup new bind mounts for a service at runtime (via either DBUS or a new 'systemctl bind' verb) with a new helper that forks into the unit's mount namespace. Add a new integration test to cover this. Useful for zero-downtime addition to services that are running inside mount namespaces, especially when using RootImage/RootDirectory. If a service runs with a read-only root, a tmpfs is added on /run to ensure we can create the airlock directory for incoming mounts under /run/host/incoming.
2020-07-31 02:37:10 +08:00
<varlistentry>
<term><option>--read-only</option></term>
<listitem><para>When used with <command>bind</command>, creates a read-only bind mount.</para></listitem>
</varlistentry>
systemctl: new option --drop-in for specifying drop-in filename Previously 'systemctl edit' would only operate on 'override.conf', but users may need more than that. Thus the new option '--drop-in' is added to allow users to specify the drop-in file name. Closes #25767
2022-12-17 21:07:32 +08:00
<varlistentry>
<term><option>--drop-in=</option></term>
<listitem>
<para>When used with <command>edit</command>, use the given drop-in file name instead of
<filename>override.conf</filename>.</para>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<xi:include href="user-system-options.xml" xpointer="host" />
<xi:include href="user-system-options.xml" xpointer="machine" />
<xi:include href="standard-options.xml" xpointer="no-pager" />
systemctl: hide legends with --quiet, allow overriding --no-legend is replaced by --legend=no. --quiet now implies --legend=no, but --legend=yes may be used to override that. --quiet controls hints and warnings and such, and --legend controls just the legends. I think it makes sense to allow both to controlled independently, in particular --quiet --legend makes sense when using systemctl in a script to provide some user-visible output. Fixes #18560.
2021-02-15 17:56:28 +08:00
<xi:include href="standard-options.xml" xpointer="legend" />
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
</refsect1>
<refsect1>
<title>Exit status</title>
man: add a description of systemctl return codes Fixes #10056.
2018-09-14 22:02:48 +08:00
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
<para><command>systemctl</command> uses the return codes defined by LSB, as defined in
<ulink url="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB 3.0.0</ulink>.
</para>
<table>
<title>LSB return codes</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Value</entry>
<entry>Description in LSB</entry>
<entry>Use in systemd</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>0</constant></entry>
<entry>"program is running or service is OK"</entry>
<entry>unit is active</entry>
</row>
<row>
<entry><constant>1</constant></entry>
<entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
<entry>unit <emphasis>not</emphasis> failed (used by <command>is-failed</command>)</entry>
</row>
<row>
<entry><constant>2</constant></entry>
<entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
<entry>unused</entry>
</row>
<row>
<entry><constant>3</constant></entry>
<entry>"program is not running"</entry>
<entry>unit is not active</entry>
</row>
<row>
<entry><constant>4</constant></entry>
<entry>"program or service status is unknown"</entry>
<entry>no such unit</entry>
</row>
</tbody>
</tgroup>
</table>
<para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
not rely on those return values but to look for specific unit states and substates instead.
</para>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
</refsect1>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
<refsect1>
<title>Environment</title>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>$SYSTEMD_EDITOR</varname></term>
<listitem><para>Editor to use when editing units; overrides
<varname>$EDITOR</varname> and <varname>$VISUAL</varname>. If neither
<varname>$SYSTEMD_EDITOR</varname> nor <varname>$EDITOR</varname> nor
<varname>$VISUAL</varname> are present or if it is set to an empty
string or if their execution failed, systemctl will try to execute well
known editors in this order:
systemctl: Use /usr/bin/editor if available If the EDITOR environment variable is not set, the Debian policy recommends to use the /usr/bin/editor program as default editor. This file is managed via the dpkg alternatives mechanism and typically used in Debian/Ubuntu and derivatives to configure the default editor. See section 11.4 of the Debian policy [1]. Therefor prefer /usr/bin/editor over specific editors if available. [1] https://www.debian.org/doc/debian-policy/ch-customized-programs.html
2015-06-03 20:00:59 +08:00
<citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: fix a bunch of links All hail linkchecker!
2015-03-14 10:22:39 +08:00
<citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
</para></listitem>
</varlistentry>
</variablelist>
man: describe various logging configuration variables Fixes #17484. This patch affects systemctl(1), as well as all man pages that include all of common-variables.xml, i.e. most of our command line tools.
2021-02-28 20:22:06 +08:00
<xi:include href="common-variables.xml" xpointer="log-level"/>
<xi:include href="common-variables.xml" xpointer="log-color"/>
<xi:include href="common-variables.xml" xpointer="log-time"/>
<xi:include href="common-variables.xml" xpointer="log-location"/>
<xi:include href="common-variables.xml" xpointer="log-target"/>
man: rename less-variables→common-variables Some are not about less, e.g. $SYSTEMD_URLIFY.
2021-02-28 19:18:25 +08:00
<xi:include href="common-variables.xml" xpointer="pager"/>
<xi:include href="common-variables.xml" xpointer="less"/>
<xi:include href="common-variables.xml" xpointer="lesscharset"/>
<xi:include href="common-variables.xml" xpointer="lesssecure"/>
<xi:include href="common-variables.xml" xpointer="colors"/>
<xi:include href="common-variables.xml" xpointer="urlify"/>
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
</refsect1>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
<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>,
man: remove references to systemadm from systemctl man page The tool is badly maintained and we shouldn't refence such old cruft.
2015-01-09 02:16:44 +08:00
<citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
man: fix name of systemd.resource-control(5)
2015-03-14 10:25:37 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
<citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
man: add a mapping for external manpages It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 06:25:54 +08:00
<citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
systemctl: add edit verb It helps editing units by either creating a drop-in file, like /etc/systemd/system/my.service.d/override.conf, or by copying the original unit from /usr/lib/systemd/ to /etc/systemd/ if the --full option is specified. It invokes an editor on temporary files related to the unit files and if the editor exited successfully, then it renames the temporary files to their original names (e.g. my.service or override.conf) and daemon-reload is invoked. If the temporary file is empty the modification is canceled. See https://bugzilla.redhat.com/show_bug.cgi?id=906824
2014-10-29 23:22:02 +08:00
<citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
man: add systemd.generator(7) This is largely based on http://www.freedesktop.org/wiki/Software/systemd/Generators/, and obsoletes that page. It seems that we do a much better job of keeping man pages up-to-date compared to wiki pages. Man pages are also easier to find for users. https://bugs.freedesktop.org/show_bug.cgi?id=89048
2015-02-11 12:17:59 +08:00
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
man: fix reference to glob manpage
2015-02-11 12:19:16 +08:00
<citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
man: prettify systemctl(1) - reindent with two spaces, otherwise everything is squeezed near the right margin, - mark only optional arguments as optional, - some typos, etc.
2013-02-17 05:28:21 +08:00
</para>
</refsect1>
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
</refentry>
Reference in New Issue Copy Permalink