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>
<refsect1>
<title>Description</title>
- <para>This file configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+ <para>This file configures various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
<listitem><para>Takes a positive
integer. Configures how many virtual
terminals (VTs) to allocate by default
- that -- when switched to and
- previously unused --
+ that, when switched to and are
+ previously unused,
<literal>autovt</literal> services are
automatically spawned on. These
services are instantiated from the
<filename>autovt@.service</filename>
for the respective VT TTY name,
e.g. <filename>autovt@tty4.service</filename>. By
- default
+ default,
<filename>autovt@.service</filename>
is linked to
<filename>getty@.service</filename>,
<literal>gettys</literal> are
available on the VTs. If a VT is
already used by some other subsystem
- (for example a graphical login) this
+ (for example a graphical login), this
kind of activation will not be
attempted. Note that the VT configured
in <varname>ReserveVT=</varname> is
directive. Defaults to 6. When set to
0, automatic spawning of
<literal>autovt</literal> services is
- disabled. </para></listitem>
+ disabled.</para></listitem>
</varlistentry>
<varlistentry>
<filename>autovt@.service</filename>
activation (see above). The VT
selected with this option will be
- marked busy unconditionally so that no
+ marked busy unconditionally, so that no
other subsystem will allocate it. This
functionality is useful to ensure that
- regardless how many VTs are allocated
- by other subsystems one login
+ regardless of how many VTs are allocated
+ by other subsystems, one login
<literal>getty</literal> is always
- available. Defaults to 6 (with other
- words: there'll always be a
+ available. Defaults to 6 (in other
+ words, there will always be a
<literal>getty</literal> available on
Alt-F6.). When set to 0, VT
reservation is
processes of a user should be killed
when she or he completely logs out (i.e. after
her/his last session ended). Defaults to
- <literal>no</literal>.</para></listitem>
+ <literal>no</literal>.</para>
+
+ <para>Note that setting
+ <varname>KillUserProcesses=1</varname>
+ will break tools like
+ <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
<varlistentry>
<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
+ <varname>KillOnlyUsers=</varname> will
be killed when they log out
entirely. Processes of users listed in
<varname>KillExcludeUsers=</varname>
killed. <varname>KillExcludeUsers=</varname>
defaults to <literal>root</literal>
and takes precedence over
- <varname>KillOnlyUsers=</varname>
+ <varname>KillOnlyUsers=</varname>,
which defaults to the empty list.</para></listitem>
</varlistentry>
<varlistentry>
- <term><varname>Controllers=</varname></term>
- <term><varname>ResetControllers=</varname></term>
-
- <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
- <varname>Controllers=</varname> and be
- reset to the root control group in all
- hierarchies listed in
- <varname>ResetControllers=</varname>. <varname>Controllers=</varname>
- defaults to the empty list,
- <varname>ResetControllers=</varname>
- defaults to
- <literal>cpu</literal>.</para></listitem>
+ <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 report that they are idle,
+ no idle inhibitor lock is active,
+ and subsequently, the time configured
+ with <varname>IdleActionSec=</varname>
+ (see below) has expired.</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>
time a system shutdown or sleep
request is delayed due to an inhibitor
lock of type <literal>delay</literal>
- being active -- before it is ignored
- and the operation executed
+ being active before the inhibitor is
+ ignored and the operation executes
anyway. Defaults to
5s.</para></listitem>
</varlistentry>
<literal>halt</literal>,
<literal>kexec</literal>,
<literal>suspend</literal>,
- <literal>hibernate</literal>, and
- <literal>hybrid-sleep</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>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>,
<varname>SuspendKeyIgnoreInhibited=</varname>
and
<varname>HibernateKeyIgnoreInhibited=</varname>
- defaults to <literal>off</literal>,
+ default to <literal>off</literal>.
<varname>LidSwitchIgnoreInhibited=</varname>
defaults to
<literal>yes</literal>. This means
</varlistentry>
</variablelist>
-
- <para>Note that setting
- <varname>KillUserProcesses=1</varname> will break tools
- like
- <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
-
- <para>Note that <varname>KillUserProcesses=1</varname>
- is a weaker version of
- <varname>kill-session-processes=1</varname> which may
- be configured per-service for
- <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The
- latter kills processes of a session as soon as it
- ends, the former kills processes as soon as the last
- session of the user ends.</para>
</refsect1>
<refsect1>
<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>