chiark / gitweb /
Move systemctl dot to systemd-analyze dot
[elogind.git] / man / systemctl.xml
index fedc5887668c8e14a16568d3f0d328770a8c4ad9..7f7064214e907a22628518ddd071ac3880a39594 100644 (file)
@@ -69,8 +69,8 @@
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>--help</option></term>
                                 <term><option>-h</option></term>
+                                <term><option>--help</option></term>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
@@ -84,8 +84,8 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--type=</option></term>
                                 <term><option>-t</option></term>
+                                <term><option>--type=</option></term>
 
                                 <listitem><para>The argument should
                                 be a unit type name such as
                                 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>
 
                         <varlistentry>
-                                <term><option>--property=</option></term>
                                 <term><option>-p</option></term>
+                                <term><option>--property=</option></term>
 
                                 <listitem><para>When showing
                                 unit/job/manager properties, limit
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--all</option></term>
                                 <term><option>-a</option></term>
+                                <term><option>--all</option></term>
 
                                 <listitem><para>When listing units,
                                 show all units, regardless of their
                                 <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>
                                 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
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--quiet</option></term>
+                                <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>-q</option></term>
+                                <term><option>--quiet</option></term>
 
                                 <listitem><para>Suppress output to
                                 STDOUT in
                                 <command>snapshot</command>,
                                 <command>is-active</command>,
+                                <command>is-failed</command>,
                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>
                                 manager of the calling user.</para></listitem>
                         </varlistentry>
 
-                        <varlistentry>
-                                <term><option>--order</option></term>
-                                <term><option>--require</option></term>
-
-                                <listitem><para>When used in
-                                conjunction with the
-                                <command>dot</command> command (see
-                                below), selects which dependencies are
-                                shown in the dependency graph. If
-                                <option>--order</option> is passed
-                                only dependencies of type
-                                <varname>After=</varname> or
-                                <varname>Before=</varname> are
-                                shown. If <option>--require</option>
-                                is passed only dependencies of type
-                                <varname>Requires=</varname>,
-                                <varname>RequiresOverridable=</varname>,
-                                <varname>Requisite=</varname>,
-                                <varname>RequisiteOverridable=</varname>,
-                                <varname>Wants=</varname> and
-                                <varname>Conflicts=</varname> are
-                                shown. If neither is passed, shows
-                                dependencies of all these
-                                types.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>--no-wall</option></term>
 
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--signal=</option></term>
                                 <term><option>-s</option></term>
+                                <term><option>--signal=</option></term>
 
                                 <listitem><para>When used with
                                 <command>kill</command>, choose which
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--force</option></term>
                                 <term><option>-f</option></term>
+                                <term><option>--force</option></term>
 
                                 <listitem><para>When used with
                                 <command>enable</command>, overwrite any
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--lines=</option></term>
                                 <term><option>-n</option></term>
+                                <term><option>--lines=</option></term>
 
                                 <listitem><para>When used with
                                 <command>status</command> controls the
                         </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>
+                                <term><option>--output=</option></term>
 
                                 <listitem><para>When used with
                                 <command>status</command> controls the
                                 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>
 
                                 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>
                                 <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
                                 applications.</para></listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term><command>dot</command></term>
+                                <term><command>list-dependencies [NAME]</command></term>
 
-                                <listitem><para>Generate textual
-                                dependency graph description in dot
-                                format for further processing with the
-                                GraphViz
-                                <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                                tool. Use a command line like
-                                <command>systemctl dot | dot -Tsvg >
-                                systemd.svg</command> to generate a
-                                graphical dependency tree. Unless
-                                <option>--order</option> or
-                                <option>--require</option> is passed
-                                the generated graph will show both
-                                ordering and requirement
-                                dependencies.</para></listitem>
+                                <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>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>
 
-                                <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>
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when