X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemctl.xml;h=6e4b203d8877ba80f545c4b01c2edbb29f83d1d4;hp=d73e974e3ebe4231f56def0e39f5d71ef0391ed4;hb=3059b1c1f414300332320f286bb458531394f0b0;hpb=6f28c033ec506847b3bfa4efaf52478120c36946
diff --git a/man/systemctl.xml b/man/systemctl.xml
index d73e974e3..6e4b203d8 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -21,7 +21,7 @@
along with systemd; If not, see .
-->
-
+systemctl
@@ -96,11 +96,15 @@
When showing
unit/job/manager information, limit
- display to certain property names. If
- not specified all set properties are
+ 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.
+ MainPID. If
+ specified more than once all
+ properties with the specified names
+ are shown.
@@ -116,29 +120,35 @@
-
+
- If the requested
- operation conflicts with an existing
- unfinished operation, fail the
- command. If this is not specified the
- requested operation will replace the
- pending job if
- necessary.
+ Do not ellipsize unit
+ names in the output of
+ list-units and
+ list-jobs.
-
+
- Talk to the systemd
- system manager. (Default)
+ 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.
-
+
+
- Talk to the systemd
- session manager of the calling user.
+ Suppress output to
+ STDOUT in
+ snapshot,
+ check,
+ enable and
+ disable.
@@ -153,13 +163,43 @@
enqueued.
-
-
+
- Suppress output to
- STDOUT for snapshot
- and
- check.
+ Talk to the systemd
+ system manager. (Default)
+
+
+
+
+
+ Talk to the systemd
+ session manager of the calling user.
+
+
+
+
+
+
+ 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.
@@ -169,6 +209,50 @@
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
+ enable, override any
+ existing conflicting
+ symlinks.
+
+
+
+
+
+ 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:
@@ -182,29 +266,28 @@
start [NAME...]
- Start one or more
- units specified on the command
+ Start (activate) one
+ or more units specified on the command
line.stop [NAME...]
- Stop one or more units
- specified on the command
+ Stop (deactivate) 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
+ Asks all units 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
+ 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
@@ -212,10 +295,12 @@
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
+ systemd unit file.
+
+ This command should not be
+ confused with the
+ daemon-reload or
+ load
commands.
@@ -242,9 +327,14 @@
reload-or-try-restart [NAME...]Reload one or more
- units if they support it. If not
- restart them
- instead.
+ 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]
@@ -255,12 +345,12 @@
others.
- check [NAME...]
+ is-active [NAME...]Check whether any of
the specified units is active
- (i.e. running). Returns 0 if at least
- one is active, non-zero
+ (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
@@ -269,25 +359,183 @@
status [NAME...]
- Show short status
- information about one or more
- units. This shows terse runtime
- information about
- units.
+ 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.show [NAME...|JOB...]
- Show properties of
- one or more units, jobs or the manager
+ 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.
+ 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-maintenance [NAME...]
+
+ Reset maintenance
+ 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
+ maintenance state and its exit codes
+ 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
+ seperate 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...]
@@ -327,12 +575,7 @@
Cancel one or more
jobs specified on the command line by
their numeric job
- IDs.
-
-
- clear-jobs
-
- Cancel all jobs that are in progress.
+ IDs. If not job id is specified cancels all jobs that are pending.monitor
@@ -355,6 +598,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]