zsh_completion: Split out zsh _systemd-analyze

[elogind.git] / man / systemd.xml

diff --git a/man/systemd.xml b/man/systemd.xml
index 497dd2bfeeb635a78ab8f835fff303ce7922bab4..32bca0b607bd00f34e6a6ad8221d7016d1ebd43c 100644 (file)
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -285,25 +285,27 @@
                 <title>Concepts</title>
 
                 <para>systemd provides a dependency system between
                 <title>Concepts</title>
 
                 <para>systemd 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

                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                 however some are created automatically from other
                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                 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
                 reference. Note that the various unit types may have a
                 number of additional substates, which are mapped to
                 the five generalized unit states described


@@ -312,7 +314,7 @@
                 <para>The following unit types are available:</para>
 
                 <orderedlist>
                 <para>The following unit types are available:</para>
 
                 <orderedlist>

-                        <listitem><para>Service units, which control
+                        <listitem><para>Service units, which start and control

                         daemons and the processes they consist of. For
                         details see
                         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
                         daemons and the processes they consist of. For
                         details see
                         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>


@@ -369,6 +371,18 @@
                         objects change or are modified. See
                         <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 
                         objects change or are modified. See
                         <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 

+                        <listitem><para>Slice units may be used to
+                        group units which manage system processes
+                        (such as service and scope units) in a
+                        hierachial tree for resource management
+                        purposes. See
+                        <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
+
+                        <listitem><para>Scope units are similar to
+                        service units, but manage foreign processes
+                        instead of starting them as well. See
+                        <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
+

                 </orderedlist>
 
                 <para>Units are named as their configuration
                 </orderedlist>
 
                 <para>Units are named as their configuration


@@ -425,7 +439,7 @@
                 individual Linux control groups named after the unit
                 which they belong to in the private systemd
                 hierarchy. (see <ulink
                 individual Linux control groups named after the unit
                 which they belong to in the private systemd
                 hierarchy. (see <ulink

-                url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>
+                url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>

                 for more information about control groups, or short
                 "cgroups"). systemd uses this to effectively keep
                 track of processes. Control group information is
                 for more information about control groups, or short
                 "cgroups"). systemd uses this to effectively keep
                 track of processes. Control group information is


@@ -473,7 +487,7 @@
 
                 <para>Systemd contains native implementations of
                 various tasks that need to be executed as part of the
 
                 <para>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
                 <filename>/sys</filename> or
                 configures the loopback network device. It also sets
                 up and mounts various API file systems, such as
                 <filename>/sys</filename> or


@@ -611,7 +625,7 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

-                                <term>SIGTERM</term>
+                                <term><constant>SIGTERM</constant></term>

 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager
 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager


@@ -631,7 +645,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGINT</term>
+                                <term><constant>SIGINT</constant></term>

 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager will
 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager will


@@ -643,11 +657,11 @@
 
                                 <para>systemd user managers
                                 treat this signal the same way as
 
                                 <para>systemd user managers
                                 treat this signal the same way as

-                                SIGTERM.</para></listitem>
+                                <constant>SIGTERM</constant>.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGWINCH</term>
+                                <term><constant>SIGWINCH</constant></term>

 
                                 <listitem><para>When this signal is
                                 received the systemd system manager
 
                                 <listitem><para>When this signal is
                                 received the systemd system manager


@@ -663,7 +677,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGPWR</term>
+                                <term><constant>SIGPWR</constant></term>

 
                                 <listitem><para>When this signal is
                                 received the systemd manager
 
                                 <listitem><para>When this signal is
                                 received the systemd manager


@@ -675,7 +689,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGUSR1</term>
+                                <term><constant>SIGUSR1</constant></term>

 
                                 <listitem><para>When this signal is
                                 received the systemd manager will try
 
                                 <listitem><para>When this signal is
                                 received the systemd manager will try


@@ -684,7 +698,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGUSR2</term>
+                                <term><constant>SIGUSR2</constant></term>

 
                                 <listitem><para>When this signal is
                                 received the systemd manager will log
 
                                 <listitem><para>When this signal is
                                 received the systemd manager will log


@@ -695,7 +709,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGHUP</term>
+                                <term><constant>SIGHUP</constant></term>

 
                                 <listitem><para>Reloads the complete
                                 daemon configuration. This is mostly
 
                                 <listitem><para>Reloads the complete
                                 daemon configuration. This is mostly


