<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>
</varlistentry>
<varlistentry>
- <term><option>--type=</option></term>
<term><option>-t</option></term>
+ <term><option>--type=</option></term>
- <listitem><para>When listing units,
- limit display to certain unit
- types. If not specified units of all
- types will be shown. The argument
- should be a unit type name such as
- <option>service</option>,
- <option>socket</option> and
- similar.</para></listitem>
+ <listitem><para>The argument should
+ be a unit type name such as
+ <option>service</option> and
+ <option>socket</option>,
+ or a unit load state such as
+ <option>loaded</option> and
+ <option>masked</option>.
+ </para>
+
+ <para>If the argument is a unit type,
+ when listing units, limit display to
+ certain unit types. If not specified
+ units of all types will be shown.</para>
+
+ <para>If the argument is a unit load state,
+ when listing units, limit display to
+ 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>
<varlistentry>
<term><option>--no-legend</option></term>
- <listitem><para>Do not print a legend, i.e.
+
<listitem><para>Do not print a legend, i.e.
the column headers and the footer with hints.
- </para></listitem>
- </varlistentry>
+ </para></listitem>
+ </varlistentry>
<varlistentry>
<term><option>--no-pager</option></term>
- <listitem><para>Do not pipe output into a
- pager.</para></listitem>
- </varlistentry>
+
<listitem><para>Do not pipe output into a
+ pager.</para></listitem>
+ </varlistentry>
<varlistentry>
<term><option>--system</option></term>
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>, override any
+ <command>enable</command>, overwrite any
existing conflicting
symlinks.</para></listitem>
</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> continously
- 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>
looking for formatted human-readable
output.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><command>help [NAME...|PID...]</command></term>
+ <listitem><para>Show manual pages for
+ one or more units, if available. If a
+ PID is passed the manual pages for the
+ unit the process of the PID belongs to
+ is shown.</para></listitem>
+ </varlistentry>
<varlistentry>
<term><command>reset-failed [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
- 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
- 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
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
+ <command>stop</command> command should
be executed afterwards.</para>
<para>This command will print the
<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
<listitem><para>Reset one or more unit
files, as specified on the command
- line, to the defaults configured in a
- preset file. This has the same effect
- as <command>disable</command> or
+ line, to the defaults configured in
+ the preset policy files. This has the
+ same effect as
+ <command>disable</command> or
<command>enable</command>, depending
how the unit is listed in the preset
- files.</para>
+ files. For more information on preset
+ policy format see
+ <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
+ more information on the concept of
+ presets please consult the <ulink
+ url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
+ document.</para>
</listitem>
</varlistentry>
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>
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
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
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
<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>
directory, and the path to the new
system manager binary below it to
execute as PID 1. If the latter is
- ommitted or the empty string, a
+ omitted or the empty string, a
systemd binary will automatically be
searched for and used as init. If the
- system manager path is ommitted or
+ system manager path is omitted or
equal the empty string the state of
the initrd's system manager process is
passed to the main system manager,
<refsect1>
<title>Environment</title>
- <variablelist>
+ <variablelist class='environment-variables'>
<varlistentry>
<term><varname>$SYSTEMD_PAGER</varname></term>
<listitem><para>Pager to use when
<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
~ianmdlvl / elogind.git / blobdiff