chiark / gitweb /
man: describe OBJECT_PID=
[elogind.git] / man / logind.conf.xml
index 3d83d2c81ce7942823afe7ab540eb0825720a2d5..b7109353cab9857c08993a249f7bf626e5b1a333 100644 (file)
@@ -22,7 +22,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="logind.conf">
+<refentry id="logind.conf" conditional='ENABLE_LOGIND'>
         <refentryinfo>
                 <title>logind.conf</title>
                 <productname>systemd</productname>
                                 <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 subsequently 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>
 
                                 <listitem><para>These settings take
-                                space separated lists of user names
+                                space-separated lists of usernames
                                 that influence the effect of
                                 <varname>KillUserProcesses=</varname>. If
-                                not empty only processes of users
+                                not empty, only processes of users
                                 listed in
                                 <varname>KillOnlyUsers</varname> will
                                 be killed when they log out
 
                                 <listitem><para>These settings control
                                 the default control group hierarchies
-                                users logging in are added to. When
-                                logging in users will get private
-                                control groups in all hierarchies
-                                listed in
+                                users logging in are added to, in
+                                addition to the
+                                <literal>name=systemd</literal> named
+                                hierarchy. These settings take
+                                space-separated lists of controller
+                                names. Pass the empty string to ensure
+                                that logind does not touch any
+                                hierarchies but systemd's own. When
+                                logging in, user sessions will get
+                                private control groups in all
+                                hierarchies listed in
                                 <varname>Controllers=</varname> and be
                                 reset to the root control group in all
                                 hierarchies listed in
                                 defaults to the empty list,
                                 <varname>ResetControllers=</varname>
                                 defaults to
-                                <literal>cpu</literal>.</para></listitem>
+                                <literal>cpu</literal>. Note that for
+                                all controllers that are not listed in
+                                either <varname>Controllers=</varname>
+                                or
+                                <varname>ResetControllers=</varname>,
+                                newly created sessions will be part of
+                                the control groups of the system
+                                service that created the
+                                session.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <literal>poweroff</literal>,
                                 <literal>reboot</literal>,
                                 <literal>halt</literal>,
-                                <literal>kexec</literal> and
-                                <literal>hibernate</literal>. If
-                                <literal>ignore</literal> logind will
-                                never handle these keys. Otherwise the
-                                specified action will be taken in the
-                                respective event. Only input devices
-                                with the
+                                <literal>kexec</literal>,
+                                <literal>suspend</literal>,
+                                <literal>hibernate</literal>,
+                                <literal>hybrid-sleep</literal> and
+                                <literal>lock</literal>. If
+                                <literal>ignore</literal>, logind will
+                                never handle these keys. If
+                                <literal>lock</literal>, all running
+                                sessions will be screen-locked; otherwise,
+                                the specified action
+                                will be taken in the respective
+                                event. Only input devices with the
                                 <literal>power-switch</literal> udev
                                 tag will be watched for key/lid switch
                                 events. <varname>HandlePowerKey=</varname>
                                 sleep keys and the lid switch are
                                 subject to inhibitor locks. These
                                 settings take boolean arguments. If
-                                <literal>off</literal> the inhibitor
+                                <literal>off</literal>, the inhibitor
                                 locks taken by applications in order
                                 to block the requested operation are
-                                respected, if <literal>on</literal>
+                                respected, if <literal>on</literal>,
                                 the requested operation is executed in
                                 any
                                 case. <varname>PowerKeyIgnoreInhibited=</varname>,
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>