X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemctl.xml;h=1c738cede64bb4b6b8a488e2dee1f82f91a8f563;hb=63c372cb9df3bee01e3bf8cd7f96f336bddda846;hp=b2aa17f22b0ee7d35522b62799b8c6241e8ffb4e;hpb=e94937df954451eb4aa63573f0d7404ed2db987e;p=elogind.git
diff --git a/man/systemctl.xml b/man/systemctl.xml
index b2aa17f22..1c738cede 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -1,4 +1,4 @@
-
+
@@ -98,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.
@@ -150,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.
@@ -163,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 explicitly, 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.
@@ -176,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.
@@ -309,18 +321,14 @@ along with systemd; If not, see .
-
-
-
-
- Do not print the legend, i.e. the column headers and
- the footer with hints.
-
-
-
+
+
@@ -369,7 +377,6 @@ along with systemd; If not, see .
querying the user for authentication for privileged
operations.
-
@@ -465,7 +472,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
@@ -531,9 +538,10 @@ along with systemd; If not, see .
+
+
-
@@ -580,7 +588,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
See also the options ,
- , and .
+ , and .
@@ -594,7 +602,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
See also the options and
- .
+ .
@@ -688,7 +696,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
@@ -842,15 +852,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.
@@ -924,6 +949,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.
@@ -955,6 +983,56 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ reenable NAME...
+
+
+ Reenable one or more unit files, as specified on the
+ command line. This is a combination of
+ disable and enable and
+ is useful to reset the symlinks a unit is enabled with to
+ the defaults configured in the [Install]
+ section of the unit file.
+
+
+
+
+ preset NAME...
+
+
+ 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
+ disable or enable,
+ 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
+ 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.
+
+
+
is-enabled NAME...
@@ -982,7 +1060,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
@@ -990,7 +1068,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
@@ -998,7 +1076,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
@@ -1006,12 +1084,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
@@ -1021,56 +1104,6 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
-
- reenable NAME...
-
-
- Reenable one or more unit files, as specified on the
- command line. This is a combination of
- disable and enable and
- is useful to reset the symlinks a unit is enabled with to
- the defaults configured in the [Install]
- section of the unit file.
-
-
-
-
- preset NAME...
-
-
- 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
- disable or enable,
- 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
- 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...
@@ -1080,8 +1113,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.
@@ -1097,6 +1130,20 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
+ link FILENAME...
+
+
+ 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 disable. The effect of this
+ command is that a unit file is available for
+ start and other commands although it
+ is not installed directly in the unit search path.
+
+
+
add-wants TARGETNAME...
@@ -1117,16 +1164,39 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- link FILENAME...
+ edit NAME...
- 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 disable. The effect of this
- command is that a unit file is available for
- start and other commands although it
- is not installed directly in the unit search path.
+ 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.
@@ -1134,8 +1204,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
get-default
- Get the default target specified
- via default.target link.
+ Return the default target to boot into. This returns
+ the target unit name default.target
+ is aliased (symlinked) to.
@@ -1143,10 +1214,12 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
set-default NAME
- Set the default target to boot into. Command links
- default.target to the given unit.
+ Set the default target to boot into. This sets
+ (symlinks) the default.target alias
+ to the given target unit.
+
@@ -1268,7 +1341,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
- import-environment VARIABLE...
+
+ import-environment
+ VARIABLE...
+ Import all, one or more environment variables set on
@@ -1324,13 +1400,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 maintenance 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.
+
+
+
+
@@ -1419,6 +1544,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
firmware over the air update.
+
kexec
@@ -1432,6 +1558,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
immediately followed by the reboot.
+
exit
@@ -1441,8 +1568,29 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
with the option) and will fail
otherwise.
+
+
+
+ switch-root ROOTINIT
+
+ 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.
+
+
suspend
@@ -1452,6 +1600,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
hibernate
@@ -1461,6 +1610,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
+
hybrid-sleep
@@ -1470,26 +1620,6 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
hybrid-sleep.target target.
-
- switch-root ROOTINIT
-
-
- 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.
-
-
@@ -1508,9 +1638,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.
@@ -1556,20 +1686,41 @@ 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 Alsosystemd1,
- systemadm1,
journalctl1,
loginctl1,
+ machinectl1,
systemd.unit5,
systemd.resource-management5,
systemd.special7,
wall1,
- systemd.preset5
+ systemd.preset5,
glob7