@@ -704,7 +718,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+0</term>
+                                <term><constant>SIGRTMIN+0</constant></term>

 
                                 <listitem><para>Enters default mode, starts the
                                 <filename>default.target</filename>
 
                                 <listitem><para>Enters default mode, starts the
                                 <filename>default.target</filename>


@@ -714,7 +728,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+1</term>
+                                <term><constant>SIGRTMIN+1</constant></term>

 
                                 <listitem><para>Enters rescue mode,
                                 starts the
 
                                 <listitem><para>Enters rescue mode,
                                 starts the


@@ -725,7 +739,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+2</term>
+                                <term><constant>SIGRTMIN+2</constant></term>

 
                                 <listitem><para>Enters emergency mode,
                                 starts the
 
                                 <listitem><para>Enters emergency mode,
                                 starts the


@@ -736,7 +750,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+3</term>
+                                <term><constant>SIGRTMIN+3</constant></term>

 
                                 <listitem><para>Halts the machine,
                                 starts the
 
                                 <listitem><para>Halts the machine,
                                 starts the


@@ -747,7 +761,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+4</term>
+                                <term><constant>SIGRTMIN+4</constant></term>

 
                                 <listitem><para>Powers off the machine,
                                 starts the
 
                                 <listitem><para>Powers off the machine,
                                 starts the


@@ -758,7 +772,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+5</term>
+                                <term><constant>SIGRTMIN+5</constant></term>

 
                                 <listitem><para>Reboots the machine,
                                 starts the
 
                                 <listitem><para>Reboots the machine,
                                 starts the


@@ -769,7 +783,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+6</term>
+                                <term><constant>SIGRTMIN+6</constant></term>

 
                                 <listitem><para>Reboots the machine via kexec,
                                 starts the
 
                                 <listitem><para>Reboots the machine via kexec,
                                 starts the


@@ -780,31 +794,31 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+13</term>
+                                <term><constant>SIGRTMIN+13</constant></term>

 
                                 <listitem><para>Immediately halts the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
 
                                 <listitem><para>Immediately halts the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+14</term>
+                                <term><constant>SIGRTMIN+14</constant></term>

 
                                 <listitem><para>Immediately powers off the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
 
                                 <listitem><para>Immediately powers off the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+15</term>
+                                <term><constant>SIGRTMIN+15</constant></term>

 
                                 <listitem><para>Immediately reboots the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
 
                                 <listitem><para>Immediately reboots the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+16</term>
+                                <term><constant>SIGRTMIN+16</constant></term>

 
                                 <listitem><para>Immediately reboots the machine with kexec.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
 
                                 <listitem><para>Immediately reboots the machine with kexec.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+20</term>
+                                <term><constant>SIGRTMIN+20</constant></term>

 
                                 <listitem><para>Enables display of
                                 status messages on the console, as
 
                                 <listitem><para>Enables display of
                                 status messages on the console, as


@@ -815,7 +829,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+21</term>
+                                <term><constant>SIGRTMIN+21</constant></term>

 
                                 <listitem><para>Disables display of
                                 status messages on the console, as
 
                                 <listitem><para>Disables display of
                                 status messages on the console, as


@@ -826,23 +840,23 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+22</term>
-                                <term>SIGRTMIN+23</term>
+                                <term><constant>SIGRTMIN+22</constant></term>
+                                <term><constant>SIGRTMIN+23</constant></term>

 
                                 <listitem><para>Sets the log level to
                                 <literal>debug</literal>
                                 (or <literal>info</literal> on
 
                                 <listitem><para>Sets the log level to
                                 <literal>debug</literal>
                                 (or <literal>info</literal> on

-                                <literal>SIGRTMIN+23</literal>), as
+                                <constant>SIGRTMIN+23</constant>), as

                                 controlled via
                                 <varname>systemd.log_level=debug</varname>
                                 (or <varname>systemd.log_level=info</varname>
                                 controlled via
                                 <varname>systemd.log_level=debug</varname>
                                 (or <varname>systemd.log_level=info</varname>

-                                on <literal>SIGRTMIN+23</literal>) on
+                                on <constant>SIGRTMIN+23</constant>) on

                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+24</term>
