tmpfiles: introduce type X

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 3c0a7950a0ab367f20961f8ca543ed311d668f1e..60a0f401bdc139537b327bd679d2fc97b46b26af 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -106,6 +106,11 @@
                                 certain unit types. If not specified
                                 units of in all load states will be
                                 shown.</para>
                                 certain unit types. If not specified
                                 units of in all load states will be
                                 shown.</para>

+
+                                <para>As a special case, if the argument
+                                is <option>help</option>, a list of
+                                allowed values will be printed and the
+                                program will exit.</para>

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


@@ -151,7 +156,7 @@
                                 <term><option>--full</option></term>
 
                                 <listitem><para>Do not ellipsize unit
                                 <term><option>--full</option></term>
 
                                 <listitem><para>Do not ellipsize unit

-                                names and truncate unit descriptions
+                                names, cgroup members, and truncate unit descriptions

                                 in the output of
                                 <command>list-units</command> and
                                 <command>list-jobs</command>.</para></listitem>
                                 in the output of
                                 <command>list-units</command> and
                                 <command>list-jobs</command>.</para></listitem>


@@ -178,13 +183,40 @@
                                 execute it immediately. If passed no
                                 required units of the unit passed will
                                 be pulled in, and no ordering
                                 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
                                 applications.</para></listitem>
                         </varlistentry>
 
                                 mostly a debugging and rescue tool for
                                 the administrator and should not be
                                 used by
                                 applications.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>-i</option></term>
+                                <term><option>--ignore-inhibitors</option></term>
+
+                                <listitem><para>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
+                                <option>--ignore-inhibitors</option>
+                                is specified the locks are ignored and
+                                not printed, and the operation
+                                attempted anyway, possibly requiring
+                                additional
+                                privileges.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--quiet</option></term>
                                 <term><option>-q</option></term>
                         <varlistentry>
                                 <term><option>--quiet</option></term>
                                 <term><option>-q</option></term>


@@ -193,6 +225,7 @@
                                 STDOUT in
                                 <command>snapshot</command>,
                                 <command>is-active</command>,
                                 STDOUT in
                                 <command>snapshot</command>,
                                 <command>is-active</command>,

+                                <command>is-failed</command>,

                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>
                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>


@@ -442,17 +475,6 @@
                                 10.</para></listitem>
                         </varlistentry>
 
                                 10.</para></listitem>
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><option>--follow</option></term>
-                                <term><option>-f</option></term>
-
-                                <listitem><para>When used with
-                                <command>status</command> continuously
-                                prints new journal entries as they are
-                                appended to the
-                                journal.</para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><option>--output=</option></term>
                                 <term><option>-o</option></term>
                         <varlistentry>
                                 <term><option>--output=</option></term>
                                 <term><option>-o</option></term>


@@ -606,6 +628,18 @@
                                 this will also print the current unit
                                 state to STDOUT.</para></listitem>
                         </varlistentry>
                                 this will also print the current unit
                                 state to STDOUT.</para></listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><command>is-failed [NAME...]</command></term>
+
+                                <listitem><para>Check whether any of
+                                the specified units are failed.
+                                Returns an exit code
+                                0 if at least one is failed, non-zero
+                                otherwise. Unless
+                                <option>--quiet</option> is specified
+                                this will also print the current unit
+                                state to STDOUT.</para></listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><command>status [NAME...|PID...]</command></term>
 
                         <varlistentry>
                                 <term><command>status [NAME...|PID...]</command></term>
 


@@ -682,24 +716,29 @@
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 

-                                <listitem><para>Enable one or more
-                                unit files, as specified on the
+                                <listitem><para>Enable one or
+                                more unit files or unit file
+                                instances, as specified on the

                                 command line. This will create a
                                 command line. This will create a

