1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 <refentry id="logind.conf">
27 <title>logind.conf</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>logind.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>logind.conf</refname>
47 <refpurpose>Login manager configuration file</refpurpose>
51 <para><filename>/etc/systemd/logind.conf</filename></para>
55 <title>Description</title>
57 <para>This file configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
62 <title>Options</title>
64 <para>All options are configured in the
65 <literal>[Login]</literal> section:</para>
70 <term><varname>NAutoVTs=</varname></term>
72 <listitem><para>Takes a positive
73 integer. Configures how many virtual
74 terminals (VTs) to allocate by default
75 that -- when switched to and
77 <literal>autovt</literal> services are
78 automatically spawned on. These
79 services are instantiated from the
81 <filename>autovt@.service</filename>
82 for the respective VT TTY name,
83 e.g. <filename>autovt@tty4.service</filename>. By
85 <filename>autovt@.service</filename>
87 <filename>getty@.service</filename>,
88 i.e. login prompts are started
89 dynamically as the user switches to
90 unused virtual terminals. Hence, this
91 parameter controls how many login
92 <literal>gettys</literal> are
93 available on the VTs. If a VT is
94 already used by some other subsystem
95 (for example a graphical login) this
96 kind of activation will not be
97 attempted. Note that the VT configured
98 in <varname>ReserveVT=</varname> is
99 always subject to this kind of
100 activation, even if it is not one of
101 VTs configured with the
102 <varname>NAutoVTs=</varname>
103 directive. Defaults to 6. When set to
104 0, automatic spawning of
105 <literal>autovt</literal> services is
106 disabled. </para></listitem>
110 <term><varname>ReserveVT=</varname></term>
112 <listitem><para>Takes a positive
113 integer. Configures the number of one
114 virtual terminal that shall
115 unconditionally be reserved for
116 <filename>autovt@.service</filename>
117 activation (see above). The VT
118 selected with this option will be
119 marked busy unconditionally so that no
120 other subsystem will allocate it. This
121 functionality is useful to ensure that
122 regardless how many VTs are allocated
123 by other subsystems one login
124 <literal>getty</literal> is always
125 available. Defaults to 6 (with other
126 words: there'll always be a
127 <literal>getty</literal> available on
128 Alt-F6.). When set to 0, VT
130 disabled.</para></listitem>
134 <term><varname>KillUserProcesses=</varname></term>
136 <listitem><para>Takes a boolean
137 argument. Configures whether the
138 processes of a user should be killed
139 when she or he completely logs out (i.e. after
140 her/his last session ended). Defaults to
141 <literal>no</literal>.</para></listitem>
145 <term><varname>KillOnlyUsers=</varname></term>
146 <term><varname>KillExcludeUsers=</varname></term>
148 <listitem><para>These settings take
149 space separated lists of user names
150 that influence the effect of
151 <varname>KillUserProcesses=</varname>. If
152 not empty only processes of users
154 <varname>KillOnlyUsers</varname> will
155 be killed when they log out
156 entirely. Processes of users listed in
157 <varname>KillExcludeUsers=</varname>
158 are excluded from being
159 killed. <varname>KillExcludeUsers=</varname>
160 defaults to <literal>root</literal>
161 and takes precedence over
162 <varname>KillOnlyUsers=</varname>
163 which defaults to the empty list.</para></listitem>
167 <term><varname>Controllers=</varname></term>
168 <term><varname>ResetControllers=</varname></term>
170 <listitem><para>These settings control
171 the default control group hierarchies
172 users logging in are added to. When
173 logging in users will get private
174 control groups in all hierarchies
176 <varname>Controllers=</varname> and be
177 reset to the root control group in all
178 hierarchies listed in
179 <varname>ResetControllers=</varname>. <varname>Controllers=</varname>
180 defaults to the empty list,
181 <varname>ResetControllers=</varname>
183 <literal>cpu</literal>.</para></listitem>
187 <term><varname>InhibitDelayMaxSec=</varname></term>
189 <listitem><para>Specifies the maximum
190 time a system shutdown or sleep
191 request is delayed due to an inhibitor
192 lock of type <literal>delay</literal>
193 being active -- before it is ignored
194 and the operation executed
196 5s.</para></listitem>
200 <term><varname>HandlePowerKey=</varname></term>
201 <term><varname>HandleSleepKey=</varname></term>
202 <term><varname>HandleLidSwitch=</varname></term>
204 <listitem><para>Controls whether
205 logind shall handle the system power
206 and sleep keys and the lid switch to
207 trigger system power-off or
208 suspend. Can be one of
209 <literal>off</literal>,
210 <literal>no-session</literal>,
211 <literal>tty-session</literal>,
212 <literal>any-session</literal> and
213 <literal>always</literal>. If
214 <literal>off</literal> logind will
215 never handle these keys. If
216 <literal>no-session</literal> logind
217 will handle these keys when no user is
218 logged in and no inhibitor lock is
219 taken, and trigger a warning beep
221 <literal>tty-session</literal> logind
222 will handle these keys if no inhibitor
223 lock is taken, and either no user is
224 logged in or the foreground session is
225 a text login and the only one
227 <literal>any-session</literal> is set
228 logind will handle these keys if no
229 inhibitor lock is taken, and either no
230 user is logged in or the foreground
231 session is the only one existing
232 (regardless whether graphical or
234 <literal>always</literal> logind will
235 handle these keys in any case, even if
236 one or more users are logged in or an
237 inhibitor lock is taken. Only input
239 <literal>power-switch</literal> udev
240 tag will be watched for key
241 events. <varname>HandlePowerKey=</varname>
243 <literal>no-session</literal>.
244 <varname>HandleSleepKey=</varname>
246 <literal>tty-session</literal>,
247 <varname>HandleLidSwitch=</varname>
249 <literal>off</literal>.</para></listitem>
254 <para>Note that setting
255 <varname>KillUserProcesses=1</varname> will break tools
257 <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
259 <para>Note that <varname>KillUserProcesses=1</varname>
260 is a weaker version of
261 <varname>kill-session-processes=1</varname> which may
262 be configured per-service for
263 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The
264 latter kills processes of a session as soon as it
265 ends, the former kills processes as soon as the last
266 session of the user ends.</para>
270 <title>See Also</title>
272 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
273 <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
274 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
275 <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>