2011-06-29 04:27:53 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
2011-06-29 04:27:53 +04:00
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2011-06-29 04:27:53 +04:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2011-06-29 04:27:53 +04:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
2013-03-04 21:57:12 +04:00
<refentry id= "logind.conf" conditional= 'ENABLE_LOGIND' >
2011-06-29 04:27:53 +04:00
<refentryinfo >
2012-03-31 01:18:33 +04:00
<title > logind.conf</title>
2011-06-29 04:27:53 +04:00
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
2012-03-31 01:18:33 +04:00
<refentrytitle > logind.conf</refentrytitle>
2011-06-29 04:27:53 +04:00
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
2012-03-31 01:18:33 +04:00
<refname > logind.conf</refname>
2012-03-16 02:25:14 +04:00
<refpurpose > Login manager configuration file</refpurpose>
2011-06-29 04:27:53 +04:00
</refnamediv>
<refsynopsisdiv >
2012-06-01 03:05:38 +04:00
<para > <filename > /etc/systemd/logind.conf</filename> </para>
2011-06-29 04:27:53 +04:00
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
2013-07-02 07:44:04 +04:00
<para > This file configures various parameters of the systemd login manager, <citerefentry > <refentrytitle > systemd-logind.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
2011-06-29 04:27:53 +04:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > All options are configured in the
<literal > [Login]</literal> section:</para>
<variablelist >
<varlistentry >
<term > <varname > NAutoVTs=</varname> </term>
<listitem > <para > Takes a positive
2012-09-13 21:40:19 +04:00
integer. Configures how many virtual
2012-09-17 14:39:16 +04:00
terminals (VTs) to allocate by default
2013-07-09 15:12:05 +04:00
that, when switched to and are
previously unused,
2012-09-13 21:40:19 +04:00
<literal > autovt</literal> services are
automatically spawned on. These
services are instantiated from the
2012-09-17 14:39:16 +04:00
template unit
2011-06-29 04:27:53 +04:00
<filename > autovt@.service</filename>
2012-09-17 14:39:16 +04:00
for the respective VT TTY name,
2011-06-29 04:27:53 +04:00
e.g. <filename > autovt@tty4.service</filename> . By
2013-07-02 07:44:04 +04:00
default,
2011-06-29 04:27:53 +04:00
<filename > autovt@.service</filename>
is linked to
<filename > getty@.service</filename> ,
i.e. login prompts are started
dynamically as the user switches to
2012-09-17 14:39:16 +04:00
unused virtual terminals. Hence, this
parameter controls how many login
<literal > gettys</literal> are
available on the VTs. If a VT is
already used by some other subsystem
2013-07-02 07:44:04 +04:00
(for example a graphical login), this
2012-09-17 14:39:16 +04:00
kind of activation will not be
attempted. Note that the VT configured
in <varname > ReserveVT=</varname> is
always subject to this kind of
activation, even if it is not one of
VTs configured with the
<varname > NAutoVTs=</varname>
directive. Defaults to 6. When set to
2011-06-29 04:27:53 +04:00
0, automatic spawning of
<literal > autovt</literal> services is
2013-07-02 07:44:04 +04:00
disabled.</para> </listitem>
2012-09-17 14:39:16 +04:00
</varlistentry>
<varlistentry >
<term > <varname > ReserveVT=</varname> </term>
<listitem > <para > Takes a positive
integer. Configures the number of one
virtual terminal that shall
unconditionally be reserved for
<filename > autovt@.service</filename>
activation (see above). The VT
selected with this option will be
2013-07-09 15:12:05 +04:00
marked busy unconditionally, so that no
2012-09-17 14:39:16 +04:00
other subsystem will allocate it. This
functionality is useful to ensure that
2013-07-09 15:12:05 +04:00
regardless of how many VTs are allocated
2013-07-02 07:44:04 +04:00
by other subsystems, one login
2012-09-17 14:39:16 +04:00
<literal > getty</literal> is always
2013-07-09 15:12:05 +04:00
available. Defaults to 6 (in other
words, there will always be a
2012-09-17 14:39:16 +04:00
<literal > getty</literal> available on
Alt-F6.). When set to 0, VT
reservation is
2011-06-29 04:27:53 +04:00
disabled.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > KillUserProcesses=</varname> </term>
<listitem > <para > Takes a boolean
argument. Configures whether the
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>
</varlistentry>
2013-01-16 20:57:08 +04:00
<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
2013-07-09 15:12:05 +04:00
sessions report that they are idle,
no idle inhibitor lock is active,
and subsequently, the time configured
2013-01-16 20:57:08 +04:00
with <varname > IdleActionSec=</varname>
2013-07-09 15:12:05 +04:00
(see below) has expired.</para>
2013-01-16 20:57:08 +04:00
</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>
2011-06-29 04:27:53 +04:00
<varlistentry >
<term > <varname > KillOnlyUsers=</varname> </term>
<term > <varname > KillExcludeUsers=</varname> </term>
<listitem > <para > These settings take
2013-06-27 23:51:44 +04:00
space-separated lists of usernames
2011-06-29 04:27:53 +04:00
that influence the effect of
<varname > KillUserProcesses=</varname> . If
2013-06-27 23:51:44 +04:00
not empty, only processes of users
2011-06-29 04:27:53 +04:00
listed in
<varname > KillOnlyUsers</varname> will
be killed when they log out
entirely. Processes of users listed in
<varname > KillExcludeUsers=</varname>
are excluded from being
killed. <varname > KillExcludeUsers=</varname>
defaults to <literal > root</literal>
and takes precedence over
2013-07-09 15:12:05 +04:00
<varname > KillOnlyUsers=</varname> ,
2011-06-29 04:27:53 +04:00
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
2013-02-27 18:00:26 +04:00
users logging in are added to, in
addition to the
<literal > name=systemd</literal> named
2013-06-27 23:51:44 +04:00
hierarchy. These settings take
space-separated lists of controller
2013-02-27 18:00:26 +04:00
names. Pass the empty string to ensure
that logind does not touch any
hierarchies but systemd's own. When
2013-06-27 23:51:44 +04:00
logging in, user sessions will get
2013-02-27 18:00:26 +04:00
private control groups in all
hierarchies listed in
2011-06-29 04:27:53 +04:00
<varname > Controllers=</varname> and be
reset to the root control group in all
hierarchies listed in
2013-07-09 15:12:05 +04:00
<varname > ResetControllers=</varname> .
<varname > Controllers=</varname>
defaults to the empty list.
2011-06-29 04:27:53 +04:00
<varname > ResetControllers=</varname>
defaults to
2013-02-27 18:00:26 +04:00
<literal > cpu</literal> . Note that for
all controllers that are not listed in
either <varname > Controllers=</varname>
2013-06-27 23:51:44 +04:00
or
<varname > ResetControllers=</varname> ,
2013-02-27 18:00:26 +04:00
newly created sessions will be part of
the control groups of the system
service that created the
session.</para> </listitem>
2011-06-29 04:27:53 +04:00
</varlistentry>
2012-05-05 02:34:48 +04:00
<varlistentry >
<term > <varname > InhibitDelayMaxSec=</varname> </term>
<listitem > <para > Specifies the maximum
2012-05-05 02:46:31 +04:00
time a system shutdown or sleep
request is delayed due to an inhibitor
lock of type <literal > delay</literal>
2013-07-09 15:12:05 +04:00
being active before the inhibitor is
ignored and the operation executes
2012-05-05 02:46:31 +04:00
anyway. Defaults to
2012-05-05 02:34:48 +04:00
5s.</para> </listitem>
2012-05-30 17:01:51 +04:00
</varlistentry>
2012-05-05 02:34:48 +04:00
2012-05-30 17:01:51 +04:00
<varlistentry >
<term > <varname > HandlePowerKey=</varname> </term>
2012-09-21 17:44:14 +04:00
<term > <varname > HandleSuspendKey=</varname> </term>
<term > <varname > HandleHibernateKey=</varname> </term>
2012-05-30 17:01:51 +04:00
<term > <varname > HandleLidSwitch=</varname> </term>
<listitem > <para > Controls whether
logind shall handle the system power
and sleep keys and the lid switch to
2012-09-19 15:10:10 +04:00
trigger actions such as system
power-off or suspend. Can be one of
<literal > ignore</literal> ,
<literal > poweroff</literal> ,
<literal > reboot</literal> ,
<literal > halt</literal> ,
2012-10-28 02:49:04 +04:00
<literal > kexec</literal> ,
2012-10-24 23:47:06 +04:00
<literal > suspend</literal> ,
2012-10-28 15:29:27 +04:00
<literal > hibernate</literal> ,
<literal > hybrid-sleep</literal> and
<literal > lock</literal> . If
2013-06-27 23:51:44 +04:00
<literal > ignore</literal> , logind will
2012-10-28 15:29:27 +04:00
never handle these keys. If
2013-06-27 23:51:44 +04:00
<literal > lock</literal> , all running
sessions will be screen-locked; otherwise,
the specified action
2012-10-28 15:29:27 +04:00
will be taken in the respective
event. Only input devices with the
2012-05-30 23:40:32 +04:00
<literal > power-switch</literal> udev
2012-09-19 15:10:10 +04:00
tag will be watched for key/lid switch
2012-05-30 17:01:51 +04:00
events. <varname > HandlePowerKey=</varname>
2012-05-30 23:40:32 +04:00
defaults to
2012-09-19 15:10:10 +04:00
<literal > poweroff</literal> .
2012-09-21 17:44:14 +04:00
<varname > HandleSuspendKey=</varname>
and
2012-05-30 17:01:51 +04:00
<varname > HandleLidSwitch=</varname>
2012-09-21 17:44:14 +04:00
default to <literal > suspend</literal> .
<varname > HandleHibernateKey=</varname>
defaults to
<literal > hibernate</literal> .</para> </listitem>
2012-09-19 15:10:10 +04:00
</varlistentry>
<varlistentry >
<term > <varname > PowerKeyIgnoreInhibited=</varname> </term>
2012-09-21 17:44:14 +04:00
<term > <varname > SuspendKeyIgnoreInhibited=</varname> </term>
<term > <varname > HibernateKeyIgnoreInhibited=</varname> </term>
2012-09-19 15:10:10 +04:00
<term > <varname > LidSwitchIgnoreInhibited=</varname> </term>
<listitem > <para > Controls whether
actions triggered by the power and
sleep keys and the lid switch are
subject to inhibitor locks. These
settings take boolean arguments. If
2013-06-27 23:51:44 +04:00
<literal > off</literal> , the inhibitor
2012-09-19 15:10:10 +04:00
locks taken by applications in order
to block the requested operation are
2013-07-02 07:44:04 +04:00
respected. If <literal > on</literal> ,
2012-09-19 15:10:10 +04:00
the requested operation is executed in
any
2012-09-21 17:44:14 +04:00
case. <varname > PowerKeyIgnoreInhibited=</varname> ,
<varname > SuspendKeyIgnoreInhibited=</varname>
2012-09-19 15:10:10 +04:00
and
2012-09-21 17:44:14 +04:00
<varname > HibernateKeyIgnoreInhibited=</varname>
2013-07-09 15:12:05 +04:00
default to <literal > off</literal> .
2012-09-19 15:10:10 +04:00
<varname > LidSwitchIgnoreInhibited=</varname>
2012-05-30 17:01:51 +04:00
defaults to
2012-09-19 15:10:10 +04:00
<literal > yes</literal> . This means
that the lid switch does not respect
suspend blockers by default, but the
power and sleep keys do.
</para> </listitem>
2012-05-05 02:34:48 +04:00
</varlistentry>
2011-06-29 04:27:53 +04:00
</variablelist>
2011-06-29 04:46:20 +04:00
<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
2013-07-02 07:44:04 +04:00
<varname > kill-session-processes=1</varname> , which may
2011-06-29 04:46:20 +04:00
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>
2011-06-29 04:27:53 +04:00
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2012-06-01 02:14:07 +04:00
<citerefentry > <refentrytitle > systemd-logind.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2012-03-26 22:58:47 +04:00
<citerefentry > <refentrytitle > loginctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2013-02-11 23:42:24 +04:00
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2011-06-29 04:27:53 +04:00
</para>
</refsect1>
</refentry>