chiark / gitweb /
systemctl add command list-dependencies
[elogind.git] / man / systemctl.xml
index fedc5887668c8e14a16568d3f0d328770a8c4ad9..f22338371635d170530ba703c43f0805903401ff 100644 (file)
                                 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>
 
                                 <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>
                                 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>
                                 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>
                                 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>
                                 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>
 
                                 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>
                                 <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
                                 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 given unit.
+                                Target units are recursively expanded.
+                                When <option>--all</option> is passed
+                                dependency tree is generated for all
+                                subsidiary units.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><command>snapshot [NAME]</command></term>
 
                         <varlistentry>
                                 <term><command>snapshot [NAME]</command></term>
 
                         <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>