X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.xml;h=e0e8d37a90ade54c1788838a6cbc0f796db2b9b3;hb=bd763d350c7e8bf8b934bd45bc34ac35cdba2a63;hp=88904b7a094197a050842af0f6d8dce8b4122d81;hpb=0658666bacde7decbc362f0f589fe6aa5251faba;p=elogind.git
diff --git a/man/systemd.xml b/man/systemd.xml
index 88904b7a0..e0e8d37a9 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -8,20 +8,21 @@
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 .
-->
-
+systemd
@@ -45,7 +46,7 @@
systemdinit
- systemd System and Service Manager
+ systemd system and service manager
@@ -74,11 +75,13 @@
telinit8
for more information.
- When run as system instance, systemd interprets
- the configuration file
- system.conf, otherwise
- user.conf. See
- systemd.conf5
+ When run as a system instance, systemd interprets the
+ configuration file system.conf and the
+ files in system.conf.d directories; when
+ run as a user instance, systemd interprets the configuration
+ file user.conf and the files in
+ user.conf.d directories. See
+ systemd-system.conf5
for more information.
@@ -88,13 +91,6 @@
The following options are understood:
-
-
-
-
- Prints a short help
- text and exits.
-
@@ -112,25 +108,11 @@
configuration items understood in unit
definition files.
-
-
-
- Extract D-Bus
- interface introspection data. This is
- mostly useful at install time
- to generate data suitable for the
- D-Bus interfaces
- repository. Optionally the interface
- name for the introspection data may be
- specified. If omitted, the
- introspection data for all interfaces
- is dumped.
- Set default unit to
- activate on startup. If not specified
+ activate on startup. If not specified,
defaults to
default.target.
@@ -138,11 +120,13 @@
- Tell systemd to run a
- system instance (resp. user
- instance), even if the process ID is
- not 1 (resp. is 1), i.e. systemd is
- not (resp. is) run as init process.
+ For ,
+ tell systemd to run a
+ system instance, even if the process ID is
+ not 1, i.e. systemd is not run as init process.
+ does the opposite,
+ running a user instance even if the process
+ ID is 1.
Normally it should not be necessary to
pass these options, as systemd
automatically detects the mode it is
@@ -191,27 +175,15 @@
interpreted as
.
-
-
-
- Controls whether
- output of SysV init scripts will be
- directed to the console. This switch
- has no effect when run as user
- instance. Takes a boolean argument
- which may be omitted which is
- interpreted as
- .
- Set log
target. Argument must be one of
,
- ,
+ ,
,
- ,
+ ,
.
@@ -219,7 +191,7 @@
Set log level. As
argument this accepts a numerical log
- level or the well-known syslog3
+ level or the well-known syslog3
symbolic names (lowercase):
,
,
@@ -235,7 +207,7 @@
Highlight important
log messages. Argument is a boolean
- value. If the argument is omitted it
+ value. If the argument is omitted, it
defaults to
.
@@ -250,6 +222,39 @@
it defaults to
.
+
+
+
+
+ Sets the default
+ output or error output for all
+ services and sockets, respectively. That is, controls
+ the default for
+
+ and
+ (see
+ systemd.exec5
+ for details). Takes one of
+ ,
+ ,
+ ,
+ ,
+ ,
+ ,
+ ,
+ ,
+ . If the
+ argument is omitted
+
+ defaults to
+ and
+
+ to
+ .
+
+
+
+
@@ -257,25 +262,27 @@
Conceptssystemd provides a dependency system between
- various entities called "units". Units encapsulate
- various objects that are relevant for system boot-up
- and maintenance. The majority of units are configured
- in unit configuration files, whose syntax and basic
- set of options is described in
+ various entities called "units" of 12 different
+ types. Units encapsulate various objects that are
+ relevant for system boot-up and maintenance. The
+ majority of units are configured in unit configuration
+ files, whose syntax and basic set of options is
+ described in
systemd.unit5,
however some are created automatically from other
- configuration or dynamically from system state. Units
- may be 'active' (meaning started, bound, plugged in,
- ... depending on the unit type, see below), or
- 'inactive' (meaning stopped, unbound, unplugged, ...),
- as well as in the process of being activated or
- deactivated, i.e. between the two states (these states
- are called 'activating', 'deactivating'). A special
- 'failed' state is available as well which is very
- similar to 'inactive' and is entered when the service
- failed in some way (process returned error code on
- exit, or crashed, or an operation timed out). If this
- state is entered the cause will be logged, for later
+ configuration, dynamically from system state or
+ programmatically at runtime. Units may be "active"
+ (meaning started, bound, plugged in, ..., depending on
+ the unit type, see below), or "inactive" (meaning
+ stopped, unbound, unplugged, ...), as well as in the
+ process of being activated or deactivated,
+ i.e. between the two states (these states are called
+ "activating", "deactivating"). A special "failed"
+ state is available as well, which is very similar to
+ "inactive" and is entered when the service failed in
+ some way (process returned error code on exit, or
+ crashed, or an operation timed out). If this state is
+ entered, the cause will be logged, for later
reference. Note that the various unit types may have a
number of additional substates, which are mapped to
the five generalized unit states described
@@ -284,7 +291,7 @@
The following unit types are available:
- Service units, which control
+ Service units, which start and control
daemons and the processes they consist of. For
details see
systemd.service5.
@@ -341,6 +348,18 @@
objects change or are modified. See
systemd.path5.
+ Slice units may be used to
+ group units which manage system processes
+ (such as service and scope units) in a
+ hierarchical tree for resource management
+ purposes. See
+ systemd.slice5.
+
+ Scope units are similar to
+ service units, but manage foreign processes
+ instead of starting them as well. See
+ systemd.scope5.
+
Units are named as their configuration
@@ -365,7 +384,7 @@
and ordering dependencies are placed between two
units. Also note that the majority of dependencies are
implicitly created and maintained by systemd. In most
- cases it should be unnecessary to declare additional
+ cases, it should be unnecessary to declare additional
dependencies manually, however it is possible to do
this.
@@ -387,7 +406,7 @@
multi-user.target (for limited
console-only boots for use in embedded or server
environments, or similar; a subset of
- graphical.target). However it is at the discretion of
+ graphical.target). However, it is at the discretion of
the administrator to configure it as an alias to any
other target unit. See
systemd.special7
@@ -397,7 +416,7 @@
individual Linux control groups named after the unit
which they belong to in the private systemd
hierarchy. (see cgroups.txt
+ url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt
for more information about control groups, or short
"cgroups"). systemd uses this to effectively keep
track of processes. Control group information is
@@ -405,7 +424,7 @@
file system hierarchy (beneath
/sys/fs/cgroup/systemd/), or in tools
such as
- ps1
+ ps1
(ps xawf -eo pid,user,cgroup,args
is particularly useful to list all processes and the
systemd units they belong to.).
@@ -445,14 +464,14 @@
Systemd contains native implementations of
various tasks that need to be executed as part of the
- boot process. For example, it sets the host name or
+ boot process. For example, it sets the hostname or
configures the loopback network device. It also sets
up and mounts various API file systems, such as
/sys or
/proc.For more information about the concepts and
- ideas behind systemd please refer to the Original
Design Document.
@@ -460,6 +479,21 @@
by systemd are covered by the Interface
Stability Promise.
+
+ Units may be generated dynamically at boot and
+ system manager reload time, for example based on other
+ configuration files or parameters passed on the kernel
+ command line. For details see the Generators
+ Specification.
+
+ Systems which invoke systemd in a container
+ or initrd environment should implement the
+ Container
+ Interface or initrd
+ Interface specifications, respectively.
@@ -477,9 +511,9 @@
pkg-config systemd
--variable=systemdsystemunitdir. Other
directories checked are
- /usr/local/share/systemd/system
+ /usr/local/lib/systemd/system
and
- /usr/share/systemd/system. User
+ /usr/lib/systemd/system. User
configuration always takes
precedence. pkg-config
systemd
@@ -492,7 +526,9 @@
disable commands of
the
systemctl1
- tool.
+ tool. Full list of directories is provided in
+ systemd.unit5.
+
@@ -521,7 +557,9 @@
tool can handle both global (i.e. for
all users) and private (for one user)
enabling/disabling of
- units.
+ units. Full list of directories is provided in
+ systemd.unit5.
+
@@ -564,7 +602,7 @@
- SIGTERM
+ SIGTERMUpon receiving this
signal the systemd system manager
@@ -584,7 +622,7 @@
- SIGINT
+ SIGINTUpon receiving this
signal the systemd system manager will
@@ -596,11 +634,11 @@
systemd user managers
treat this signal the same way as
- SIGTERM.
+ SIGTERM.
- SIGWINCH
+ SIGWINCHWhen this signal is
received the systemd system manager
@@ -616,7 +654,7 @@
- SIGPWR
+ SIGPWRWhen this signal is
received the systemd manager
@@ -628,7 +666,7 @@
- SIGUSR1
+ SIGUSR1When this signal is
received the systemd manager will try
@@ -637,18 +675,18 @@
- SIGUSR2
+ SIGUSR2When this signal is
received the systemd manager will log
its complete state in human readable
form. The data logged is the same as
- printed by systemctl
+ printed by systemd-analyze
dump.
- SIGHUP
+ SIGHUPReloads the complete
daemon configuration. This is mostly
@@ -657,7 +695,7 @@
- SIGRTMIN+0
+ SIGRTMIN+0Enters default mode, starts the
default.target
@@ -667,7 +705,7 @@
- SIGRTMIN+1
+ SIGRTMIN+1Enters rescue mode,
starts the
@@ -678,7 +716,7 @@
- SIGRTMIN+2
+ SIGRTMIN+2Enters emergency mode,
starts the
@@ -689,7 +727,7 @@
- SIGRTMIN+3
+ SIGRTMIN+3Halts the machine,
starts the
@@ -700,7 +738,7 @@
- SIGRTMIN+4
+ SIGRTMIN+4Powers off the machine,
starts the
@@ -711,7 +749,7 @@
- SIGRTMIN+5
+ SIGRTMIN+5Reboots the machine,
starts the
@@ -722,7 +760,7 @@
- SIGRTMIN+6
+ SIGRTMIN+6Reboots the machine via kexec,
starts the
@@ -733,31 +771,31 @@
- SIGRTMIN+13
+ SIGRTMIN+13Immediately halts the machine.
- SIGRTMIN+14
+ SIGRTMIN+14Immediately powers off the machine.
- SIGRTMIN+15
+ SIGRTMIN+15Immediately reboots the machine.
- SIGRTMIN+16
+ SIGRTMIN+16Immediately reboots the machine with kexec.
- SIGRTMIN+20
+ SIGRTMIN+20Enables display of
status messages on the console, as
@@ -768,7 +806,7 @@
- SIGRTMIN+21
+ SIGRTMIN+21Disables display of
status messages on the console, as
@@ -777,13 +815,59 @@
on the kernel command
line.
+
+
+ SIGRTMIN+22
+ SIGRTMIN+23
+
+ Sets the log level to
+ debug
+ (or info on
+ SIGRTMIN+23), as
+ controlled via
+ systemd.log_level=debug
+ (or systemd.log_level=info
+ on SIGRTMIN+23) on
+ the kernel command
+ line.
+
+
+
+ SIGRTMIN+24
+
+ Immediately exits the
+ manager (only available for --user
+ instances).
+
+
+
+ SIGRTMIN+26
+ SIGRTMIN+27
+ SIGRTMIN+28
+
+ Sets the log level to
+ journal-or-kmsg (or
+ console on
+ SIGRTMIN+27,
+ kmsg on
+ SIGRTMIN+28), as
+ controlled via
+ systemd.log_target=journal-or-kmsg
+ (or
+ systemd.log_target=console
+ on SIGRTMIN+27 or
+ systemd.log_target=kmsg
+ on SIGRTMIN+28)
+ on the kernel command
+ line.
+ Environment
-
+ $SYSTEMD_LOG_LEVELsystemd reads the
@@ -882,11 +966,21 @@
Kernel Command Line
- When run as system instance systemd parses a few kernel command line arguments:
-
-
+ When run as system instance systemd parses a
+ number of kernel command line
+ argumentsIf run inside a Linux
+ container these arguments may be passed as command
+ line arguments to systemd itself, next to any of the
+ command line options listed in the Options section
+ above. If run outside of Linux containers, these
+ arguments are parsed from
+ /proc/cmdline
+ instead.:
+
+ systemd.unit=
+ rd.systemd.unit=Overrides the unit to
activate on boot. Defaults to
@@ -896,17 +990,21 @@
rescue.target or
emergency.service. See
systemd.special7
- for details about these
- units.
+ for details about these units. The
+ option prefixed with
+ rd. is honored
+ only in the initial RAM disk (initrd),
+ while the one that is not prefixed only
+ in the main system.systemd.dump_core=Takes a boolean
- argument. If
+ argument. If ,
systemd dumps core when it
- crashes. Otherwise no core dump is
+ crashes. Otherwise, no core dump is
created. Defaults to
.
@@ -915,9 +1013,9 @@
systemd.crash_shell=Takes a boolean
- argument. If
+ argument. If ,
systemd spawns a shell when it
- crashes. Otherwise no shell is
+ crashes. Otherwise, no shell is
spawned. Defaults to
, for security
reasons, as the shell is not protected
@@ -932,14 +1030,14 @@
argument. If positive systemd
activates the specified virtual
terminal when it crashes. Defaults to
- -1.
+ -1.
systemd.confirm_spawn=Takes a boolean
- argument. If
+ argument. If ,
asks for confirmation when spawning
processes. Defaults to
.
@@ -949,24 +1047,20 @@
systemd.show_status=Takes a boolean
- argument. If
- shows terse service status updates on
- the console during bootup. Defaults to
- .
-
-
-
- systemd.sysv_console=
-
- Takes a boolean
- argument. If
- output of SysV init scripts will be
- directed to the console. Defaults to
+ argument or the constant
+ auto. If
+ , shows terse
+ service status updates on the console
+ during bootup.
+ auto behaves like
+ until a service
+ fails or there is a significant delay
+ in boot. Defaults to
, unless
is passed as
kernel command line option in which
case it defaults to
- .
+ auto.
@@ -981,7 +1075,133 @@
environment variables described above.
+
+ systemd.default_standard_output=
+ systemd.default_standard_error=
+ Controls default
+ standard output and error output for
+ services, with the same effect as the
+
+ and
+ command line arguments described
+ above, respectively.
+
+
+
+ systemd.setenv=
+
+ Takes a string
+ argument in the form VARIABLE=VALUE.
+ May be used to set default environment
+ variables to add to forked child processes.
+ May be used more than once to set multiple
+ variables.
+
+
+
+ quiet
+
+ Turn off
+ status output at boot, much like
+ systemd.show_status=false
+ would. Note that this option is also
+ read by the kernel itself and disables
+ kernel log output. Passing this option
+ hence turns off the usual output from
+ both the system manager and the kernel.
+
+
+
+
+ debug
+
+ Turn on debugging
+ output. This is equivalent to
+ systemd.log_level=debug.
+ Note that this option is also read by
+ the kernel itself and enables kernel
+ debug output. Passing this option
+ hence turns on the debug output from
+ both the system manager and the
+ kernel.
+
+
+
+ emergency
+ -b
+
+ Boot into emergency
+ mode. This is equivalent to
+ systemd.unit=emergency.target
+ and provided for compatibility reasons
+ and to be easier to
+ type.
+
+
+
+ rescue
+ single
+ s
+ S
+ 1
+
+ Boot into rescue
+ mode. This is equivalent to
+ systemd.unit=rescue.target
+ and provided for compatibility reasons
+ and to be easier to
+ type.
+
+
+
+ 2
+ 3
+ 4
+ 5
+
+ Boot into the
+ specified legacy SysV runlevel. These
+ are equivalent to
+ systemd.unit=runlevel2.target,
+ systemd.unit=runlevel3.target,
+ systemd.unit=runlevel4.target,
+ and systemd.unit=runlevel5.target, respectively,
+ and provided for compatibility reasons
+ and to be easier to
+ type.
+
+
+
+ locale.LANG=
+ locale.LANGUAGE=
+ locale.LC_CTYPE=
+ locale.LC_NUMERIC=
+ locale.LC_TIME=
+ locale.LC_COLLATE=
+ locale.LC_MONETARY=
+ locale.LC_MESSAGES=
+ locale.LC_PAPER=
+ locale.LC_NAME=
+ locale.LC_ADDRESS=
+ locale.LC_TELEPHONE=
+ locale.LC_MEASUREMENT=
+ locale.LC_IDENTIFICATION=
+
+ Set the system locale
+ to use. This overrides the settings in
+ /etc/locale.conf. For
+ more information see
+ locale.conf5
+ and
+ locale7.
+
+
+
+ For other kernel command line parameters
+ understood by components of the core OS, please refer
+ to
+ kernel-command-line7.
@@ -989,53 +1209,37 @@
- @/org/freedesktop/systemd1/notify
+ /run/systemd/notifyDaemon status
- notification socket. This is an AF_UNIX
- datagram socket in the Linux abstract
- namespace, and is used to implement
- the daemon notification logic as
- implemented by
+ notification socket. This is an
+ AF_UNIX datagram socket and is used to
+ implement the daemon notification
+ logic as implemented by
sd_notify3.
- @/org/freedesktop/systemd1/logger
-
- Used internally by the
- systemd-logger.service
- unit to connect STDOUT and/or STDERR
- of spawned processes to
- syslog3
- or the kernel log buffer. This is an
- AF_UNIX stream socket in the Linux
- abstract namespace.
-
-
-
- @/org/freedesktop/systemd1/shutdown
+ /run/systemd/shutdowndUsed internally by the
shutdown8
tool to implement delayed
- shutdowns. This is an AF_UNIX datagram
- socket in the Linux abstract
- namespace.
+ shutdowns. This is an AF_UNIX datagram
+ socket.
- @/org/freedesktop/systemd1/private
+ /run/systemd/privateUsed internally as
communication channel between
systemctl1
and the systemd process. This is an
- AF_UNIX stream socket in the Linux
- abstract namespace. This interface is
- private to systemd and should not be
- used in external
+ AF_UNIX stream socket. This interface
+ is private to systemd and should not
+ be used in external
projects.
@@ -1057,14 +1261,20 @@
See Also
+ The systemd Homepage,
+ systemd-system.conf5,
+ locale.conf5,
systemctl1,
- systemadm1,
+ journalctl1,
systemd-notify1,
daemon7,
- sd-daemon7,
+ sd-daemon3,
systemd.unit5,
systemd.special5,
- pkg-config1
+ pkg-config1,
+ kernel-command-line7,
+ bootup7,
+ systemd.directives7