diff options
author | Lennart Poettering <lennart@poettering.net> | 2021-10-28 10:45:02 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-11-10 15:01:30 +0100 |
commit | 37ade0494a2ca154b107b79766d45f242eacb1cf (patch) | |
tree | ef59d8750adfdb93af6f01b75c902480a60a4579 | |
parent | 1f332abc9f82c653d40e5f3e42b761dca88d31ed (diff) | |
download | systemd-37ade0494a2ca154b107b79766d45f242eacb1cf.tar.gz |
man: clarify the situation of unit templates regarding "systemctl list-units" + "systemctl list-unit-files"
Fixes: #21075
(cherry picked from commit 7ea5e82f6ac78704f1554be9040b84bac75c2ec1)
-rw-r--r-- | man/systemctl.xml | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/man/systemctl.xml b/man/systemctl.xml index 5a133dea75..b6be21ed87 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -65,6 +65,13 @@ that are shown are additionally filtered by <option>--type=</option> and <option>--state=</option> if those options are specified.</para> + <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> + <para>Produces output similar to <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION sys-module-fuse.device loaded active plugged /sys/module/fuse @@ -81,11 +88,11 @@ ACTIVE = The high-level unit activation state, i.e. generalization of SUB. SUB = The low-level unit activation state, values depend on unit type. 123 loaded units listed. Pass --all to see loaded but inactive units, too. -To show all installed unit files use 'systemctl list-unit-files'. - </programlisting> - 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> +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> <para>The LOAD column shows the load state, one of <constant>loaded</constant>, <constant>not-found</constant>, <constant>bad-setting</constant>, <constant>error</constant>, @@ -694,10 +701,13 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><command>list-unit-files</command> <optional><replaceable>PATTERN…</replaceable></optional></term> <listitem> - <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>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> </listitem> </varlistentry> |