X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemctl.xml;h=d1991e0f97ad4266fb0fb709b55e62a7c2278a55;hb=b7307642391c8ebb9724c99e6b33239e2c0ff944;hp=db7798d26e120f0f4d5e3aaad357bdc5d0998e43;hpb=d0a3fb7556d77c44c2bc38a560e99d4ad0abcf33;p=elogind.git
diff --git a/man/systemctl.xml b/man/systemctl.xml
index db7798d26..d1991e0f9 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -1,4 +1,4 @@
-
+
@@ -60,10 +60,12 @@ along with systemd; If not, see .
Description
- systemctl may be used to
- introspect and control the state of the
+ systemctl may be used to introspect and
+ control the state of the systemd system and
+ service manager. Please refer to
systemd1
- system and service manager.
+ for an introduction into the basic concepts and functionality this
+ tool manages.
@@ -96,9 +98,10 @@ along with systemd; If not, see .
- The argument should be a comma-separated list of unit LOAD,
- SUB, or ACTIVE states. When listing units, show only those
- in specified states.
+ 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
+ to show only failed units.
@@ -148,9 +151,12 @@ along with systemd; If not, see .
Show reverse dependencies between units with
- list-dependencies, i.e. units with
- dependencies of type Wants= or
- Requires= on the given unit.
+ list-dependencies, i.e. follow
+ dependencies of type WantedBy=,
+ RequiredBy=,
+ RequiredByOverrridable=,
+ PartOf=, BoundBy=,
+ instead of Wants= and similar.
@@ -161,10 +167,20 @@ 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.
+ words, recursively list units following the
+ After= dependency.
+
+ Note that any After= dependency is
+ automatically mirrored to create a
+ Before= dependency. Temporal dependencies
+ may be specified explictly, but are also created implicitly
+ for units which are WantedBy= targets
+ (see
+ systemd.target5),
+ and as a result of other directives (for example
+ RequiresMountsFor=). Both explicitly
+ and implicitly introduced dependencies are shown with
+ list-dependencies.
@@ -174,10 +190,8 @@ along with systemd; If not, see .
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.
+ words, recursively list units following the
+ Before= dependency.
@@ -319,6 +333,11 @@ along with systemd; If not, see .
+
+
@@ -463,7 +482,7 @@ along with systemd; If not, see .
When used with enable,
- disable,
+ disable, edit,
(and related commands), make changes only temporarily, so
that they are lost on the next reboot. This will have the
effect that changes are not made in subdirectories of
@@ -578,7 +597,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
See also the options ,
- , and .
+ , and .
@@ -592,7 +611,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
See also the options and
- .
+ .
@@ -686,7 +705,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
Start the unit specified on the command line and its
- dependencies and stop all others.
+ dependencies and stop all others. If a unit name with no
+ extension is given, an extension of
+ .target will be assumed.
This is similar to changing the runlevel in a
traditional init system. The isolate
@@ -840,15 +861,30 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- list-dependencies NAME
+
+ list-dependencies
+ NAME
+
- Shows required and wanted units of the specified
- unit. If no unit is specified,
- default.target is implied. Target units
- are recursively expanded. When is
- passed, all other units are recursively expanded as
- well.
+ Shows units required and wanted by the specified
+ unit. This recursively lists units following the
+ Requires=,
+ RequiresOverridable=,
+ Requisite=,
+ RequisiteOverridable=,
+ Wants=, BindsTo=
+ dependencies. If no unit is specified,
+ default.target is implied.
+
+ By default, only target units are recursively
+ expanded. When is passed, all other
+ units are recursively expanded as well.
+
+ Options ,
+ ,
+ may be used to change what types of dependencies
+ are shown.
@@ -922,6 +958,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
the system, or for all future logins of all users, or only this
boot. Note that in the last case, no systemd daemon
configuration is reloaded.
+
+ Using enable on masked units
+ results in an error.
@@ -980,7 +1019,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
enabled
- Enabled through a symlink in .wants directory (permanently or just in /run)
+ Enabled through a symlink in .wants directory (permanently or just in /run).0
@@ -988,7 +1027,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
linked
- Made available through a symlink to the unit file (permanently or just in /run)
+ Made available through a symlink to the unit file (permanently or just in /run).1
@@ -996,7 +1035,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
masked
- Disabled entirely (permanently or just in /run)
+ Disabled entirely (permanently or just in /run).1
@@ -1004,12 +1043,17 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
static
- Unit is not enabled, but has no provisions for enabling in [Install] section
+ Unit file is not enabled, and has no provisions for enabling in the [Install] section.
+ 0
+
+
+ indirect
+ Unit file itself is not enabled, but it has a non-empty Also= setting in the [Install] section, listing other unit files that might be enabled.0disabled
- Unit is not enabled
+ Unit file is not enabled.1
@@ -1078,8 +1122,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
/dev/null, making it impossible to
start them. This is a stronger version of
disable, since it prohibits all kinds of
- activation of the unit, including manual activation. Use
- this option with care. This honors the
+ activation of the unit, including enablement and manual
+ activation. Use this option with care. This honors the
option to only mask temporarily
until the next reboot of the system.
@@ -1095,6 +1139,25 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ add-wants TARGET
+ NAME...
+ add-requires TARGET
+ NAME...
+
+
+ Adds Wants= resp. Requires=
+ dependency to the specified TARGET for
+ one or more units.
+
+ This command honors ,
+ , and
+ in a similar way as
+ enable.
+
+
+
+
link FILENAME...
@@ -1126,6 +1189,43 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
default.target to the given unit.
+
+
+ edit NAME...
+
+
+ Edit a drop-in snippet or a whole replacement file if
+ is specified, to extend or override the
+ specified unit.
+
+ Depending on whether (the default),
+ , or 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.
+
+ If is specified, this will copy the
+ original units instead of creating drop-in files.
+
+ If is specified, the changes will
+ be made temporarily in /run and they will be
+ lost on the next reboot.
+
+ If the temporary file is empty upon exit the modification of
+ the related unit is canceled
+
+ After the units have been edited, systemd configuration is
+ reloaded (in a way that is equivalent to daemon-reload).
+
+
+ Note that this command cannot be used to remotely edit units
+ and that you cannot temporarily edit units which are in
+ /etc since they take precedence over
+ /run.
+
+
@@ -1303,13 +1403,62 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
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.
+ 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 to
+ suppress this output.
+
+
+ Manager Operational States
+
+
+
+
+
+ Name
+ Description
+
+
+
+
+ initializing
+ Early bootup, before
+ basic.target is reached
+ or the maintenance state entered.
+
+
+
+ starting
+ Late bootup, before the job queue
+ becomes idle for the first time, or one of the
+ rescue targets are reached.
+
+
+ running
+ The system is fully
+ operational.
+
+
+ degraded
+ The system is operational but one or more
+ units failed.
+
+
+ maintenance
+ The rescue or emergency target is
+ active.
+
+
+ stopping
+ The manager is shutting
+ down.
+
+
+
+
@@ -1487,9 +1636,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
# systemctl start sshd and
# systemctl start sshd.service
are equivalent, as are
- # systemctl isolate snapshot-11
+ # systemctl isolate default
and
- # systemctl isolate snapshot-11.snapshot
+ # systemctl isolate default.target
Note that (absolute) paths to device nodes are automatically
converted to device unit names, and other (absolute) paths to
mount unit names.
@@ -1535,7 +1684,28 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
code otherwise.
-
+
+ Environment
+
+
+
+ $SYSTEMD_EDITOR
+
+ Editor to use when editing units; overrides
+ $EDITOR and $VISUAL. If neither
+ $SYSTEMD_EDITOR nor $EDITOR nor
+ $VISUAL 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:
+ nano1,
+ vim1,
+ vi1.
+
+
+
+
+
+ See Also
@@ -1548,7 +1718,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
systemd.resource-management5,
systemd.special7,
wall1,
- systemd.preset5
+ systemd.preset5,
glob7