+                                <term><constant>SIGRTMIN+24</constant></term>

 
                                 <listitem><para>Immediately exits the
                                 manager (only available for --user
 
                                 <listitem><para>Immediately exits the
                                 manager (only available for --user


@@ -850,28 +864,28 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term>SIGRTMIN+26</term>
-                                <term>SIGRTMIN+27</term>
-                                <term>SIGRTMIN+28</term>
-                                <term>SIGRTMIN+29</term>
+                                <term><constant>SIGRTMIN+26</constant></term>
+                                <term><constant>SIGRTMIN+27</constant></term>
+                                <term><constant>SIGRTMIN+28</constant></term>
+                                <term><constant>SIGRTMIN+29</constant></term>

 
                                 <listitem><para>Sets the log level to
                                 <literal>journal-or-kmsg</literal>
                                 (or <literal>console</literal> on
 
                                 <listitem><para>Sets the log level to
                                 <literal>journal-or-kmsg</literal>
                                 (or <literal>console</literal> on

-                                <literal>SIGRTMIN+27</literal>,
+                                <constant>SIGRTMIN+27</constant>,

                                 <literal>kmsg</literal> on
                                 <literal>kmsg</literal> on

-                                <literal>SIGRTMIN+28</literal>,
+                                <constant>SIGRTMIN+28</constant>,

                                 or <literal>syslog-or-kmsg</literal>
                                 or <literal>syslog-or-kmsg</literal>

-                                on <literal>SIGRTMIN+29</literal>), as
+                                on <constant>SIGRTMIN+29</constant>), as

                                 controlled via
                                 <varname>systemd.log_target=journal-or-kmsg</varname>
                                 (or <varname>systemd.log_target=console</varname>
                                 controlled via
                                 <varname>systemd.log_target=journal-or-kmsg</varname>
                                 (or <varname>systemd.log_target=console</varname>

-                                on <literal>SIGRTMIN+27</literal>,
+                                on <constant>SIGRTMIN+27</constant>,

                                 <varname>systemd.log_target=kmsg</varname>
                                 <varname>systemd.log_target=kmsg</varname>

-                                on <literal>SIGRTMIN+28</literal>,
+                                on <constant>SIGRTMIN+28</constant>,

                                 or
                                 <varname>systemd.log_target=syslog-or-kmsg</varname>
                                 or
                                 <varname>systemd.log_target=syslog-or-kmsg</varname>

-                                on <literal>SIGRTMIN+29</literal>) on
+                                on <constant>SIGRTMIN+29</constant>) on

                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>
                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>


@@ -1044,7 +1058,7 @@
                                 argument. If positive systemd
                                 activates the specified virtual
                                 terminal when it crashes. Defaults to
                                 argument. If positive systemd
                                 activates the specified virtual
                                 terminal when it crashes. Defaults to

-                                <literal>-1</literal>.</para></listitem>
+                                <constant>-1</constant>.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -1099,16 +1113,11 @@
                                 <term><varname>systemd.setenv=</varname></term>
 
                                 <listitem><para>Takes a string
                                 <term><varname>systemd.setenv=</varname></term>
 
                                 <listitem><para>Takes a string

-                                argument in the form
-                                VARIABLE=VALUE. May be used to set
-                                environment variables for the init
-                                process and all its children at boot
-                                time. May be used more than once to
-                                set multiple variables. If the equal
-                                sign and variable are missing it unsets
-                                an environment variable which might be
-                                passed in from the initial ram
-                                disk.</para></listitem>
+                                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.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -1223,7 +1232,7 @@
 
                                 <listitem><para>Daemon status
                                 notification socket. This is an
 
                                 <listitem><para>Daemon status
                                 notification socket. This is an

-                                AF_UNIX datagram socket and is used to
+                                <constant>AF_UNIX</constant> datagram socket and is used to

                                 implement the daemon notification
                                 logic as implemented by
                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
                                 implement the daemon notification
                                 logic as implemented by
                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>


@@ -1236,7 +1245,7 @@
                                 <listitem><para>Used internally by the
                                 <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 tool to implement delayed
                                 <listitem><para>Used internally by the
                                 <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 tool to implement delayed

-                                shutdowns. This is an AF_UNIX datagram
+                                shutdowns. This is an <constant>AF_UNIX</constant> datagram

                                 socket.</para></listitem>
                         </varlistentry>
 
                                 socket.</para></listitem>
                         </varlistentry>
 


@@ -1247,7 +1256,7 @@
                                 communication channel between
                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                                 and the systemd process. This is an
                                 communication channel between
                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                                 and the systemd process. This is an

-                                AF_UNIX stream socket. This interface
+                                <constant>AF_UNIX</constant> stream socket. This interface

                                 is private to systemd and should not
                                 be used in external
                                 projects.</para></listitem>
                                 is private to systemd and should not
                                 be used in external
                                 projects.</para></listitem>