mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-30 22:03:41 +08:00
Code Issues Packages Projects Releases Wiki Activity
64144440a5
systemd/man/systemctl.xml

1734 lines
72 KiB
XML
Raw Normal View History

man: add emacs header to get correct indention in nxml-mode for the manpage XML files that use 2ch indenting In the long run we really should figure out if we want to stick with 8ch or 2ch indenting, and not continue with half-and-half. For now, just make emacs aware of the files that use 2ch indenting.
2014-11-22 03:44:48 +08:00
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
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
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
<!--
man: boilerplate unification
2015-02-11 12:19:26 +08:00
This file is part of systemd.
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: boilerplate unification
2015-02-11 12:19:26 +08:00
Copyright 2010 Lennart Poettering
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: boilerplate unification
2015-02-11 12:19:26 +08:00
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: boilerplate unification
2015-02-11 12:19:26 +08:00
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
man: extend manual page documentation
2010-06-24 09:09:36 +08:00
man: boilerplate unification
2015-02-11 12:19:26 +08:00
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
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>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Lennart</firstname>
<surname>Poettering</surname>
<email>lennart@poettering.net</email>
</author>
</authorgroup>
</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>
<arg choice="opt" rep="repeat">NAME</arg>
</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>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-t</option></term>
<term><option>--type=</option></term>
<listitem>
man: improve grammar and word formatting in numerous man pages Use proper grammar, word usage, adjective hyphenation, commas, capitalization, spelling, etc. To improve readability, some run-on sentences or sentence fragments were revised. [zj: remove the space from 'file name', 'host name', and 'time zone'.]
2013-06-28 03:51:44 +08:00
<para>The argument should be a comma-separated list of unit
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
types such as <option>service</option> and
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
<option>socket</option>.
</para>
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
<para>If one of the arguments is a unit type, when listing
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
units, limit display to certain unit types. Otherwise, units
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
of all types will be shown.</para>
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
<para>As a special case, if one of the arguments is
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
<option>help</option>, a list of allowed values will be
printed and the program will exit.</para>
</listitem>
</varlistentry>
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
<varlistentry>
<term><option>--state=</option></term>
<listitem>
man: don't document systemctl --failed This effectively reverts 599b6322f19ec619ddc294d0e7880b669040cf66, which in turn partially reverted 4dc5b821ae737914499119e29811fc3346e3d97c. The --failed switch is not documented on purpose, since it is redundant due to --state=failed, which it predates. Due to that it's not documented in --help either. We generally try to avoid redundant interfaces, but if we need to keep them for compatibility we do so, however remove them from documentation to ensure they are not used in future. The man page is now changed to include a comment about the fact that --failed is not documented on purpose. Also, explicitly mention --state=failed as example for --state.
2014-11-10 21:44:35 +08:00
<para>The argument should be a comma-separated list of unit
LOAD, SUB, or ACTIVE states. When listing units, show only
those in specified states. Use <option>--state=failed</option>
to show only failed units.</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
</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
<varlistentry>
<term><option>-p</option></term>
<term><option>--property=</option></term>
<listitem>
man: clarify systemctl --property= documentation a bit
2013-03-01 02:55:48 +08:00
<para>When showing unit/job/manager properties with the
<command>show</command> command, limit display to certain
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
properties as specified as argument. If not specified, all
man: clarify systemctl --property= documentation a bit
2013-03-01 02:55:48 +08:00
set properties are shown. The argument should be a
Spelling fixes
2013-05-04 04:43:11 +08:00
comma-separated list of property names, such as
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<literal>MainPID</literal>. If specified more than once, all
systemctl: allow comma sepearted property lists
2013-02-17 06:20:28 +08:00
properties with the specified names are shown.</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
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option></term>
<term><option>--all</option></term>
<listitem>
systemctl: drop usage of "internally loaded modules" I wouldn't know what "internally" is supposed to mean hear, and we use this terminology in this context nowhere else, so let's drop this.
2013-04-18 08:10:44 +08:00
<para>When listing units, show all loaded units, regardless
of their state, including inactive units. When showing
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
unit/job/manager properties, show all properties regardless
whether they are set or not.</para>
systemctl: drop usage of "internally loaded modules" I wouldn't know what "internally" is supposed to mean hear, and we use this terminology in this context nowhere else, so let's drop this.
2013-04-18 08:10:44 +08:00
<para>To list all units installed on the system, use the
<command>list-unit-files</command> command 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
</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
<varlistentry>
<term><option>-r</option></term>
<term><option>--recursive</option></term>
<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>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
<varlistentry>
<term><option>--reverse</option></term>
<listitem>
<para>Show reverse dependencies between units with
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
<command>list-dependencies</command>, i.e. follow
dependencies of type <varname>WantedBy=</varname>,
<varname>RequiredBy=</varname>,
<varname>RequiredByOverrridable=</varname>,
<varname>PartOf=</varname>, <varname>BoundBy=</varname>,
instead of <varname>Wants=</varname> and similar.
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--after</option></term>
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
<listitem>
<para>With <command>list-dependencies</command>, show the
units that are ordered before the specified unit. In other
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
words, recursively list units following the
<varname>After=</varname> dependency.</para>
<para>Note that any <varname>After=</varname> dependency is
automatically mirrored to create a
<varname>Before=</varname> dependency. Temporal dependencies
man: Fix spelling
2014-12-31 00:41:38 +08:00
may be specified explicitly, but are also created implicitly
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
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: 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
</listitem>
</varlistentry>
<varlistentry>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +08:00
<term><option>--before</option></term>
<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
<para>With <command>list-dependencies</command>, show the
units that are ordered after the specified unit. In other
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
words, recursively list units following the
<varname>Before=</varname> dependency.</para>
systemctl: show reverse dependencies or before/after ordering Also update completion scripts a bit.
2013-04-24 11:49:46 +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
<varlistentry>
journalctl,loginctl,systemctl,systemd-cgls: add -l as alias for --full https://bugs.freedesktop.org/show_bug.cgi?id=65850
2013-06-17 17:36:35 +08:00
<term><option>-l</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
<term><option>--full</option></term>
<listitem>
man: update the list of commands influenced by --full http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=732798
2013-12-22 08:07:49 +08:00
<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>
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
</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
<varlistentry>
<term><option>--show-types</option></term>
<listitem>
<para>When showing sockets, show the type of the socket.</para>
</listitem>
</varlistentry>
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
<varlistentry>
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
<term><option>--job-mode=</option></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
<listitem>
man: grammar and wording improvements This is a recurring submission and includes corrections to: - missing words, preposition choice. - change of /lib to /usr/lib, because that is what most distros are using as the system-wide location for systemd/udev files.
2013-12-26 09:47:45 +08:00
<para>When queuing a new job, this option controls how to deal with
already queued jobs. It takes one of <literal>fail</literal>,
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
<literal>replace</literal>,
<literal>replace-irreversibly</literal>,
<literal>isolate</literal>,
<literal>ignore-dependencies</literal>,
<literal>ignore-requirements</literal> or
<literal>flush</literal>. Defaults to
<literal>replace</literal>, except when the
<command>isolate</command> command is used which implies the
<literal>isolate</literal> job mode.</para>
<para>If <literal>fail</literal> is specified and a requested
operation conflicts with a pending job (more specifically:
causes an already pending start job to be reversed into a stop
job or vice versa), cause the operation to fail.</para>
<para>If <literal>replace</literal> (the default) is
specified, any conflicting pending job will be replaced, as
necessary.</para>
<para>If <literal>replace-irreversibly</literal> is specified,
operate like <literal>replace</literal>, but also mark the new
jobs as irreversible. This prevents future conflicting
man: clarify the effect of replace-irreversibly on future conflicting jobs
2014-06-10 06:32:03 +08:00
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.</para>
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
<para><literal>isolate</literal> is only valid for start
operations and causes all other units to be stopped when the
specified unit is started. This mode is always used when the
<command>isolate</command> command is used.</para>
<para><literal>flush</literal> will cause all queued jobs to
be canceled when the new job is enqueued.</para>
<para>If <literal>ignore-dependencies</literal> is specified,
then all unit dependencies are ignored for this new job and
the operation is executed immediately. If passed, no required
units of the unit passed will be pulled in, and no ordering
dependencies will be honored. This is mostly a debugging and
rescue tool for the administrator and should not be used by
applications.</para>
<para><literal>ignore-requirements</literal> is similar to
man: improvements to comma placement This is a recurring submission and includes corrections to: comma placement.
2013-12-26 09:47:44 +08:00
<literal>ignore-dependencies</literal>, but only causes the
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
requirement dependencies to be ignored, the ordering
dependencies will still be honoured.</para>
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
</listitem>
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
</varlistentry>
<varlistentry>
<term><option>-i</option></term>
<term><option>--ignore-inhibitors</option></term>
<listitem>
<para>When system shutdown or a sleep state is requested,
ignore inhibitor locks. Applications can establish inhibitor
locks to avoid that certain important operations (such as CD
burning or suchlike) are interrupted by system shutdown or a
sleep state. 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
man: resolve word omissions This is a recurring submission and includes corrections to: word omissions and word class choice.
2013-12-26 09:47:43 +08:00
(regardless of whether privileged or not) and a list of active locks
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
is printed. However, if <option>--ignore-inhibitors</option>
is specified, the locks are ignored and not printed, and the
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
operation attempted anyway, possibly requiring additional
privileges.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
<para>Suppress output to standard output in
<command>snapshot</command>,
<command>is-active</command>,
<command>is-failed</command>,
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
<command>is-enabled</command>,
<command>is-system-running</command>,
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
<command>enable</command> and
<command>disable</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-block</option></term>
<listitem>
<para>Do not synchronously wait for the requested operation
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
to finish. If this is not specified, the job will be
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
verified, enqueued and <command>systemctl</command> will
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
wait until it is completed. By passing this argument, it is
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
only verified and enqueued.</para>
</listitem>
</varlistentry>
man: xinclude --user/--system
2014-02-14 03:40:40 +08:00
<xi:include href="user-system-options.xml" xpointer="user" />
<xi:include href="user-system-options.xml" xpointer="system" />
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: don't document systemctl --failed This effectively reverts 599b6322f19ec619ddc294d0e7880b669040cf66, which in turn partially reverted 4dc5b821ae737914499119e29811fc3346e3d97c. The --failed switch is not documented on purpose, since it is redundant due to --state=failed, which it predates. Due to that it's not documented in --help either. We generally try to avoid redundant interfaces, but if we need to keep them for compatibility we do so, however remove them from documentation to ensure they are not used in future. The man page is now changed to include a comment about the fact that --failed is not documented on purpose. Also, explicitly mention --state=failed as example for --state.
2014-11-10 21:44:35 +08:00
<!-- we do not document -failed here, as it has been made
redundant by -state=failed, which it predates. To keep
things simple we only document the new switch, while
keeping the old one around for compatibility only. -->
man: document --failed https://bugs.debian.org/767267
2014-11-08 07:11:53 +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
<varlistentry>
<term><option>--no-wall</option></term>
<listitem>
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<para>Do not send wall message before halt, power-off,
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
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
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
command is invoked from a terminal,
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
<command>systemctl</command> will query the user on the
terminal for the necessary secrets. Use this option to
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
switch this behavior off. In this case, the password must be
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
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>
<term><option>--kill-who=</option></term>
<listitem>
<para>When used with <command>kill</command>, choose which
systemctl: add more verbose explanation of --kill-who and what control/main processes are
2014-03-25 07:51:22 +08:00
processes to send a 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
doc: comma placement corrections and word order Set commas where there should be some. Some improvements to word order.
2014-05-08 07:28:45 +08:00
<varname>Type=forking</varname>, the initial process started
systemctl: add more verbose explanation of --kill-who and what control/main processes are
2014-03-25 07:51:22 +08:00
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
doc: comma placement corrections and word order Set commas where there should be some. Some improvements to word order.
2014-05-08 07:28:45 +08:00
itself. A service unit consists of zero or one main process,
zero or one control process plus any number of additional
systemctl: add more verbose explanation of --kill-who and what control/main processes are
2014-03-25 07:51:22 +08:00
processes. Not all unit types manage processes of these
doc: comma placement corrections and word order Set commas where there should be some. Some improvements to word order.
2014-05-08 07:28:45 +08:00
types however. For example, for mount units, control processes
systemctl: add more verbose explanation of --kill-who and what control/main processes are
2014-03-25 07:51:22 +08:00
are defined (which are the invocations of
<filename>/usr/bin/mount</filename> and
<filename>/usr/bin/umount</filename>), but no main process
is defined. If omitted, defaults to
<option>all</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
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<term><option>--signal=</option></term>
<listitem>
<para>When used with <command>kill</command>, choose which
signal to send to selected processes. Must be one of the
man: add more formatting markup
2013-06-30 00:09:14 +08:00
well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<constant>SIGSTOP</constant>. If omitted, defaults 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
<option>SIGTERM</option>.</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>halt</command>,
<command>poweroff</command>, <command>reboot</command> or
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<command>kexec</command>, execute the selected operation
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
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, they will be executed immediately without
Fix typos in systemctl manpage
2014-05-15 19:11:00 +08:00
terminating any processes or unmounting any file
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
systems. Warning: specifying <option>--force</option> twice
with any of these operations might result in data
loss.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--root=</option></term>
<listitem>
<para>When used with
<command>enable</command>/<command>disable</command>/<command>is-enabled</command>
(and related commands), use alternative root path when
looking for unit files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime</option></term>
<listitem>
man: document the new systemctl cgroup commands
2013-02-28 02:37:04 +08:00
<para>When used with <command>enable</command>,
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
<command>disable</command>, <command>edit</command>,
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
(and related commands), make changes only temporarily, so
man: document the new systemctl cgroup commands
2013-02-28 02:37:04 +08:00
that they are lost on the next reboot. This will have the
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
effect that changes are not made in subdirectories of
<filename>/etc</filename> but in <filename>/run</filename>,
with identical immediate effects, however, since the latter
is lost on reboot, the changes are lost too.</para>
man: document the new systemctl cgroup commands
2013-02-28 02:37:04 +08:00
man: resolve word omissions This is a recurring submission and includes corrections to: word omissions and word class choice.
2013-12-26 09:47:43 +08:00
<para>Similarly, when used with
man: wording and grammar updates This includes regularly-submitted corrections to comma setting and orthographical mishaps that appeared in man/ in recent commits.
2013-07-21 12:53:14 +08:00
<command>set-property</command>, make changes only
man: document the new systemctl cgroup commands
2013-02-28 02:37:04 +08:00
temporarily, so that they are lost on the next
reboot.</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
</listitem>
</varlistentry>
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
<varlistentry>
<term><option>--preset-mode=</option></term>
<listitem>
<para>Takes one of <literal>full</literal> (the default),
<literal>enable-only</literal>,
doc: grammatical corrections
2014-06-28 06:48:28 +08:00
<literal>disable-only</literal>. When used with the
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
<command>preset</command> or <command>preset-all</command>
doc: grammatical corrections
2014-06-28 06:48:28 +08:00
commands, controls whether units shall be disabled and
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
enabled according to the preset rules, 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
<varlistentry>
<term><option>-n</option></term>
<term><option>--lines=</option></term>
<listitem>
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<para>When used with <command>status</command>, controls the
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
number of journal lines to show, counting from the most
recent ones. Takes a positive integer argument. Defaults to
10.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option></term>
<term><option>--output=</option></term>
<listitem>
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<para>When used with <command>status</command>, controls the
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
formatting of the journal entries that are shown. For the
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
available choices, see
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>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
Defaults to <literal>short</literal>.</para>
</listitem>
</varlistentry>
systemctl: add --plain option to list-dependencies This patch adds more script-friendly output for list-dependencies.
2013-05-03 18:52:19 +08:00
<varlistentry>
<term><option>--plain</option></term>
<listitem>
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<para>When used with <command>list-dependencies</command>,
systemctl: add --plain option to list-dependencies This patch adds more script-friendly output for list-dependencies.
2013-05-03 18:52:19 +08:00
the output is printed as a list instead of a tree.</para>
</listitem>
</varlistentry>
man: xinclude --host/--machine As usual, those common options are pushed to the end.
2014-02-21 08:47:03 +08:00
<xi:include href="user-system-options.xml" xpointer="host" />
<xi:include href="user-system-options.xml" xpointer="machine" />
man: use one description of --no-legend
2015-01-20 10:43:35 +08:00
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
man: xinclude --help/--version/--no-pager
2014-02-14 03:33:51 +08:00
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
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
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<para>The following commands are understood:</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<refsect2>
<title>Unit 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
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<variablelist>
<varlistentry>
Help output spring cleaning Use [brackets] only for optional elements. Use <optional> in XML sources.
2013-12-08 21:16:59 +08:00
<term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></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>
<para>List known units (subject to limitations specified
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
with <option>-t</option>). If one or more
<replaceable>PATTERN</replaceable>s are specified, only
units matching one of them are shown.</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: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<para>This is the default command.</para>
</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>
Help output spring cleaning Use [brackets] only for optional elements. Use <optional> in XML sources.
2013-12-08 21:16:59 +08:00
<term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
man: grammar and wording improvements This is a recurring submission and includes corrections to: - missing words, preposition choice. - change of /lib to /usr/lib, because that is what most distros are using as the system-wide location for systemd/udev files.
2013-12-26 09:47:45 +08:00
<para>List socket units ordered by listening address.
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
If one or more <replaceable>PATTERN</replaceable>s are
specified, only socket units matching one of them are
shown. Produces output similar to
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<programlisting>
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
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: always place <programlisting> and </programlisting> in a line with actual sources, so that we don't get spurious newlines in the man page output
2014-02-14 22:56:19 +08:00
5 sockets listed.</programlisting>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
Note: because the addresses might contains spaces, this output
is not suitable for programmatic consumption.
</para>
<para>See also the options <option>--show-types</option>,
man: don't refer to undocumented option '--failed'
2014-11-10 21:54:57 +08:00
<option>--all</option>, and <option>--state=</option>.</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>
Help output spring cleaning Use [brackets] only for optional elements. Use <optional> in XML sources.
2013-12-08 21:16:59 +08:00
<term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
<listitem>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
<para>List timer units 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.
</para>
systemctl: add new "list-timers" command
2013-11-11 10:06:14 +08:00
<para>See also the options <option>--all</option> and
man: don't refer to undocumented option '--failed'
2014-11-10 21:54:57 +08:00
<option>--state=</option>.</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>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>start <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Start (activate) one or more units specified on the
command line.</para>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<para>Note that glob patterns operate on a list of currently
loaded units. Units which are not active and are not in a
failed state usually are not loaded, and would not be
matched by any pattern. In addition, in case of
instantiated units, systemd is often unaware of the
doc: update punctuation Resolve spotted issues related to missing or extraneous commas, dashes.
2014-02-17 10:37:13 +08:00
instance name until the instance has been started. Therefore,
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
using glob patterns with <command>start</command>
has limited usefulness.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Stop (deactivate) one or more units specified on the
command line.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +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
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
configuration file of a unit, use the
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<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>
<para>This command should not be confused with the
man: drop references to removed and obsolete 'systemctl load' command
2014-08-15 08:41:14 +08:00
<command>daemon-reload</command> command.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Restart one or more units specified on the command
line. If the units are not running yet, they will be
started.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Restart one or more units specified on the command
line if the units are running. This does nothing if units are not
running. Note that, for compatibility with Red Hat init
scripts, <command>condrestart</command> is equivalent to this
command.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Reload one or more units if they support it. If not,
restart them instead. If the units are not running yet, they
will be started.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Reload one or more units if they support it. If not,
restart them instead. This does nothing if the units are not
running. Note that, for compatibility with SysV init scripts,
<command>force-reload</command> is equivalent to this
command.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>isolate <replaceable>NAME</replaceable></command></term>
<listitem>
<para>Start the unit specified on the command line and its
man: update description of default extension for isolate
2014-11-29 04:27:56 +08:00
dependencies and stop all others. If a unit name with no
extension is given, an extension of
<literal>.target</literal> will be assumed.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<para>This is similar to changing the runlevel in a
traditional init system. The <command>isolate</command>
command will immediately stop processes that are not enabled
in the new unit, possibly including the graphical
environment or terminal you are currently using.</para>
<para>Note that this is allowed only on units where
<option>AllowIsolate=</option> is enabled. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Send a signal to one or more processes of the
unit. Use <option>--kill-who=</option> to select which
systemctl: --kill-mode is long long gone, don't mention it in the man page
2014-03-25 07:31:48 +08:00
process to kill. Use <option>--signal=</option> to select
the signal to send.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Check whether any of the specified units are active
man: replace STDOUT with standard output, etc. Actually 'STDOUT' is something that doesn't appear anywhere: in the stdlib we have 'stdin', and there's only the constant STDOUT_FILENO, so there's no reason to use capitals. When refering to code, STDOUT/STDOUT/STDERR are replaced with stdin/stdout/stderr, and in other places they are replaced with normal phrases like standard output, etc.
2014-02-15 11:00:06 +08:00
(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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
man: replace STDOUT with standard output, etc. Actually 'STDOUT' is something that doesn't appear anywhere: in the stdlib we have 'stdin', and there's only the constant STDOUT_FILENO, so there's no reason to use capitals. When refering to code, STDOUT/STDOUT/STDERR are replaced with stdin/stdout/stderr, and in other places they are replaced with normal phrases like standard output, etc.
2014-02-15 11:00:06 +08:00
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Show terse runtime status information about one or
more units, followed by most recent log data from the
systemctl: when "systemctl status" is called without arguments show a short overall system state Previously "systemctl status" without argument would print the status of all loaded units. This has now been moved to "systemctl status -a".
2014-03-13 06:33:46 +08:00
journal. If no units are specified, show system status. If
doc: comma placement corrections and word order Set commas where there should be some. Some improvements to word order.
2014-05-08 07:28:45 +08:00
combined with <option>--all</option>, also show the status of
systemctl: when "systemctl status" is called without arguments show a short overall system state Previously "systemctl status" without argument would print the status of all loaded units. This has now been moved to "systemctl status -a".
2014-03-13 06:33:46 +08:00
all units (subject to limitations specified with
<option>-t</option>). If a PID is passed, show information
about the unit the process belongs to.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<para>This function is intended to generate human-readable
man: mention --full and --lines in systemctl status http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=732798
2013-12-22 08:00:08 +08:00
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 changes
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: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Show properties of one or more units, jobs, or the
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
manager itself. If no argument is specified, properties of
the manager will be shown. If a unit name is specified,
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
properties of the unit is shown, and if a job id is
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
specified, properties of the job is shown. By default, empty
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
properties are suppressed. Use <option>--all</option> to
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
show those too. To select specific properties to show, use
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<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>
</listitem>
</varlistentry>
systemctl: add "systemctl cat"
2013-12-01 08:09:26 +08:00
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>cat <replaceable>PATTERN</replaceable>...</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>
systemctl: do not show SourcePath when FragmentPath cannot be found Those files can be in a completely deferent format and also arbitrarily long, and usually contain information about other stuff. If we ever add SourceLine= or SourceLines= in addition to SourcePath=, and can show the relevant information only, this commit can be reverted.
2013-12-01 11:29:33 +08:00
<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.</para>
systemctl: add "systemctl cat"
2013-12-01 08:09:26 +08:00
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
<listitem>
<para>Set the specified unit properties at runtime where
this is supported. This allows changing configuration
man: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening.
2013-09-27 06:05:07 +08:00
parameter properties such as resource control settings at
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
runtime. Not all properties may be changed at runtime, but
man: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening.
2013-09-27 06:05:07 +08:00
many resource control settings (primarily those in
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
may. The changes are applied instantly, and stored on disk
for future boots, unless <option>--runtime</option> is
man: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening.
2013-09-27 06:05:07 +08:00
passed, in which case the settings only apply until the
next reboot. The syntax of the property assignment follows
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
closely the syntax of assignments in unit files.</para>
<para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
<para>Note that this command allows changing multiple
properties at the same time, which is preferable over
setting them individually. Like unit file configuration
settings, assigning the empty list to list parameters will
reset the list.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<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>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +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 restarted or reset with this command.</para>
</listitem>
</varlistentry>
<varlistentry>
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
<term>
<command>list-dependencies</command>
<optional><replaceable>NAME</replaceable></optional>
</term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
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
<para>Shows units required and wanted by the specified
unit. This recursively lists units following the
<varname>Requires=</varname>,
<varname>RequiresOverridable=</varname>,
<varname>Requisite=</varname>,
<varname>RequisiteOverridable=</varname>,
<varname>Wants=</varname>, <varname>BindsTo=</varname>
dependencies. If no unit is specified,
<filename>default.target</filename> is implied.</para>
<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>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Unit File Commands</title>
<variablelist>
<varlistentry>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
<term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
<para>List installed unit files. If one or more
<replaceable>PATTERN</replaceable>s are specified, only
units whose filename (just the last component of the path)
matches one of them are shown.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>enable <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Enable one or more unit files or unit file instances,
as specified on the command line. This will create a number
of symlinks as encoded in the <literal>[Install]</literal>
sections of the unit files. After the symlinks have been
created, the systemd configuration is reloaded (in a way that
is equivalent to <command>daemon-reload</command>) 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, a separate <command>start</command> command must
be invoked for the unit. Also note that in case of instance
enablement, symlinks named the same as instances are created in
the install location, however they all point to the same
template unit file.</para>
<para>This command will print the actions executed. This
output may be suppressed by passing <option>--quiet</option>.
</para>
<para>Note that this operation creates only the suggested
symlinks for the units. 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 in the
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 to ensure the changes are taken into account.
</para>
<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>
<para>Depending on whether <option>--system</option>,
man: mention --runtime where appropriate https://bugzilla.redhat.com/show_bug.cgi?id=1009956
2013-09-20 07:41:35 +08:00
<option>--user</option>, <option>--runtime</option>,
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes…
2013-10-15 14:58:51 +08:00
or <option>--global</option> is specified, this enables the unit
man: mention --runtime where appropriate https://bugzilla.redhat.com/show_bug.cgi?id=1009956
2013-09-20 07:41:35 +08:00
for the system, for the calling user only, for only this boot of
the system, or for all future logins of all users, or only this
boot. Note that in the last case, no systemd daemon
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
configuration is reloaded.</para>
man/systemctl: document enable on masked units
2014-10-08 14:04:52 +08:00
<para>Using <command>enable</command> on masked units
results in an error.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>disable <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Disables one or more units. This removes all symlinks
to the specified unit files from the unit configuration
directory, and hence undoes the changes made by
<command>enable</command>. Note however that this removes
all symlinks to the unit files (i.e. including manual
additions), not just those actually created by
<command>enable</command>. This call implicitly reloads the
systemd daemon configuration after completing the disabling
of the units. Note that this command does not implicitly
stop the units that are being disabled. If this is desired,
an additional <command>stop</command> command should be
executed afterwards.</para>
<para>This command will print the actions executed. This
output may be suppressed by passing <option>--quiet</option>.
</para>
<para>This command honors <option>--system</option>,
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes…
2013-10-15 14:58:51 +08:00
<option>--user</option>, <option>--runtime</option> and
man: mention --runtime where appropriate https://bugzilla.redhat.com/show_bug.cgi?id=1009956
2013-09-20 07:41:35 +08:00
<option>--global</option> in a similar way as
<command>enable</command>.</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>
<term><command>reenable <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Reenable one or more unit files, 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 is enabled with to
the defaults configured in the <literal>[Install]</literal>
section of the unit file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>preset <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Reset 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>
<para>Use <option>--preset-mode=</option> to control
whether units shall be enabled and disabled, or only
enabled, or only disabled.</para>
<para>For more information on the preset policy format,
see
<citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For more information on the concept of presets, please
consult the <ulink
url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>preset-all</command></term>
<listitem>
<para>Resets all installed unit files to the defaults
configured in the preset policy file (see above).</para>
<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: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Checks whether any of the specified unit files are
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
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>.
</para>
<table>
<title>
<command>is-enabled</command> output
</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Printed string</entry>
<entry>Meaning</entry>
<entry>Return value</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>enabled</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>).</entry>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
<entry morerows='1'>0</entry>
</row>
<row>
<entry><literal>enabled-runtime</literal></entry>
</row>
<row>
<entry><literal>linked</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>).</entry>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
<entry morerows='1'>1</entry>
</row>
<row>
<entry><literal>linked-runtime</literal></entry>
</row>
<row>
<entry><literal>masked</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>).</entry>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
<entry morerows='1'>1</entry>
</row>
<row>
<entry><literal>masked-runtime</literal></entry>
</row>
<row>
<entry><literal>static</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry>Unit file is not enabled, and has no provisions for enabling in the <literal>[Install]</literal> section.</entry>
man: fix description of is-enabled returned value
2013-12-25 11:57:15 +08:00
<entry>0</entry>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
</row>
shared/install: when unit contains only Also=, report 'indirect' If a unit contains only Also=, with no Alias= or WantedBy=, it shouldn't be reported as static. New 'indirect' status shall be introduced. https://bugzilla.redhat.com/show_bug.cgi?id=864298
2014-11-08 04:21:05 +08:00
<row>
<entry><literal>indirect</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry>Unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the <literal>[Install]</literal> section, listing other unit files that might be enabled.</entry>
shared/install: when unit contains only Also=, report 'indirect' If a unit contains only Also=, with no Alias= or WantedBy=, it shouldn't be reported as static. New 'indirect' status shall be introduced. https://bugzilla.redhat.com/show_bug.cgi?id=864298
2014-11-08 04:21:05 +08:00
<entry>0</entry>
</row>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
<row>
<entry><literal>disabled</literal></entry>
man: improve documentation for "indirect" unit file state a bit Also, correct mentions of "units" instead of "unit files" in the table, and terminate all sentences with a full stop.
2014-11-11 03:16:16 +08:00
<entry>Unit file is not enabled.</entry>
man: document 'is-enabled' output https://bugzilla.redhat.com/show_bug.cgi?id=953077
2013-12-09 07:56:16 +08:00
<entry>1</entry>
</row>
</tbody>
</tgroup>
</table>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>mask <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Mask one or more unit files, as specified on the
command line. This will link these units 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
man/systemctl: document enable on masked units
2014-10-08 14:04:52 +08:00
activation of the unit, including enablement and manual
activation. Use this option with care. This honors the
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes…
2013-10-15 14:58:51 +08:00
<option>--runtime</option> option to only mask temporarily
Fix typos in systemctl manpage
2014-05-15 19:11:00 +08:00
until the next reboot of the system.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><command>unmask <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Unmask one or more unit files, as specified on the
command line. This will undo the effect of
<command>mask</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>link <replaceable>FILENAME</replaceable>...</command></term>
<listitem>
<para>Link a unit file that is not in the unit file search
paths into the unit file search path. This requires an
absolute path to a unit file. The effect of this can be
undone with <command>disable</command>. The effect of this
command is that a unit file is available for
<command>start</command> and other commands although it
is not installed directly in the unit search path.</para>
</listitem>
</varlistentry>
<varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<term><command>add-wants <replaceable>TARGET</replaceable>
<replaceable>NAME</replaceable>...</command></term>
<term><command>add-requires <replaceable>TARGET</replaceable>
<replaceable>NAME</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<para>Adds <literal>Wants=</literal> resp. <literal>Requires=</literal>
dependency to the specified <replaceable>TARGET</replaceable> for
one or more units. </para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<para>This command honors <option>--system</option>,
<option>--user</option>, <option>--runtime</option> and
<option>--global</option> in a similar way as
<command>enable</command>.</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</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
<varlistentry>
<term><command>edit <replaceable>NAME</replaceable>...</command></term>
<listitem>
<para>Edit a drop-in snippet or a whole replacement file if
<option>--full</option> is specified, to extend or override the
specified unit.</para>
<para>Depending on whether <option>--system</option> (the default),
<option>--user</option>, or <option>--global</option> is specified,
this creates a drop-in file for each unit either for the system,
for the calling user or for all futures logins of all users. Then,
the editor (see the "Environment" section below) is invoked on
temporary files which will be written to the real location if the
editor exits successfully.</para>
<para>If <option>--full</option> is specified, this will copy the
original units instead of creating drop-in files.</para>
<para>If <option>--runtime</option> is specified, the changes will
be made temporarily in <filename>/run</filename> and they will be
lost on the next reboot.</para>
<para>If the temporary file is empty upon exit the modification of
the related unit is canceled</para>
<para>After the units have been edited, systemd configuration is
reloaded (in a way that is equivalent to <command>daemon-reload</command>).
</para>
<para>Note that this command cannot be used to remotely edit units
and that you cannot temporarily edit units which are in
<filename>/etc</filename> since they take precedence over
<filename>/run</filename>.</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<varlistentry>
<term><command>get-default</command></term>
<listitem>
<para>Return the default target to boot into. This returns
the target unit name <filename>default.target</filename>
is aliased (symlinked) to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>set-default <replaceable>NAME</replaceable></command></term>
<listitem>
<para>Set the default target to boot into. This sets
(symlinks) the <filename>default.target</filename> alias
to the given target unit.</para>
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</variablelist>
</refsect2>
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
<refsect2>
<title>Machine Commands</title>
<variablelist>
<varlistentry>
<term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
<listitem>
<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>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<refsect2>
<title>Job Commands</title>
<variablelist>
<varlistentry>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +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>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +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
</listitem>
</varlistentry>
<varlistentry>
<term><command>cancel <replaceable>JOB</replaceable>...</command></term>
<listitem>
<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>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Snapshot Commands</title>
<variablelist>
<varlistentry>
systemctl: allow globbing in list-<whatever> commands It is nicer to say 'systemctl list-units ssh\*' then to use grep, because colouring is preserved and it is easier to match just against the unit name.
2013-12-07 10:29:55 +08:00
<term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Create a snapshot. If a snapshot name is specified,
the new snapshot will be named after it. If none is
man: replace STDOUT with standard output, etc. Actually 'STDOUT' is something that doesn't appear anywhere: in the stdlib we have 'stdin', and there's only the constant STDOUT_FILENO, so there's no reason to use capitals. When refering to code, STDOUT/STDOUT/STDERR are replaced with stdin/stdout/stderr, and in other places they are replaced with normal phrases like standard output, etc.
2014-02-15 11:00:06 +08:00
specified, an automatic snapshot name is generated. In
either case, the snapshot name used is printed to standard
output, unless <option>--quiet</option> is specified.
</para>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<para>A snapshot refers to a saved state of the systemd
manager. It is implemented itself as a unit that is
generated dynamically with this command and has dependencies
on all units active at the time. At a later time, the user
may return to this state by using the
<command>isolate</command> command on the snapshot unit.
</para>
<para>Snapshots are only useful for saving and restoring
which units are running or are stopped, they do not
save/restore any other state. Snapshots are dynamic and lost
on reboot.</para>
</listitem>
</varlistentry>
<varlistentry>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
<term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Remove a snapshot previously created with
<command>snapshot</command>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Environment Commands</title>
<variablelist>
<varlistentry>
<term><command>show-environment</command></term>
<listitem>
<para>Dump the systemd manager environment block. The
environment block will be dumped in straight-forward form
suitable for sourcing into a shell script. This environment
block will be passed to all processes the manager
spawns.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
<listitem>
<para>Set one or more systemd manager environment variables,
as specified on the command line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
<listitem>
<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>
</listitem>
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
</varlistentry>
<varlistentry>
systemctl: fix import-environment description, trim help to 80 cols
2015-01-20 02:55:44 +08:00
<term>
man: boilerplate unification
2015-02-11 12:19:26 +08:00
<command>import-environment</command>
<optional><replaceable>VARIABLE...</replaceable></optional>
</term>
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
<listitem>
<para>Import all, one or more environment variables set on
the client into the systemd manager environment block. If
doc: update punctuation Resolve spotted issues related to missing or extraneous commas, dashes.
2014-02-17 10:37:13 +08:00
no arguments are passed, the entire environment block is
imported. Otherwise, a list of one or more environment
variable names should be passed, whose client-side values
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
are then imported into the manager's environment
block.</para>
</listitem>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Manager Lifecycle Commands</title>
<variablelist>
<varlistentry>
<term><command>daemon-reload</command></term>
<listitem>
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
<para>Reload 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>
<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>
<varlistentry>
<term><command>daemon-reexec</command></term>
<listitem>
<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
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
debugging and package upgrades. Sometimes, it might be
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
helpful as a heavy-weight <command>daemon-reload</command>.
man: wording and grammar updates This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
2013-09-13 03:12:49 +08:00
While the daemon is being reexecuted, all sockets systemd listening
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
on behalf of user configuration will stay accessible.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>System Commands</title>
<variablelist>
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
<varlistentry>
<term><command>is-system-running</command></term>
<listitem>
man: add table of manager states
2014-10-28 10:16:11 +08:00
<para>Checks whether the system is operational. This
returns success when the system is fully up and running,
meaning not in startup, shutdown or maintenance
mode. Failure is returned otherwise. In addition, the
current state is printed in a short string to standard
output, see table below. Use <option>--quiet</option> to
suppress this output.</para>
<table>
<title>Manager Operational States</title>
<tgroup cols='2'>
<colspec colname='name' />
<colspec colname='description' />
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><varname>initializing</varname></entry>
<entry><para>Early bootup, before
man: minor corrections on how the overall system states are actually defined
2014-10-28 21:38:47 +08:00
<filename>basic.target</filename> is reached
or the <varname>maintenance</varname> state entered.
man: add table of manager states
2014-10-28 10:16:11 +08:00
</para></entry>
</row>
<row>
<entry><varname>starting</varname></entry>
man: minor corrections on how the overall system states are actually defined
2014-10-28 21:38:47 +08:00
<entry><para>Late bootup, before the job queue
becomes idle for the first time, or one of the
rescue targets are reached.</para></entry>
man: add table of manager states
2014-10-28 10:16:11 +08:00
</row>
<row>
<entry><varname>running</varname></entry>
<entry><para>The system is fully
operational.</para></entry>
</row>
<row>
<entry><varname>degraded</varname></entry>
<entry><para>The system is operational but one or more
units failed.</para></entry>
</row>
<row>
<entry><varname>maintenance</varname></entry>
man: minor corrections on how the overall system states are actually defined
2014-10-28 21:38:47 +08:00
<entry><para>The rescue or emergency target is
man: add table of manager states
2014-10-28 10:16:11 +08:00
active.</para></entry>
</row>
<row>
<entry><varname>stopping</varname></entry>
<entry><para>The manager is shutting
down.</para></entry>
</row>
</tbody>
</tgroup>
</table>
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
</listitem>
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>default</command></term>
<listitem>
<para>Enter default mode. This is mostly equivalent to
<command>isolate default.target</command>.</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
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>rescue</command></term>
<listitem>
<para>Enter rescue mode. This is mostly equivalent to
<command>isolate rescue.target</command>, but also prints a
wall message to all users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>emergency</command></term>
<listitem>
<para>Enter emergency mode. This is mostly equivalent to
<command>isolate emergency.target</command>, but also prints
a wall message to all users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>halt</command></term>
<listitem>
<para>Shut down and halt the system. This is mostly equivalent to
<command>start halt.target --irreversible</command>, but also
prints a wall message to all users. 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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>poweroff</command></term>
<listitem>
<para>Shut down and power-off the system. This is mostly
equivalent to <command>start poweroff.target --irreversible</command>,
but also prints a wall message to all users. 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.</para>
</listitem>
</varlistentry>
<varlistentry>
Support additional argument in reboot reboot syscall can be performed with an additional argument. In some systems this functionality can be useful to modify the mode of the next boot performed by the bootloader.
2013-11-06 16:02:41 +08:00
<term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<listitem>
<para>Shut down and reboot the system. This is mostly
equivalent to <command>start reboot.target --irreversible</command>,
but also prints a wall message to all users. 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.</para>
Support additional argument in reboot reboot syscall can be performed with an additional argument. In some systems this functionality can be useful to modify the mode of the next boot performed by the bootloader.
2013-11-06 16:02:41 +08:00
<para>If the optional argument
<replaceable>arg</replaceable> is given, it will be passed
as the optional argument to the
<citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
system call. 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>
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
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>kexec</command></term>
<listitem>
<para>Shut down and reboot the system via kexec. This is
mostly equivalent to <command>start kexec.target --irreversible</command>,
but also prints a wall message to all users. 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: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>exit</command></term>
<listitem>
<para>Ask the systemd manager to quit. This is only
supported for user service managers (i.e. in conjunction
with the <option>--user</option> option) and will fail
otherwise.</para>
</listitem>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
</varlistentry>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
<varlistentry>
<term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
<listitem>
<para>Switches to a different root directory and executes a
new system manager process below it. This is intended for
usage in initial RAM disks ("initrd"), and will transition
from the initrd's system manager process (a.k.a "init"
process) to the main system manager process. 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 or
equal to the empty string, 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.</para>
</listitem>
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>suspend</command></term>
<listitem>
<para>Suspend the system. This will trigger activation of
the special <filename>suspend.target</filename> target.
</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>hibernate</command></term>
<listitem>
<para>Hibernate the system. This will trigger activation of
the special <filename>hibernate.target</filename> target.
</para>
</listitem>
</varlistentry>
man: bring systemctl man page and --help text into the same order
2015-01-09 01:08:40 +08:00
man: split systemctl commands to sections
2013-08-28 21:46:59 +08:00
<varlistentry>
<term><command>hybrid-sleep</command></term>
<listitem>
<para>Hibernate and suspend the system. This will trigger
activation of the special
<filename>hybrid-sleep.target</filename> target.</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
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
<refsect2>
<title>Parameter Syntax</title>
Fix typos in systemctl manpage
2014-05-15 19:11:00 +08:00
<para>Unit commands listed above take either a single unit name
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
(designated as <replaceable>NAME</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, 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
man: update description of default extension for isolate
2014-11-29 04:27:56 +08:00
<programlisting># systemctl isolate default</programlisting>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
and
man: update description of default extension for isolate
2014-11-29 04:27:56 +08:00
<programlisting># systemctl isolate default.target</programlisting>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
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
doc: update punctuation Resolve spotted issues related to missing or extraneous commas, dashes.
2014-02-17 10:37:13 +08:00
currently loaded units; literal unit names, with or without
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
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>
<para>Glob patterns use
man: fix reference to glob manpage
2015-02-11 12:19:16 +08:00
<citerefentry project='man-pages'><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
so normal shell-style globbing rules are used, and
<literal>*</literal>, <literal>?</literal>,
<literal>[]</literal> may be used. See
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>
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
for more details. The patterns are matched against the names of
doc: resolve missing/extraneous words or inappropriate forms Issues fixed: * missing words required by grammar * duplicated or extraneous words * inappropriate forms (e.g. singular/plural), and declinations * orthographic misspellings
2014-02-17 10:37:18 +08:00
currently loaded units, and patterns which do not match anything
systemctl: allow globbing in commands which take multiple unit names
2013-12-26 07:10:18 +08:00
are silently skipped. For example:
<programlisting># systemctl stop sshd@*.service</programlisting>
will stop all <filename>sshd@.service</filename> instances.
</para>
<para>For unit file commands, the specified
<replaceable>NAME</replaceable> should be the full name of the
unit file, or the absolute path to the unit file:
<programlisting># systemctl enable foo.service</programlisting>
or
<programlisting># systemctl link /path/to/foo.service</programlisting>
</para>
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
</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
</refsect1>
<refsect1>
<title>Exit status</title>
man: wording and grammar updates
2013-07-09 00:19:02 +08:00
<para>On success, 0 is returned, a non-zero failure
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
code otherwise.</para>
</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:
<citerefentry><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
</variablelist>
<xi:include href="less-variables.xml" xpointer="pager"/>
<xi:include href="less-variables.xml" xpointer="less"/>
</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: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening.
2013-09-27 06:05:07 +08:00
<citerefentry><refentrytitle>systemd.resource-management</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