X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=a1f170e43061d5f742b67449ef6868f7cd20f000;hp=906399c3bd1f2b720f92c5c9f8f787e5d09d1a53;hb=8d0e0ddda6501479eb69164687c83c1a7667b33a;hpb=21ac6ff143cc8bebfbd1818af28e8c6f82cd5265
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 906399c3b..a1f170e43 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -72,22 +72,6 @@ along with systemd; If not, see .
The following options are understood:
-
-
-
-
- Prints a short help
- text and exits.
-
-
-
-
-
-
- Prints a short version string and exits.
-
-
-
@@ -147,6 +131,18 @@ along with systemd; If not, see .
+
+
+
+
+
+ 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
+ (:).
+
+
+
@@ -161,12 +157,27 @@ along with systemd; If not, see .
+
+
+ With list-dependencies, show the
+ units that are ordered before the specified unit. In other
+ words, list the units that are in the After=
+ directive of the specified unit, have the specified unit in
+ their Before= directive, or are otherwise
+ implicit dependencies of the specified unit.
+
+
+
+
- Show which units are started after or before
- with list-dependencies, respectively.
-
+ With list-dependencies, show the
+ units that are ordered after the specified unit. In other
+ words, list the units that are in the Before=
+ directive of the specified unit, have the specified unit in
+ their After= directive, or otherwise depend
+ on the specified unit.
@@ -219,8 +230,10 @@ along with systemd; If not, see .
If replace-irreversibly is specified,
operate like replace, but also mark the new
jobs as irreversible. This prevents future conflicting
- transactions from replacing these jobs. The jobs can still be
- cancelled using the cancel command.
+ transactions from replacing these jobs (or even being enqueued
+ while the irreversible jobs are still pending). Irreversible
+ jobs can still be cancelled using the cancel
+ command.
isolate is only valid for start
operations and causes all other units to be stopped when the
@@ -275,6 +288,8 @@ along with systemd; If not, see .
snapshot,
is-active,
is-failed,
+ is-enabled,
+ is-system-running,
enable and
disable.
@@ -301,30 +316,8 @@ along with systemd; If not, see .
-
-
-
-
- Do not pipe output into a pager.
-
-
-
-
-
-
-
- Talk to the systemd system manager. (Default)
-
-
-
-
-
-
-
- Talk to the systemd manager of the calling
- user.
-
-
+
+
@@ -382,11 +375,36 @@ along with systemd; If not, see .
When used with kill, choose which
- processes to kill. Must be one of ,
- or to select
- whether to kill only the main process of the unit, the
- control process or all processes of the unit. If omitted,
- defaults to .
+ processes to send a signal to. Must be one of
+ , or
+ 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
+ ExecStartPre=,
+ ExecStop= or
+ ExecReload= 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
+ Type=forking, the initial process started
+ by the manager for ExecStart= 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 ExecStart= is always the main process
+ itself. A service unit consists of zero or one main process,
+ zero or one control process plus any number of additional
+ processes. Not all unit types manage processes of these
+ types however. For example, for mount units, control processes
+ are defined (which are the invocations of
+ /usr/bin/mount and
+ /usr/bin/umount), but no main process
+ is defined. If omitted, defaults to
+ .
@@ -421,7 +439,7 @@ along with systemd; If not, see .
safe option to request an immediate reboot. If
is specified twice for these
operations, they will be executed immediately without
- terminating any processes or umounting any file
+ terminating any processes or unmounting any file
systems. Warning: specifying twice
with any of these operations might result in data
loss.
@@ -461,26 +479,19 @@ along with systemd; If not, see .
-
-
+
- Execute the operation remotely. Specify a hostname, or
- username and hostname separated by @, to
- connect to. This will use SSH to talk to the remote systemd
- instance.
+ Takes one of full (the default),
+ enable-only,
+ disable-only. When used with the
+ preset or preset-all
+ commands, controls whether units shall be disabled and
+ enabled according to the preset rules, or only enabled, or
+ only disabled.
-
-
-
-
- Execute the operation on a local
- container. Specify a container name to connect
- to.
-
-
@@ -515,6 +526,12 @@ along with systemd; If not, see .
+
+
+
+
+
+
@@ -555,8 +572,7 @@ LISTEN UNIT ACTIVATES
[::]:22 sshd.socket sshd.service
kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
-5 sockets listed.
-
+5 sockets listed.
Note: because the addresses might contains spaces, this output
is not suitable for programmatic consumption.
@@ -592,7 +608,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
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
- instance name until the instance has been started. Therefore
+ instance name until the instance has been started. Therefore,
using glob patterns with start
has limited usefulness.
@@ -691,9 +707,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Send a signal to one or more processes of the
unit. Use to select which
- process to kill. Use to select
- the kill mode and to select the
- signal to send.
+ process to kill. Use to select
+ the signal to send.
@@ -701,21 +716,23 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Check whether any of the specified units are active
- (i.e. running). Returns an exit code 0 if at least one is
- active, or non-zero otherwise. Unless
- is specified, this will also print the current unit state to
- STDOUT.
+ (i.e. running). Returns an exit code
+ 0 if at least one is active, or
+ non-zero otherwise. Unless is
+ specified, this will also print the current unit state to
+ standard output.
is-failed PATTERN...
- Check whether any of the specified units are in a "failed" state.
- Returns an exit code 0 if at least one has failed, non-zero
- otherwise. Unless is specified, this
- will also print the current unit state to
- STDOUT.
+ Check whether any of the specified units are in a
+ "failed" state. Returns an exit code
+ 0 if at least one has failed,
+ non-zero otherwise. Unless is
+ specified, this will also print the current unit state to
+ standard output.
@@ -724,10 +741,11 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Show terse runtime status information about one or
more units, followed by most recent log data from the
- journal. If no units are specified, show all units (subject
- to limitations specified with ). If a PID
- is passed, show information about the unit the process
- belongs to.
+ journal. If no units are specified, show system status. If
+ combined with , also show the status of
+ all units (subject to limitations specified with
+ ). If a PID is passed, show information
+ about the unit the process belongs to.
This function is intended to generate human-readable
output. If you are looking for computer-parsable output,
@@ -1023,16 +1041,35 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
command line, to the defaults configured in the preset
policy files. This has the same effect as
disable or enable,
- depending how the unit is listed in the preset files. For
- more information on the preset policy format, see
+ depending how the unit is listed in the preset files.
+
+ Use to control
+ whether units shall be enabled and disabled, or only
+ enabled, or only disabled.
+
+ For more information on the preset policy format,
+ see
systemd.preset5.
For more information on the concept of presets, please
- consult the
- Preset
+ consult the Preset
document.
+
+ preset-all
+
+
+ Resets all installed unit files to the defaults
+ configured in the preset policy file (see above).
+
+ Use to control
+ whether units shall be enabled and disabled, or only
+ enabled, or only disabled.
+
+
+
mask NAME...
@@ -1045,7 +1082,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
activation of the unit, including manual activation. Use
this option with care. This honors the
option to only mask temporarily
- until the next reoobt of the system.
+ until the next reboot of the system.
@@ -1093,6 +1130,24 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ Machine Commands
+
+
+
+ list-machines PATTERN...
+
+
+ List the host and all running local containers with
+ their state. If one or more
+ PATTERNs are specified, only
+ containers matching one of them are shown.
+
+
+
+
+
+
Job Commands
@@ -1128,9 +1183,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Create a snapshot. If a snapshot name is specified,
the new snapshot will be named after it. If none is
- specified, an automatic snapshot name is generated. In either
- case, the snapshot name used is printed to STDOUT, unless
- is specified.
+ specified, an automatic snapshot name is generated. In
+ either case, the snapshot name used is printed to standard
+ output, unless is specified.
+
A snapshot refers to a saved state of the systemd
manager. It is implemented itself as a unit that is
@@ -1197,9 +1253,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Import all, one or more environment variables set on
the client into the systemd manager environment block. If
- 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
+ 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
are then imported into the manager's environment
block.
@@ -1245,6 +1301,20 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
System Commands
+
+ is-system-running
+
+
+ Checks whether the system is running. This returns
+ success when the system is fully up and running, meaning
+ not in startup, shutdown or maintainance mode. Failure is
+ returned otherwise. In addition, the current state is
+ printed in a short string to standard output. Use
+ to suppress output of this state
+ string.
+
+
+
default
@@ -1253,6 +1323,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
isolate default.target.
+
rescue
@@ -1406,7 +1477,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Parameter Syntax
- Unit ommands listed above take either a single unit name
+ Unit commands listed above take either a single unit name
(designated as NAME), or multiple
unit specifications (designated as
PATTERN...). In the first case, the
@@ -1430,7 +1501,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
# systemctl status dev-sda.device
# systemctl status home.mount
In the second case, shell-style globs will be matched against
- currently loaded units, and literal unit names, with or without
+ currently loaded units; literal unit names, with or without
a suffix, will be treated as in the first case. This means that
literal unit names always refer to exactly one unit, but globs
may match zero units and this is not considered an error.
@@ -1442,7 +1513,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
[] may be used. See
glob7
for more details. The patterns are matched against the names of
- currently loaded units, and patterns which don't match anything
+ currently loaded units, and patterns which do not match anything
are silently skipped. For example:
# systemctl stop sshd@*.service
will stop all sshd@.service instances.