along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
-<refentry id="systemd-inhibit">
+<refentry id="systemd-inhibit"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-inhibit</title>
to avoid system suspends while an optical disc is
being recorded, or similar operations that should not
be interrupted.</para>
+
+ <para>For more information see the <ulink
+ url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
+ Lock Developer Documentation</ulink>.</para>
</refsect1>
<refsect1>
<para>The following options are understood:</para>
<variablelist>
- <varlistentry>
- <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>--version</option></term>
-
- <listitem><para>Prints a short version
- string and exits.</para></listitem>
- </varlistentry>
-
<varlistentry>
<term><option>--what=</option></term>
- <listitem><para>Takes a colon
- separated list of one or more
+ <listitem><para>Takes a colon-separated
+ list of one or more
operations to inhibit:
<literal>shutdown</literal>,
<literal>sleep</literal>,
- <literal>idle</literal>, for
- inhibiting reboot/power-off/halt/kexec,
- suspending/hibernating, resp. the
- automatic idle
- detection.</para></listitem>
+ <literal>idle</literal>,
+ <literal>handle-power-key</literal>,
+ <literal>handle-suspend-key</literal>,
+ <literal>handle-hibernate-key</literal>,
+ <literal>handle-lid-switch</literal>,
+ for inhibiting
+ reboot/power-off/halt/kexec,
+ suspending/hibernating, the automatic
+ idle detection, or the low-level
+ handling of the power/sleep key and
+ the lid switch, respectively. If omitted,
+ defaults to
+ <literal>idle:sleep:shutdown</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--who=</option></term>
- <listitem><para>Takes a short human
- readable descriptive string for the
- program taking the lock. If not passed
+ <listitem><para>Takes a short,
+ human-readable descriptive string for the
+ program taking the lock. If not passed,
defaults to the command line
string.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--why=</option></term>
- <listitem><para>Takes a short human
- readable descriptive string for the
+ <listitem><para>Takes a short,
+ human-readable descriptive string for the
reason for taking the lock. Defaults
to "Unknown reason".</para></listitem>
</varlistentry>
<literal>delay</literal> is used, the
lock can only delay the requested
operations for a limited time. If the
- time elapses the lock is ignored and
+ time elapses, the lock is ignored and
the operation executed. The time limit
may be specified in
- <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
+ <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
+ that <literal>delay</literal> is only
+ available for <literal>sleep</literal>
+ and
+ <literal>shutdown</literal>.</para></listitem>
</varlistentry>
<varlistentry>
one.</para></listitem>
</varlistentry>
-
+ <xi:include href="standard-options.xml" xpointer="help" />
+ <xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
</refsect1>
<para>Returns the exit status of the executed program.</para>
</refsect1>
+ <refsect1>
+ <title>Example</title>
+
+ <programlisting># systemd-inhibit wodim foobar.iso</programlisting>
+
+ <para>This burns the ISO image
+ <filename>foobar.iso</filename> on a CD using
+ <citerefentry project='man-pages'><refentrytitle>wodim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ and inhibits system sleeping, shutdown and idle while
+ doing so.</para>
+ </refsect1>
+
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>