From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 16 Jan 2013 16:57:08 +0000 (+0100)
Subject: man: document logind's IdleAction= and IdleActionSec=
X-Git-Tag: v198~511
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=c29e06468cec7fac42b4a9b4ff735330d1ce71b5;ds=sidebyside

man: document logind's IdleAction= and IdleActionSec=
---

diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index df15d51b5..b602e2a5f 100644
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -141,6 +141,44 @@
                                 <literal>no</literal>.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>IdleAction=</varname></term>
+
+                                <listitem><para>Configures the action
+                                to take when the system is idle. Takes
+                                one of <literal>ignore</literal>,
+                                <literal>poweroff</literal>,
+                                <literal>reboot</literal>,
+                                <literal>halt</literal>,
+                                <literal>kexec</literal>,
+                                <literal>suspend</literal>,
+                                <literal>hibernate</literal>,
+                                <literal>hybrid-sleep</literal>,
+                                <literal>lock</literal>. Defaults to
+                                <literal>ignore</literal>.</para>
+
+                                <para>Note that this requires that
+                                user sessions correctly report the
+                                idle status to the system. The system
+                                will execute the action after all
+                                sessions reported that they are idle,
+                                and no idle inhibitor lock is active,
+                                and subsquently the time configured
+                                with <varname>IdleActionSec=</varname>
+                                (see below) has passed.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>IdleActionSec=</varname></term>
+
+                                <listitem><para>Configures the delay
+                                after which the action configured in
+                                <varname>IdleAction=</varname> (see
+                                above) is taken after the system is
+                                idle.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>KillOnlyUsers=</varname></term>
                                 <term><varname>KillExcludeUsers=</varname></term>