X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemctl.xml;h=7f7064214e907a22628518ddd071ac3880a39594;hb=895aeb27795c00f365ce3b30b1dca549b4f5468e;hp=167a72b58b47b5aa40babb27d09b15cddb0f0033;hpb=19c5f19d69bb5f520fa7213239490c55de06d99d;p=elogind.git
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 167a72b58..7f7064214 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -8,16 +8,16 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -69,8 +69,8 @@
-
+ Prints a short help
text and exits.
@@ -84,22 +84,39 @@
-
+
- When listing units,
- limit display to certain unit
- types. If not specified units of all
- types will be shown. The argument
- should be a unit type name such as
- ,
- and
- similar.
+ The argument should
+ be a unit type name such as
+ and
+ ,
+ or a unit load state such as
+ and
+ .
+
+
+ If the argument is a unit type,
+ when listing units, limit display to
+ certain unit types. If not specified
+ units of all types will be shown.
+
+ If the argument is a unit load state,
+ when listing units, limit display to
+ certain unit types. If not specified
+ units of in all load states will be
+ shown.
+
+ As a special case, if the argument
+ is , a list of
+ allowed values will be printed and the
+ program will exit.
+
-
+ When showing
unit/job/manager properties, limit
@@ -115,8 +132,8 @@
-
+ When listing units,
show all units, regardless of their
@@ -139,7 +156,7 @@
Do not ellipsize unit
- names and truncate unit descriptions
+ names, cgroup members, and truncate unit descriptions
in the output of
list-units and
list-jobs.
@@ -166,7 +183,7 @@
execute it immediately. If passed no
required units of the unit passed will
be pulled in, and no ordering
- dependencies will be honoured. This is
+ dependencies will be honored. This is
mostly a debugging and rescue tool for
the administrator and should not be
used by
@@ -174,13 +191,41 @@
-
+
+
+
+ When system shutdown
+ or a sleep state is requested, ignore
+ inhibitor locks. Applications can
+ establish inhibitor locks to avoid
+ that certain important operations
+ (such as CD burning or suchlike) are
+ interrupted by system shutdown or a
+ sleep state. Any user may take these
+ locks and privileged users may
+ override these locks. If any locks are
+ taken, shutdown and sleep state
+ requests will normally fail
+ (regardless if privileged or not) and
+ list of active locks is
+ printed. However if
+
+ is specified the locks are ignored and
+ not printed, and the operation
+ attempted anyway, possibly requiring
+ additional
+ privileges.
+
+
+
+ Suppress output to
STDOUT in
snapshot,
is-active,
+ is-failed,
enable and
disable.
@@ -200,17 +245,17 @@
- Do not print a legend, i.e.
+ Do not print a legend, i.e.
the column headers and the footer with hints.
-
-
+
+
- Do not pipe output into a
- pager.
-
+ Do not pipe output into a
+ pager.
+
@@ -226,32 +271,6 @@
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.
-
-
@@ -299,11 +318,13 @@
systemctl will
query the user on the terminal for the
necessary secrets. Use this option to
- switch this behavior off. In this
- case the password must be supplied by
- some other means (for example
- graphical password agents) or the
- service might fail.
+ switch this behavior off. In this case
+ the password must be supplied by some
+ other means (for example graphical
+ password agents) or the service might
+ fail. This also disables querying the
+ user for authentication for privileged
+ operations.
@@ -323,8 +344,8 @@
-
+ When used with
kill, choose which
@@ -337,11 +358,11 @@
-
+ When used with
- enable, override any
+ enable, overwrite any
existing conflicting
symlinks.
@@ -416,8 +437,8 @@
-
+ When used with
status controls the
@@ -429,19 +450,8 @@
-
-
-
- When used with
- status continously
- prints new journal entries as they are
- appended to the
- journal.
-
-
-
-
+ When used with
status controls the
@@ -592,6 +602,18 @@
this will also print the current unit
state to STDOUT.
+
+ is-failed [NAME...]
+
+ Check whether any of
+ the specified units are failed.
+ Returns an exit code
+ 0 if at least one is failed, non-zero
+ otherwise. Unless
+ is specified
+ this will also print the current unit
+ state to STDOUT.
+ status [NAME...|PID...]
@@ -630,7 +652,15 @@
looking for formatted human-readable
output.
+
+ help [NAME...|PID...]
+ Show manual pages for
+ one or more units, if available. If a
+ PID is passed the manual pages for the
+ unit the process of the PID belongs to
+ is shown.
+ reset-failed [NAME...]
@@ -660,24 +690,29 @@
enable [NAME...]
- Enable one or more
- unit files, as specified on the
+ 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
+ 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.
+ the same time. If this is desired
+ a separate start
+ command must be invoked for the unit.
+ Also note that in case of instance
+ enablement, symlinks named same as
+ instances are created in install
+ location, however they all point to
+ the same template unit file.This command will
print the actions executed. This
@@ -750,9 +785,9 @@
configuration after completing the
disabling of the units. Note that this
command does not implicitly stop the
- units that is being disabled. If this
+ units that are being disabled. If this
is desired an additional
- stopcommand should
+ stop command should
be executed afterwards.This command will print the
@@ -773,7 +808,7 @@
is-enabled [NAME...]Checks whether any of
- the specified unit files is enabled
+ the specified unit files are enabled
(as with
enable). Returns an
exit code of 0 if at least one is
@@ -804,12 +839,19 @@
Reset one or more unit
files, as specified on the command
- line, to the defaults configured in a
- preset file. This has the same effect
- as disable or
+ 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.
+ files. For more information on preset
+ policy format see
+ systemd.preset5. For
+ more information on the concept of
+ presets please consult the Preset
+ document.
@@ -911,22 +953,17 @@
applications.
- dot
+ list-dependencies [NAME]
- 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.
+ 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 aare
+ recursively expanded as well.
+ snapshot [NAME]
@@ -1073,7 +1110,7 @@
mounted read-only, immediately
followed by the system halt. If
is specified
- twice the the operation is immediately
+ twice the operation is immediately
executed without terminating any
processes or unmounting any file
systems. This may result in data
@@ -1094,7 +1131,7 @@
unmounted or mounted read-only,
immediately followed by the powering
off. If is
- specified twice the the operation is
+ specified twice the operation is
immediately executed without
terminating any processes or
unmounting any file systems. This may
@@ -1115,7 +1152,7 @@
unmounted or mounted read-only,
immediately followed by the reboot. If
is specified
- twice the the operation is immediately
+ twice the operation is immediately
executed without terminating any
processes or unmounting any file
systems. This may result in data
@@ -1147,6 +1184,60 @@
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. Takes two arguments: the
+ directory to make 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 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.
+
@@ -1161,7 +1252,7 @@
Environment
-
+ $SYSTEMD_PAGERPager to use when
@@ -1183,7 +1274,8 @@
loginctl1,
systemd.unit5,
systemd.special7,
- wall1
+ wall1,
+ systemd.preset5