chiark / gitweb /
login: missing break for getopt ARG_NO_ASK_PASSWORD in loginctl
[elogind.git] / man / systemd-inhibit.xml
index c71a954428560ada2d2007bd85ec10881beb8791..f3ccee3bbbbe7d6c78902620ce9443e0e1082325 100644 (file)
                 to avoid system suspends while an optical disc is
                 being recorded, or similar operations that should not
                 be interrupted.</para>
                 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>
         </refsect1>
 
         <refsect1>
@@ -80,7 +84,7 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>--h</option></term>
+                                <term><option>-h</option></term>
                                 <term><option>--help</option></term>
 
                                 <listitem><para>Prints a short help
                                 <term><option>--help</option></term>
 
                                 <listitem><para>Prints a short help
                                 operations to inhibit:
                                 <literal>shutdown</literal>,
                                 <literal>sleep</literal>,
                                 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-sleep-key</literal>,
+                                <literal>handle-lid-switch</literal>,
+                                for inhibiting
+                                reboot/power-off/halt/kexec,
+                                suspending/hibernating, the automatic
+                                idle detection, resp. the low-level
+                                handling of the power/sleep key and
+                                the lid switch. If omitted defaults to
+                                <literal>idle:sleep:shutdown</literal>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
                                 time elapses the lock is ignored and
                                 the operation executed. The time limit
                                 may be specified in
                                 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>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
+                                that <literal>delay</literal> is only
+                                available or <literal>sleep</literal>
+                                and
+                                <literal>shutdown</literal>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>
-
-
                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>
                 <para>Returns the exit status of the executed program.</para>
         </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><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>
         <refsect1>
                 <title>See Also</title>
                 <para>