-                                number of symlinks as encoded in the
-                                <literal>[Install]</literal> sections
-                                of the unit files. After the symlinks
-                                have been created the systemd
-                                configuration is reloaded (in a way
-                                that is equivalent to
-                                <command>daemon-reload</command>) to
-                                ensure the changes are taken into
+                                number of symlinks as encoded in
+                                the <literal>[Install]</literal>
+                                sections of the unit files. After
+                                the symlinks have been created the
+                                systemd configuration is reloaded
+                                (in a way that is equivalent to
+                                <command>daemon-reload</command>)
+                                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
                                 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 <command>start</command>
-                                command must be invoked for the
-                                unit.</para>
+                                the same time.  If this is desired
+                                a separate <command>start</command>
+                                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.</para>

 
                                 <para>This command will
                                 print the actions executed. This
 
                                 <para>This command will
                                 print the actions executed. This


@@ -772,7 +811,7 @@
                                 configuration after completing the
                                 disabling of the units. Note that this
                                 command does not implicitly stop the
                                 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
                                 <command>stop</command> command should
                                 be executed afterwards.</para>
                                 is desired an additional
                                 <command>stop</command> command should
                                 be executed afterwards.</para>


@@ -795,7 +834,7 @@
                                 <term><command>is-enabled [NAME...]</command></term>
 
                                 <listitem><para>Checks whether any of
                                 <term><command>is-enabled [NAME...]</command></term>
 
                                 <listitem><para>Checks whether any of

-                                the specified unit files is enabled
+                                the specified unit files are enabled

                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is
                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is


@@ -957,6 +996,19 @@
                                 ordering and requirement
                                 dependencies.</para></listitem>
                         </varlistentry>
                                 ordering and requirement
                                 dependencies.</para></listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><command>list-dependencies [NAME]</command></term>
+
+                                <listitem><para> Shows required and
+                                wanted units of the specified unit. If
+                                no unit is specified
+                                <filename>default.target</filename> is
+                                implied. Target units are recursively
+                                expanded.  When <option>--all</option>
+                                is passed all other units aare
+                                recursively expanded as well.</para>
+                                </listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><command>snapshot [NAME]</command></term>
 
                         <varlistentry>
                                 <term><command>snapshot [NAME]</command></term>
 


@@ -1102,7 +1154,7 @@
                                 mounted read-only, immediately
                                 followed by the system halt.  If
                                 <option>--force</option> is specified
                                 mounted read-only, immediately
                                 followed by the system halt.  If
                                 <option>--force</option> 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
                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data


@@ -1123,7 +1175,7 @@
                                 unmounted or mounted read-only,
                                 immediately followed by the powering
                                 off. If <option>--force</option> is
                                 unmounted or mounted read-only,
                                 immediately followed by the powering
                                 off. If <option>--force</option> 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
                                 immediately executed without
                                 terminating any processes or
                                 unmounting any file systems. This may


@@ -1144,7 +1196,7 @@
                                 unmounted or mounted read-only,
                                 immediately followed by the reboot. If
                                 <option>--force</option> is specified
                                 unmounted or mounted read-only,
                                 immediately followed by the reboot. If
                                 <option>--force</option> 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
                                 executed without terminating any
                                 processes or unmounting any file
                                 systems. This may result in data


@@ -1179,12 +1231,29 @@
                         <varlistentry>
                                 <term><command>suspend</command></term>
 
                         <varlistentry>
                                 <term><command>suspend</command></term>
 

-                                <listitem><para>Suspend the system.</para></listitem>
+                                <listitem><para>Suspend the
+                                system. This will trigger activation
+                                of the special
+                                <filename>suspend.target</filename>
+                                target.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>hibernate</command></term>
 
                         </varlistentry>
                         <varlistentry>
                                 <term><command>hibernate</command></term>
 

-                                <listitem><para>Hibernate the system.</para></listitem>
+                                <listitem><para>Hibernate the
+                                system. This will trigger activation
+                                of the special
+                                <filename>hibernate.target</filename>
+                                target.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>hybrid-sleep</command></term>
+
+                                <listitem><para>Hibernate and suspend
+                                the system. This will trigger
+                                activation of the special
+                                <filename>hybrid-sleep.target</filename>
+                                target.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>switch-root [ROOT] [INIT]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>switch-root [ROOT] [INIT]</command></term>