X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemctl.xml;h=5e55f29287051c154d4c5d7cae903e89096dda62;hb=37224a5ff522a366b353e8a01e2c2eee1e5416e5;hp=ee13a70fef66e6f8e2ac1da9e216eb51cef56207;hpb=fbce11397f4d19821a9dfe66ee3ebe11cad90057;p=elogind.git
diff --git a/man/systemctl.xml b/man/systemctl.xml
index ee13a70fe..5e55f2928 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -111,9 +111,9 @@ along with systemd; If not, see .
- The argument should be a comma-separated list of unit LOAD
- or SUB or ACTIVE states. When listing units, show only those
- with specified LOAD or SUB or ACTIVE state.
+ The argument should be a comma-separated list of unit LOAD,
+ SUB, or ACTIVE states. When listing units, show only those
+ in specified states.
@@ -174,25 +174,13 @@ along with systemd; If not, see .
- Do not ellipsize unit names, cgroup members, and
+ Do not ellipsize unit names, process tree entries, and
truncate unit descriptions in the output of
list-units and
list-jobs.
-
-
-
-
- If the requested operation conflicts with a pending
- unfinished job, fail the command. If this is not specified,
- the requested operation will replace the pending job, if
- necessary. Do not confuse with
- .
-
-
-
@@ -202,27 +190,58 @@ along with systemd; If not, see .
-
+
- Mark this transaction's jobs as irreversible. This prevents
- future conflicting transactions from replacing these jobs.
- The jobs can still be cancelled using the cancel
- command.
-
-
+ When queuing a new job, control how to deal with already
+ queued jobs. Takes one of fail,
+ replace,
+ replace-irreversibly,
+ isolate,
+ ignore-dependencies,
+ ignore-requirements or
+ flush. Defaults to
+ replace, except when the
+ isolate command is used which implies the
+ isolate job mode.
-
-
+ If fail 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.
-
- When enqueuing a new job, ignore all its dependencies
- and execute it 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.
+ If replace (the default) is
+ specified, any conflicting pending job will be replaced, as
+ necessary.
+
+ 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.
+
+ isolate 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
+ isolate command is used.
+
+ flush will cause all queued jobs to
+ be canceled when the new job is enqueued.
+
+ If ignore-dependencies 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.
+
+ ignore-requirements is similar to
+ ignore-dependencies but only causes the
+ requirement dependencies to be ignored, the ordering
+ dependencies will still be honoured.
+
@@ -424,7 +443,7 @@ along with systemd; If not, see .
When used with enable,
- disable, is-enabled
+ disable,
(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
@@ -444,21 +463,20 @@ along with systemd; If not, see .
- Execute operation remotely. Specify a hostname, or
- username and hostname separated by @, to connect to. This
- will use SSH to talk to the remote systemd
+ 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.
-
-
+
+
-
- Acquire privileges via PolicyKit before executing the
- operation.
-
+ Execute the operation on a local
+ container. Specify a container name to connect
+ to.
@@ -503,25 +521,32 @@ along with systemd; If not, see .
The following commands are understood:
-
-
- list-units
+
+ Unit Commands
-
- List known units (subject to limitations specified
- with ).
+
+
+ list-units PATTERN...
- This is the default command.
-
-
+
+ List known units (subject to limitations specified
+ with ). If one or more
+ PATTERNs are specified, only
+ units matching one of them are shown.
-
- list-sockets
+ This is the default command.
+
+
-
- List socket units ordered by the listening address. Produces output
- similar to
-
+
+ list-sockets PATTERN...
+
+
+ List socket units ordered by the listening address.
+ If one or more PATTERNs are
+ specified, only socket units matching one of them are
+ shown. Produces output similar to
+
LISTEN UNIT ACTIVATES
/dev/initctl systemd-initctl.socket systemd-initctl.service
...
@@ -529,727 +554,842 @@ LISTEN UNIT ACTIVATES
kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
5 sockets listed.
-
- Note: because the addresses might contains spaces, this output
- is not suitable for programmatic consumption.
-
-
- See also the options ,
- , and .
-
-
-
-
- set-log-level LEVEL
-
-
- Change current log level of the
- systemd daemon to
- LEVEL (accepts the same values
- as described in
- systemd1).
-
-
-
-
-
- start NAME...
-
-
- Start (activate) one or more units specified on the
- command line.
-
-
-
- stop NAME...
-
-
- Stop (deactivate) one or more units specified on the
- command line.
-
-
-
- reload NAME...
-
-
- 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
- configuration file of a unit use the
- daemon-reload command. In other words:
- for the example case of Apache, this will reload Apache's
- httpd.conf in the web server, not the
- apache.service systemd unit
- file.
-
- This command should not be confused with the
- daemon-reload or load
- commands.
-
-
-
-
- restart NAME...
-
-
- Restart one or more units specified on the command
- line. If the units are not running yet, they will be
- started.
-
-
-
- try-restart NAME...
-
-
- 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, condrestart is equivalent to this
- command.
-
-
-
- reload-or-restart NAME...
-
-
- 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.
-
-
-
- reload-or-try-restart NAME...
-
-
- 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,
- force-reload is equivalent to this
- command.
-
-
-
- isolate NAME
-
-
- Start the unit specified on the command line and its
- dependencies and stop all others.
-
- This is similar to changing the runlevel in a
- traditional init system. The isolate
- command will immediately stop processes that are not enabled
- in the new unit, possibly including the graphical
- environment or terminal you are currently using.
-
- Note that this is allowed only on units where
- is enabled. See
- systemd.unit5
- for details.
-
-
-
- kill NAME...
-
-
- 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.
-
-
-
- is-active NAME...
-
-
- Check whether any of the specified units are active
- (i.e. running). Returns an exit code 0 if at least one is
- active, non-zero otherwise. Unless
- is specified, this will also print the current unit state to
- STDOUT.
-
-
-
- is-failed NAME...
-
-
- 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.
-
-
-
- status [NAME...|PID...]
-
-
- 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.
-
- This function is intended to generate human-readable
- output. If you are looking for computer-parsable output, use
- show instead.
-
-
-
- show [NAME...|JOB...]
-
-
- Show properties of one or more units, jobs, or the
- manager itself. If no argument is specified properties of
- the manager will be shown. If a unit name is specified
- properties of the unit is shown, and if a job id is
- specified properties of the job is shown. By default, empty
- properties are suppressed. Use to
- show those too. To select specific properties to show use
- . This command is intended to be
- used whenever computer-parsable output is required. Use
- status if you are looking for formatted
- human-readable output.
-
-
-
-
- set-property NAMEASSIGNMENT...
-
-
- Set the specified unit properties at runtime where
- this is supported. This allows changing configuration
- parameter properties such as resource management controls at
- runtime. Not all properties may be changed at runtime, but
- many resource management settings (primarily those in
- systemd.cgroup5)
- may. The changes are applied instantly, and stored on disk
- for future boots, unless is
- passed, in which case the settings only apply until the next
- reboot. The syntax of the property assignment follows
- closely the syntax of assignments in unit files.
-
- Example: systemctl set-property foobar.service CPUShares=777
-
- 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.
-
-
-
-
- help NAME...|PID...
-
-
- 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.
-
-
-
-
- reset-failed [NAME...]
-
-
- Reset the failed 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
- failed state and its exit code and status
- is recorded for introspection by the administrator until the
- service is restarted or reset with this command.
-
-
-
-
- list-unit-files
-
-
- List installed unit files.
-
-
-
-
- enable NAME...
-
-
- 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 [Install]
- sections of the unit files. After the symlinks have been
- created, the systemd configuration is reloaded (in a way that
- is equivalent to daemon-reload) to ensure
- the changes are taken into account immediately. Note that
- this does not have the effect of also
- starting any of the units being enabled. If this
- is desired, a separate start 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.
-
- This command will print the actions executed. This
- output may be suppressed by passing .
-
-
- 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 daemon-reload manually as
- necessary to ensure the changes are taken into account.
-
-
- Enabling units should not be confused with starting
- (activating) units, as done by the start
- 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.
-
- Depending on whether ,
- or is
- specified, this enables the unit for the system, for the
- calling user only or for all future logins of all
- users. Note that in the last case, no systemd daemon
- configuration is reloaded.
-
-
-
-
- disable NAME...
-
-
- 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
- enable. Note however that this removes
- all symlinks to the unit files (i.e. including manual
- additions), not just those actually created by
- enable. 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 stop command should be
- executed afterwards.
-
- This command will print the actions executed. This
- output may be suppressed by passing .
-
-
- This command honors ,
- , in a
- similar way as enable.
-
-
-
-
- is-enabled NAME...
-
-
- Checks whether any of the specified unit files are
- enabled (as with enable). Returns an exit
- code of 0 if at least one is enabled, non-zero
- otherwise. Prints the current enable status. To suppress
- this output, use .
-
-
-
-
- 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. For
- more information on the preset policy format, see
- systemd.preset5.
- For more information on the concept of presets, please
- consult the
- Preset
- document.
-
-
-
-
- mask NAME...
-
-
- Mask one or more unit files, as specified on the
- command line. This will link these units to
- /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.
-
-
-
-
- unmask NAME...
-
-
- Unmask one or more unit files, as specified on the
- command line. This will undo the effect of
- mask.
-
-
-
-
- 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.
-
-
-
-
- get-default
-
-
- Get the default target specified
- via default.target link.
-
-
-
-
- set-default NAME
-
-
- Set the default target to boot into. Command links
- default.target to the given unit.
-
-
-
-
- load NAME...
-
-
- Load one or more units specified on the command
- line. This will simply load their configuration from disk,
- but not start them. To start them, you need to use the
- start command which will implicitly load
- a unit that has not been loaded yet. Note that systemd
- garbage collects loaded units that are not active or
- referenced by an active unit. This means that units loaded
- this way will usually not stay loaded for long. Also note
- that this command cannot be used to reload unit
- configuration. Use the daemon-reload
- command for that. All in all, this command is of little use
- except for debugging.
-
- This command should not be confused with the
- daemon-reload or
- reload.
-
-
-
- list-jobs
-
-
- List jobs that are in progress.
-
-
-
- cancel JOB...
-
-
- 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.
-
-
-
- dump
-
-
- Dump server status. This will output a (usually very
- long) human readable manager status dump. Its format is
- subject to change without notice and should not be parsed by
- applications.
-
-
-
- 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.
-
-
-
- snapshot [NAME]
-
-
- 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.
-
- 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
- isolate command on the snapshot unit.
-
-
- 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.
-
-
-
- delete NAME...
-
-
- Remove a snapshot previously created with
- snapshot.
-
-
-
- daemon-reload
-
-
- Reload systemd manager configuration. This will reload
- all unit files and recreate the entire dependency
- tree. While the daemon is reloaded, all sockets systemd
- listens on on behalf of user configuration will stay
- accessible.This command should not be confused
- with the load or
- reload commands.
-
-
-
- daemon-reexec
-
-
- 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
- debugging and package upgrades. Sometimes it might be
- helpful as a heavy-weight daemon-reload.
- While the daemon is reexecuted, all sockets systemd listening
- on behalf of user configuration will stay accessible.
-
-
-
-
- show-environment
-
-
- 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.
-
-
-
- set-environment VARIABLE=VALUE...
-
-
- Set one or more systemd manager environment variables,
- as specified on the command line.
-
-
-
- unset-environment VARIABLE...
-
-
- 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.
-
-
-
- default
-
-
- Enter default mode. This is mostly equivalent to
- isolate default.target.
-
-
-
- rescue
-
-
- Enter rescue mode. This is mostly equivalent to
- isolate rescue.target, but also prints a
- wall message to all users.
-
-
-
- emergency
-
-
- Enter emergency mode. This is mostly equivalent to
- isolate emergency.target, but also prints
- a wall message to all users.
-
-
-
- halt
-
-
- Shut down and halt the system. This is mostly equivalent to
- start halt.target --irreversible, but also
- prints a wall message to all users. If combined with
- , 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 is
- specified twice, the operation is immediately executed
- without terminating any processes or unmounting any file
- systems. This may result in data loss.
-
-
-
- poweroff
-
-
- Shut down and power-off the system. This is mostly
- equivalent to start poweroff.target --irreversible,
- but also prints a wall message to all users. If combined with
- , 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 is
- specified twice, the operation is immediately executed
- without terminating any processes or unmounting any file
- systems. This may result in data loss.
-
-
-
- reboot
-
-
- Shut down and reboot the system. This is mostly
- equivalent to start reboot.target --irreversible,
- but also prints a wall message to all users. If combined with
- , 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 is
- specified twice, the operation is immediately executed
- without terminating any processes or unmounting any file
- systems. This may result in data loss.
-
-
-
- kexec
-
-
- Shut down and reboot the system via kexec. This is
- mostly equivalent to start kexec.target --irreversible,
- but also prints a wall message to all users. If combined
- with , 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.
-
-
-
- exit
-
-
- Ask the systemd manager to quit. This is only
- supported for user service managers (i.e. in conjunction
- with the option) and will fail
- otherwise.
-
-
-
-
- suspend
-
-
- Suspend the system. This will trigger activation of
- the special suspend.target target.
-
-
-
-
- hibernate
-
-
- Hibernate the system. This will trigger activation of
- the special hibernate.target target.
-
-
-
-
- hybrid-sleep
-
-
- Hibernate and suspend the system. This will trigger
- activation of the special
- hybrid-sleep.target target.
-
-
-
- switch-root ROOT [INIT]
-
-
- 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.
-
-
-
+
+ Note: because the addresses might contains spaces, this output
+ is not suitable for programmatic consumption.
+
+
+ See also the options ,
+ , and .
+
+
+
+
+ list-timers PATTERN...
+
+
+ List timer units ordered by the time they elapse
+ next. If one or more PATTERNs
+ are specified, only units matching one of them are shown.
+
+
+ See also the options and
+ .
+
+
+
+
+ start NAME...
+
+
+ Start (activate) one or more units specified on the
+ command line.
+
+
+
+ stop NAME...
+
+
+ Stop (deactivate) one or more units specified on the
+ command line.
+
+
+
+ reload NAME...
+
+
+ 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
+ configuration file of a unit, use the
+ daemon-reload command. In other words:
+ for the example case of Apache, this will reload Apache's
+ httpd.conf in the web server, not the
+ apache.service systemd unit
+ file.
+
+ This command should not be confused with the
+ daemon-reload or load
+ commands.
+
+
+
+
+ restart NAME...
+
+
+ Restart one or more units specified on the command
+ line. If the units are not running yet, they will be
+ started.
+
+
+
+ try-restart NAME...
+
+
+ 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, condrestart is equivalent to this
+ command.
+
+
+
+ reload-or-restart NAME...
+
+
+ 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.
+
+
+
+ reload-or-try-restart NAME...
+
+
+ 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,
+ force-reload is equivalent to this
+ command.
+
+
+
+ isolate NAME
+
+
+ Start the unit specified on the command line and its
+ dependencies and stop all others.
+
+ This is similar to changing the runlevel in a
+ traditional init system. The isolate
+ command will immediately stop processes that are not enabled
+ in the new unit, possibly including the graphical
+ environment or terminal you are currently using.
+
+ Note that this is allowed only on units where
+ is enabled. See
+ systemd.unit5
+ for details.
+
+
+
+ kill NAME...
+
+
+ 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.
+
+
+
+ is-active NAME...
+
+
+ Check whether any of the specified units are active
+ (i.e. running). Returns an exit code 0 if at least one is
+ active, non-zero otherwise. Unless
+ is specified, this will also print the current unit state to
+ STDOUT.
+
+
+
+ is-failed NAME...
+
+
+ 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.
+
+
+
+ statusNAME...|PID...]
+
+
+ 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.
+
+ This function is intended to generate human-readable
+ output. If you are looking for computer-parsable output, use
+ show instead.
+
+
+
+ showNAME...|JOB...
+
+
+ Show properties of one or more units, jobs, or the
+ manager itself. If no argument is specified, properties of
+ the manager will be shown. If a unit name is specified,
+ properties of the unit is shown, and if a job id is
+ specified, properties of the job is shown. By default, empty
+ properties are suppressed. Use to
+ show those too. To select specific properties to show, use
+ . This command is intended to be
+ used whenever computer-parsable output is required. Use
+ status if you are looking for formatted
+ human-readable output.
+
+
+
+ cat NAME...
+
+
+ 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.
+
+
+
+ set-property NAMEASSIGNMENT...
+
+
+ Set the specified unit properties at runtime where
+ this is supported. This allows changing configuration
+ parameter properties such as resource control settings at
+ runtime. Not all properties may be changed at runtime, but
+ many resource control settings (primarily those in
+ systemd.resource-control5)
+ may. The changes are applied instantly, and stored on disk
+ for future boots, unless is
+ passed, in which case the settings only apply until the
+ next reboot. The syntax of the property assignment follows
+ closely the syntax of assignments in unit files.
+
+ Example: systemctl set-property foobar.service CPUShares=777
+
+ 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.
+
+
+
+
+ help NAME...|PID...
+
+
+ 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.
+
+
+
+
+ reset-failed [NAME...]
+
+
+ Reset the failed 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
+ failed state and its exit code and status
+ is recorded for introspection by the administrator until the
+ service is restarted or reset with this command.
+
+
+
+
+ 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.
+
+
+
+
+
+
+ Unit File Commands
+
+
+
+ list-unit-files PATTERN...
+
+
+ List installed unit files. If one or more
+ PATTERNs are specified, only
+ units whose filename (just the last component of the path)
+ matches one of them are shown.
+
+
+
+
+ enable NAME...
+
+
+ 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 [Install]
+ sections of the unit files. After the symlinks have been
+ created, the systemd configuration is reloaded (in a way that
+ is equivalent to daemon-reload) to ensure
+ the changes are taken into account immediately. Note that
+ this does not have the effect of also
+ starting any of the units being enabled. If this
+ is desired, a separate start 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.
+
+ This command will print the actions executed. This
+ output may be suppressed by passing .
+
+
+ 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 daemon-reload manually as
+ necessary to ensure the changes are taken into account.
+
+
+ Enabling units should not be confused with starting
+ (activating) units, as done by the start
+ 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.
+
+ Depending on whether ,
+ , ,
+ or is specified, this enables the unit
+ 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
+ configuration is reloaded.
+
+
+
+
+ disable NAME...
+
+
+ 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
+ enable. Note however that this removes
+ all symlinks to the unit files (i.e. including manual
+ additions), not just those actually created by
+ enable. 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 stop command should be
+ executed afterwards.
+
+ This command will print the actions executed. This
+ output may be suppressed by passing .
+
+
+ This command honors ,
+ , and
+ in a similar way as
+ enable.
+
+
+
+
+ is-enabled NAME...
+
+
+ Checks whether any of the specified unit files are
+ enabled (as with enable). 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 .
+
+
+
+
+ is-enabled output
+
+
+
+
+
+ Printed string
+ Meaning
+ Return value
+
+
+
+
+ enabled
+ Enabled through a symlink in .wants directory (permanently or just in /run)
+ 0
+
+
+ enabled-runtime
+
+
+ linked
+ Made available through a symlink to the unit file (permanently or just in /run)
+ 1
+
+
+ linked-runtime
+
+
+ masked
+ Disabled entirely (permanently or just in /run)
+ 1
+
+
+ masked-runtime
+
+
+ static
+ Unit is not enabled, but has no provisions for enabling in [Install] section
+ 1
+
+
+ disabled
+ Unit is not enabled
+ 1
+
+
+
+
+
+
+
+
+
+ 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. For
+ more information on the preset policy format, see
+ systemd.preset5.
+ For more information on the concept of presets, please
+ consult the
+ Preset
+ document.
+
+
+
+
+ mask NAME...
+
+
+ Mask one or more unit files, as specified on the
+ command line. This will link these units to
+ /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
+ option to only mask temporarily
+ until the next reoobt of the system.
+
+
+
+
+ unmask NAME...
+
+
+ Unmask one or more unit files, as specified on the
+ command line. This will undo the effect of
+ mask.
+
+
+
+
+ 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.
+
+
+
+
+ get-default
+
+
+ Get the default target specified
+ via default.target link.
+
+
+
+
+ set-default NAME
+
+
+ Set the default target to boot into. Command links
+ default.target to the given unit.
+
+
+
+
+
+
+ Job Commands
+
+
+
+ list-jobs PATTERN...
+
+
+ List jobs that are in progress. If one or more
+ PATTERNs are specified, only
+ jobs for units matching one of them are shown.
+
+
+
+ cancel JOB...
+
+
+ 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.
+
+
+
+
+
+
+ Snapshot Commands
+
+
+
+ snapshot NAME
+
+
+ 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.
+
+ 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
+ isolate command on the snapshot unit.
+
+
+ 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.
+
+
+
+ delete NAME...
+
+
+ Remove a snapshot previously created with
+ snapshot.
+
+
+
+
+
+
+ Environment Commands
+
+
+
+ show-environment
+
+
+ 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.
+
+
+
+ set-environment VARIABLE=VALUE...
+
+
+ Set one or more systemd manager environment variables,
+ as specified on the command line.
+
+
+
+ unset-environment VARIABLE...
+
+
+ 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.
+
+
+
+
+
+
+ Manager Lifecycle Commands
+
+
+
+ daemon-reload
+
+
+ Reload systemd manager configuration. This will reload
+ all unit files and recreate the entire dependency
+ tree. While the daemon is being reloaded, all sockets systemd
+ listens on on behalf of user configuration will stay
+ accessible.This command should not be confused
+ with the load or
+ reload commands.
+
+
+
+ daemon-reexec
+
+
+ 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
+ debugging and package upgrades. Sometimes, it might be
+ helpful as a heavy-weight daemon-reload.
+ While the daemon is being reexecuted, all sockets systemd listening
+ on behalf of user configuration will stay accessible.
+
+
+
+
+
+
+
+ System Commands
+
+
+
+ default
+
+
+ Enter default mode. This is mostly equivalent to
+ isolate default.target.
+
+
+
+ rescue
+
+
+ Enter rescue mode. This is mostly equivalent to
+ isolate rescue.target, but also prints a
+ wall message to all users.
+
+
+
+ emergency
+
+
+ Enter emergency mode. This is mostly equivalent to
+ isolate emergency.target, but also prints
+ a wall message to all users.
+
+
+
+ halt
+
+
+ Shut down and halt the system. This is mostly equivalent to
+ start halt.target --irreversible, but also
+ prints a wall message to all users. If combined with
+ , 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 is
+ specified twice, the operation is immediately executed
+ without terminating any processes or unmounting any file
+ systems. This may result in data loss.
+
+
+
+ poweroff
+
+
+ Shut down and power-off the system. This is mostly
+ equivalent to start poweroff.target --irreversible,
+ but also prints a wall message to all users. If combined with
+ , 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 is
+ specified twice, the operation is immediately executed
+ without terminating any processes or unmounting any file
+ systems. This may result in data loss.
+
+
+
+ reboot arg
+
+
+ Shut down and reboot the system. This is mostly
+ equivalent to start reboot.target --irreversible,
+ but also prints a wall message to all users. If combined with
+ , 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 is
+ specified twice, the operation is immediately executed
+ without terminating any processes or unmounting any file
+ systems. This may result in data loss.
+
+ If the optional argument
+ arg is given, it will be passed
+ as the optional argument to the
+ reboot2
+ system call. The value is architecture and firmware
+ specific. As an example, recovery might
+ be used to trigger system recovery, and
+ fota might be used to trigger a
+ firmware over the air update.
+
+
+
+ kexec
+
+
+ Shut down and reboot the system via kexec. This is
+ mostly equivalent to start kexec.target --irreversible,
+ but also prints a wall message to all users. If combined
+ with , 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.
+
+
+
+ exit
+
+
+ Ask the systemd manager to quit. This is only
+ supported for user service managers (i.e. in conjunction
+ with the option) and will fail
+ otherwise.
+
+
+
+
+ suspend
+
+
+ Suspend the system. This will trigger activation of
+ the special suspend.target target.
+
+
+
+
+ hibernate
+
+
+ Hibernate the system. This will trigger activation of
+ the special hibernate.target target.
+
+
+
+
+ hybrid-sleep
+
+
+ Hibernate and suspend the system. This will trigger
+ activation of the special
+ 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.
+
+
+
+
+
+
+ Parameter Syntax
+
+ For unit commands the specified
+ NAME should be the full name of the
+ unit, or an abbreviated name which is automatically extended with
+ the .service suffix.
+ # systemctl start foo.service is equivalent to:
+ # systemctl start foo
+ Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names.
+ # systemctl status /dev/sda
+# systemctl status /home is equivalent to:
+ # systemctl status dev-sda.device
+# systemctl status home.mount
+
+ For unit file commands the
+ specified NAME should be the full name
+ of the unit file, or the absolute path to the unit file.
+ # systemctl link /path/to/foo.service
+
+
@@ -1286,7 +1426,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
journalctl1,
loginctl1,
systemd.unit5,
- systemd.cgroupq5,
+ systemd.resource-management5,
systemd.special7,
wall1,
systemd.preset5