binfmt,tmpfiles,modules-load,sysctl: rework the various early-boot services that...

[elogind.git] / man / systemd-inhibit.xml

diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml
index 34095902c2b2ac40e9d699ea1a597ee9cada92b7..6f63c8c73e5d0e145fa0a509f3b391ce6d99e101 100644 (file)
--- a/man/systemd-inhibit.xml
+++ b/man/systemd-inhibit.xml
@@ -60,17 +60,21 @@
                 <title>Description</title>
 
                 <para><command>systemd-inhibit</command> may be used
                 <title>Description</title>
 
                 <para><command>systemd-inhibit</command> may be used

-                to execute a program with a shutdown, suspend or idle
+                to execute a program with a shutdown, sleep or idle

                 inhibitor lock taken. The lock will be acquired before
                 the specified command line is executed and released
                 afterwards.</para>
 
                 <para>Inhibitor locks may be used to block or delay
                 inhibitor lock taken. The lock will be acquired before
                 the specified command line is executed and released
                 afterwards.</para>
 
                 <para>Inhibitor locks may be used to block or delay

-                suspend and shutdown requests from the user, as well
-                as automatic idle handling of the OS. This may be used
+                system sleep and shutdown requests from the user, as well
+                as automatic idle handling of the OS. This is useful

                 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


@@ -101,12 +105,20 @@
                                 separated list of one or more
                                 operations to inhibit:
                                 <literal>shutdown</literal>,
                                 separated list of one or more
                                 operations to inhibit:
                                 <literal>shutdown</literal>,

-                                <literal>suspend</literal>,
-                                <literal>idle</literal>, for
-                                inhibiting reboot/power-off/halt/kexec,
-                                suspending/hibernating, resp. the
-                                automatic idle
-                                detection.</para></listitem>
+                                <literal>sleep</literal>,
+                                <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>
                         </varlistentry>
 
                         <varlistentry>


@@ -146,7 +158,11 @@
                                 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 for <literal>sleep</literal>
+                                and
+                                <literal>shutdown</literal>.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -156,8 +172,6 @@
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>

-
-

                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>


@@ -168,6 +182,18 @@
                 <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>