X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=10e0f82441368eb8460b260e7692fbbb96963bd5;hp=9f00324eb131c6f69b0e80ab27a50ceefc16c7b1;hb=799fd0fd23028a58e1f605c6b0d9aaab65b4fb1f;hpb=af62c704053b5d34672497eb5bdc4764ebbb5f4f
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 9f00324eb..10e0f8244 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -21,7 +21,7 @@
along with systemd; If not, see .
-->
-
+systemctl
@@ -70,14 +70,22 @@
-
+ Prints a short help
text and exits.
+
+
+
+ Prints a short version
+ string and exits.
+
+
+ When listing units,
limit display to certain unit
@@ -89,27 +97,79 @@
similar.
+
+
+
+
+ When showing
+ unit/job/manager information, limit
+ display to certain properties as
+ specified as argument. If not
+ specified all set properties are
+ shown. The argument should be a
+ property name, such as
+ MainPID. If
+ specified more than once all
+ properties with the specified names
+ are shown.
+
+
+ When listing units,
show all units, regardless of their
- state, including inactive
- units.
+ state, including inactive units. When
+ showing unit/job/manager information,
+ show all properties regardless whether
+ they are set or not.
-
+
+
+ Do not ellipsize unit
+ names and truncate unit descriptions
+ in the output of
+ list-units and
+ list-jobs.
+
+
+
+ If the requested
- operation conflicts with an existing
- unfinished operation, replace the
- existing operation by the requested
- operation. If this is not specified
- the requested operation will
- fail.
+ 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.
+
+
+
+
+ Suppress output to
+ STDOUT in
+ snapshot,
+ check,
+ enable and
+ disable.
+
+
+
+
+
+ Do not synchronously wait for
+ the requested operation to finish. If this is
+ not specified the job will be verified,
+ enqueued and systemctl will
+ wait until it is completed. By passing this
+ argument it is only verified and
+ enqueued.
+
@@ -125,11 +185,29 @@
-
+
+
- Synchronously wait for
- the requested operation to
- finish.
+ When used in
+ conjunction with the
+ dot command (see
+ below), selects which dependencies are
+ shown in the dependency graph. If
+ is passed
+ only dependencies of type
+ After= or
+ Before= are
+ shown. If
+ is passed only dependencies of type
+ Requires=,
+ RequiresOverridable=,
+ Requisite=,
+ RequisiteOverridable=,
+ Wants= and
+ Conflicts= are
+ shown. If neither is passed, shows
+ dependencies of all these
+ types.
@@ -139,6 +217,138 @@
message before
halt, power-off, reboot.
+
+
+
+
+ When used with
+ enable and
+ disable, operate on the
+ global session configuŕation
+ directory, thus enabling or disabling
+ a unit file globally for all future
+ sessions of all users.
+
+
+
+
+
+ When used with
+ enable and
+ disable, do not
+ implicitly reload daemon configuration
+ after executing the
+ changes.
+
+
+
+
+
+ When used with
+ start 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
+ command is invoked from a terminal
+ systemctl will
+ query the user on the terminal for the
+ necessary secrets. Use this option to
+ switch this behaviour off. In this
+ case the password must be supplied by
+ some other means (for example
+ graphical password agents) or the
+ service might fail.
+
+
+
+
+
+ When used with
+ kill, choose the
+ mode how to kill the selected
+ processes. Must be one of
+ ,
+ or
+ to select
+ whether to kill the entire control
+ group, the process group or only the
+ selected process itself. If ommitted
+ defaults to
+ if
+ is
+ set, or
+ otherwise. You probably never need to
+ use this switch.
+
+
+
+
+
+ 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 ommitted
+ defaults to
+ .
+
+
+
+
+
+
+ When used with
+ kill, choose which
+ signal to send to selected
+ processes. Must be one of the well
+ know signal specifiers such as
+ SIGTERM, SIGINT or SIGSTOP. If
+ ommitted defaults to
+ .
+
+
+
+
+
+
+ When used with
+ enable, override any
+ existing conflicting
+ symlinks.
+
+ When used with
+ halt,
+ poweroff,
+ reboot or
+ kexec execute
+ selected operation 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.
+
+
+
+
+
+ When used with
+ disable, ensures
+ that only the symlinks created by
+ enable are removed,
+ not all symlinks pointing to the unit
+ file that shall be
+ disabled.
+ The following commands are understood:
@@ -150,15 +360,307 @@
List known units.
- list-jobs
+ start [NAME...]
- List jobs that are in progress.
+ Start (activate) one
+ or more units specified on the command
+ line.
- clear-jobs
+ stop [NAME...]
- Cancel all jobs that are in progress.
+ 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 not running yet
+ the operation will
+ fail.
+
+
+ reload-or-restart [NAME...]
+ reload-or-try-restart [NAME...]
+
+ Reload one or more
+ units if they support it. If not,
+ restart them instead. Note that for
+ compatibility with SysV and Red Hat
+ init scripts
+ force-reload and
+ condrestart may be
+ used as equivalent commands to
+ reload-or-try-restart.
+
+
+ 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 works 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 is 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.
+
+
+ status [NAME...|PID...]
+
+ Show terse runtime
+ status information about one or more
+ units. This function is intended to
+ generate human-readable output. If you
+ are looking for computer-parsable
+ output, use show
+ instead. If a PID is passed
+ information about the unit the process
+ of the PID belongs to is
+ shown.
+
+
+ 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.
+
+
+
+ reset-failed [NAME...]
+
+ Reset the
+ 'failed' state of the
+ specified units, or if no unit name is
+ passed 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.
+
+
+
+ enable [NAME...]
+
+ Enable one or more
+ unit files, 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 that any of
+ the units enabled are also started at
+ the same time. If this is desired a
+ separate start
+ command must be invoked for the
+ unit.
+
+ 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 particular 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 his
+ 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 sessions of the calling user only
+ or for all future session of all
+ users. Note that in the latter 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 by default removes
+ all symlinks to the unit files
+ (i.e. including manual additions), not
+ just those actually created by
+ enable. If only the
+ symlinks that are suggested by default
+ shall be removed, pass
+ . This
+ implicitly reloads the systemd daemon
+ configuration after completing the
+ disabling of the units. Note that this
+ command does not implicitly stop the
+ units that is being disabled. If this
+ is desired an additional
+ stopcommand should
+ be executed afterwards.
+
+ This command will print the
+ actions executed. This output may be
+ suppressed by passing
+ .
+
+
+ This command honours
+ ,
+ ,
+ in a similar
+ way as
+ enable.
+
+
+
+ is-enabled [NAME...]
+
+ Checks whether any of
+ the specified unit files is enabled
+ (as with
+ enable). Returns an
+ exit code of 0 if at least one is
+ enabled, non-zero
+ otherwise.
+
load [NAME...]
@@ -187,69 +689,18 @@
reload
commands.
+
+ 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.
-
-
- start [NAME...]
-
- Start one or more
- units specified on the command
- line.
-
-
- stop [NAME...]
-
- Stop one or more units
- specified on the command
- line.
-
-
- restart [NAME...]
-
- Restart one or more
- units specified on the command
- line.
-
-
- reload [NAME...]
-
- Asks all services
- whose units are listed on the command
- line to reload their
- configuration. Note that this will
- reload the daemon configuration
- itself, 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.
-
-
-
- isolate [NAME]
-
- Start the unit
- specified on the command line and its
- dependencies and stop all
- others.
+ IDs. If not job id is specified cancels all jobs that are pending.
monitor
@@ -272,6 +723,24 @@
be parsed by
applications.
+
+ dot
+
+ Generate textual
+ dependency graph description in dot
+ format for further processing with the
+ GraphViz
+ dot1
+ tool. Use a command line like
+ systemctl dot | dot -Tsvg >
+ systemd.svg to generate a
+ graphical dependency tree. Unless
+ or
+ is passed
+ the generated graph will show both
+ ordering and requirement
+ dependencies.
+ snapshot [NAME]
@@ -280,8 +749,10 @@
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.
+ 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
@@ -301,6 +772,13 @@
state. Snapshots are dynamic and lost
on reboot.
+
+ delete [NAME...]
+
+ Remove a snapshot
+ previously created with
+ snapshot.
+ daemon-reload
@@ -309,7 +787,7 @@
unit files and recreate the entire
dependency tree. While the daemon is
reloaded, all sockets systemd listens
- on on behalf of user configuration, will
+ on on behalf of user configuration will
stay accessible. This
command should not be confused with
the load or
@@ -333,16 +811,6 @@
configuration will stay
accessible.
-
- daemon-exit
-
- Ask the systemd
- manager to quit. This is only
- supported for session managers
- (i.e. in conjunction with the
- option) and
- will fail otherwise.
- show-environment
@@ -375,7 +843,34 @@
is only removed if it has the
specified value.
+
+ default
+ Enter default
+ mode. This is mostly equivalent to
+ start
+ 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
@@ -383,7 +878,14 @@
system. This is mostly equivalent to
start halt.target
but also prints a wall message to all
- users.
+ users. If
+ combined with
+ shutdown of all running services is
+ skipped, however all processes killed
+ and all file systems unmounted or
+ mounted read-only, immediately
+ followed by the
+ system halt.
poweroff
@@ -393,7 +895,14 @@
equivalent to start
poweroff.target but also
prints a wall message to all
- users.
+ users. If
+ combined with
+ shutdown of all running services is
+ skipped, however all processes killed
+ and all file systems unmounted or
+ mounted read-only, immediately
+ followed by the
+ powering off.
reboot
@@ -403,35 +912,40 @@
equivalent to start
reboot.target but also
prints a wall message to all
- users.
-
-
- default
-
- Enter default
- mode. This is mostly equivalent to
- start
- default.target.
+ users. If
+ combined with
+ shutdown of all running services is
+ skipped, however all processes killed
+ and all file systems unmounted or
+ mounted read-only, immediately
+ followed by the
+ reboot.
- rescue
+ kexec
- Enter rescue
- mode. This is mostly equivalent to
- isolate
- rescue.target but also
- prints a wall message to all
- users.
+ Shut down and reboot
+ the system via kexec. This is mostly
+ equivalent to start
+ kexec.target but also prints
+ a wall message to all users. If
+ combined with
+ shutdown of all running services is
+ skipped, however all processes killed
+ and all file systems unmounted or
+ mounted read-only, immediately
+ followed by the
+ reboot.
- emergency
+ exit
- Enter emergency
- mode. This is mostly equivalent to
- isolate
- emergency.service but also
- prints a wall message to all
- users.
+ Ask the systemd
+ manager to quit. This is only
+ supported for session managers
+ (i.e. in conjunction with the
+ option) and
+ will fail otherwise.