diff options
| author | Lennart Poettering <lennart@poettering.net> | 2012-06-29 02:07:40 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2012-06-29 16:14:43 +0200 |
| commit | 5b6a2c5aab9893ba82acf90696f83e4d48db2b19 (patch) | |
| tree | 97063613933fe0efe539b0f288f2deb13ac470b0 | |
| parent | 8eba616fc09b854d13de5dacc5b31b1009c4e8d4 (diff) | |
man: add references to the new inhibitor lock documentation
| -rw-r--r-- | TODO | 4 | ||||
| -rw-r--r-- | man/systemd-inhibit.xml | 28 | ||||
| -rw-r--r-- | man/systemd-logind.service.xml | 7 |
3 files changed, 33 insertions, 6 deletions
@@ -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 bea4724787..81ec9ef9ab 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> @@ -169,6 +175,18 @@ </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> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 05fcde3089..436c2772c3 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> |