From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 29 Jun 2012 00:07:40 +0000 (+0200)
Subject: man: add references to the new inhibitor lock documentation
X-Git-Tag: v186~34
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=5b6a2c5aab9893ba82acf90696f83e4d48db2b19

man: add references to the new inhibitor lock documentation
---

diff --git a/TODO b/TODO
index 0496c0608..01b5edcd2 100644
--- a/TODO
+++ b/TODO
@@ -25,6 +25,10 @@ Bugfixes:
 
 Features:
 
+* logind: export a bool property that tells user whether a
+  suspend/shutdown is currently scheduled, i.e. where are between
+  PrepareForSuspend(true) and PrepareForSuspend(false)
+
 * support debian's console-setup logic
 
 * introduce Type=pid-file
diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml
index bea472478..81ec9ef9a 100644
--- a/man/systemd-inhibit.xml
+++ b/man/systemd-inhibit.xml
@@ -71,6 +71,10 @@
                 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>
@@ -103,10 +107,14 @@
                                 <literal>shutdown</literal>,
                                 <literal>sleep</literal>,
                                 <literal>idle</literal>, for
-                                inhibiting reboot/power-off/halt/kexec,
+                                inhibiting
+                                reboot/power-off/halt/kexec,
                                 suspending/hibernating, resp. the
-                                automatic idle
-                                detection.</para></listitem>
+                                automatic idle detection. If ommitted
+                                defaults to
+                                <literal>idle:sleep:shutdown</literal>,
+                                i.e. takes all possible
+                                locks.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -156,8 +164,6 @@
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>
-
-
                 </variablelist>
 
         </refsect1>
@@ -168,6 +174,18 @@
                 <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>
diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml
index 05fcde308..436c2772c 100644
--- a/man/systemd-logind.service.xml
+++ b/man/systemd-logind.service.xml
@@ -109,9 +109,14 @@
 
                 <para>See the <ulink
                 url="http://www.freedesktop.org/wiki/Software/systemd/logind">
-                developer documentation</ulink> for information about
+                logind D-Bus API Documentation</ulink> for information about
                 the APIs <filename>systemd-logind</filename>
                 provides.</para>
+
+                <para>For more information on the inhibition logic see
+                the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
+                Lock Developer Documentation</ulink>.</para>
         </refsect1>
 
         <refsect1>