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" conditional='ENABLE_LOGIND'
26 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>logind.conf</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
42 <refentrytitle>logind.conf</refentrytitle>
43 <manvolnum>5</manvolnum>
47 <refname>logind.conf</refname>
48 <refname>logind.conf.d</refname>
49 <refpurpose>Login manager configuration files</refpurpose>
53 <para><filename>/etc/systemd/logind.conf</filename></para>
54 <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para>
55 <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para>
56 <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para>
60 <title>Description</title>
62 <para>These files configure various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
65 <xi:include href="standard-conf.xml" xpointer="confd" />
66 <xi:include href="standard-conf.xml" xpointer="conf" />
69 <title>Options</title>
71 <para>All options are configured in the
72 <literal>[Login]</literal> section:</para>
77 <term><varname>NAutoVTs=</varname></term>
79 <listitem><para>Takes a positive
80 integer. Configures how many virtual
81 terminals (VTs) to allocate by default
82 that, when switched to and are
84 <literal>autovt</literal> services are
85 automatically spawned on. These
86 services are instantiated from the
88 <filename>autovt@.service</filename>
89 for the respective VT TTY name,
90 for example, <filename>autovt@tty4.service</filename>. By
92 <filename>autovt@.service</filename>
94 <filename>getty@.service</filename>.
95 In other words, login prompts are started
96 dynamically as the user switches to
97 unused virtual terminals. Hence, this
98 parameter controls how many login
99 <literal>gettys</literal> are
100 available on the VTs. If a VT is
101 already used by some other subsystem
102 (for example, a graphical login), this
103 kind of activation will not be
104 attempted. Note that the VT configured
105 in <varname>ReserveVT=</varname> is
106 always subject to this kind of
107 activation, even if it is not one of
108 the VTs configured with the
109 <varname>NAutoVTs=</varname>
110 directive. Defaults to 6. When set to
111 0, automatic spawning of
112 <literal>autovt</literal> services is
113 disabled.</para></listitem>
117 <term><varname>ReserveVT=</varname></term>
119 <listitem><para>Takes a positive
120 integer. Identifies one
121 virtual terminal that shall
122 unconditionally be reserved for
123 <filename>autovt@.service</filename>
124 activation (see above). The VT
125 selected with this option will be
126 marked busy unconditionally, so that no
127 other subsystem will allocate it. This
128 functionality is useful to ensure that,
129 regardless of how many VTs are allocated
130 by other subsystems, one login
131 <literal>getty</literal> is always
132 available. Defaults to 6 (in other
133 words, there will always be a
134 <literal>getty</literal> available on
135 Alt-F6.). When set to 0, VT
137 disabled.</para></listitem>
141 <term><varname>KillUserProcesses=</varname></term>
143 <listitem><para>Takes a boolean
144 argument. Configures whether the
145 processes of a user should be killed
146 when the user completely logs out (i.e. after
147 the user's last session ended). Defaults to
148 <literal>no</literal>.</para>
150 <para>Note that setting
151 <varname>KillUserProcesses=1</varname>
152 will break tools like
153 <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
157 <term><varname>KillOnlyUsers=</varname></term>
158 <term><varname>KillExcludeUsers=</varname></term>
160 <listitem><para>These settings take
161 space-separated lists of usernames
162 that influence the effect of
163 <varname>KillUserProcesses=</varname>. If
164 not empty, only processes of users
166 <varname>KillOnlyUsers=</varname> will
167 be killed when they log out
168 entirely. Processes of users listed in
169 <varname>KillExcludeUsers=</varname>
170 are excluded from being
171 killed. <varname>KillExcludeUsers=</varname>
172 defaults to <literal>root</literal>
173 and takes precedence over
174 <varname>KillOnlyUsers=</varname>,
175 which defaults to the empty list.</para></listitem>
179 <term><varname>IdleAction=</varname></term>
181 <listitem><para>Configures the action
182 to take when the system is idle. Takes
183 one of <literal>ignore</literal>,
184 <literal>poweroff</literal>,
185 <literal>reboot</literal>,
186 <literal>halt</literal>,
187 <literal>kexec</literal>,
188 <literal>suspend</literal>,
189 <literal>hibernate</literal>,
190 <literal>hybrid-sleep</literal>, and
191 <literal>lock</literal>. Defaults to
192 <literal>ignore</literal>.</para>
194 <para>Note that this requires that
195 user sessions correctly report the
196 idle status to the system. The system
197 will execute the action after all
198 sessions report that they are idle,
199 no idle inhibitor lock is active,
200 and subsequently, the time configured
201 with <varname>IdleActionSec=</varname>
202 (see below) has expired.</para>
207 <term><varname>IdleActionSec=</varname></term>
209 <listitem><para>Configures the delay
210 after which the action configured in
211 <varname>IdleAction=</varname> (see
212 above) is taken after the system is
213 idle.</para></listitem>
217 <term><varname>InhibitDelayMaxSec=</varname></term>
219 <listitem><para>Specifies the maximum
220 time a system shutdown or sleep
221 request is delayed due to an inhibitor
222 lock of type <literal>delay</literal>
223 being active before the inhibitor is
224 ignored and the operation executes
230 <term><varname>HandlePowerKey=</varname></term>
231 <term><varname>HandleSuspendKey=</varname></term>
232 <term><varname>HandleHibernateKey=</varname></term>
233 <term><varname>HandleLidSwitch=</varname></term>
234 <term><varname>HandleLidSwitchDocked=</varname></term>
236 <listitem><para>Controls whether
237 logind shall handle the system power
238 and sleep keys and the lid switch to
239 trigger actions such as system
240 power-off or suspend. Can be one of
241 <literal>ignore</literal>,
242 <literal>poweroff</literal>,
243 <literal>reboot</literal>,
244 <literal>halt</literal>,
245 <literal>kexec</literal>,
246 <literal>suspend</literal>,
247 <literal>hibernate</literal>,
248 <literal>hybrid-sleep</literal>, and
249 <literal>lock</literal>. If
250 <literal>ignore</literal>, logind will
251 never handle these keys. If
252 <literal>lock</literal>, all running
253 sessions will be screen-locked;
254 otherwise, the specified action will
255 be taken in the respective event. Only
256 input devices with the
257 <literal>power-switch</literal> udev
258 tag will be watched for key/lid switch
259 events. <varname>HandlePowerKey=</varname>
261 <literal>poweroff</literal>.
262 <varname>HandleSuspendKey=</varname>
264 <varname>HandleLidSwitch=</varname>
265 default to <literal>suspend</literal>.
266 <varname>HandleLidSwitchDocked=</varname>
267 defaults to <literal>ignore</literal>.
268 <varname>HandleHibernateKey=</varname>
270 <literal>hibernate</literal>. If the
271 system is inserted in a docking station,
272 or if more than one display is connected,
273 the action specified by
274 <varname>HandleLidSwitchDocked=</varname>
275 occurs; otherwise the
276 <varname>HandleLidSwitch=</varname>
277 action occurs.</para></listitem>
281 <term><varname>PowerKeyIgnoreInhibited=</varname></term>
282 <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
283 <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
284 <term><varname>LidSwitchIgnoreInhibited=</varname></term>
286 <listitem><para>Controls whether
287 actions triggered by the power and
288 sleep keys and the lid switch are
289 subject to inhibitor locks. These
290 settings take boolean arguments. If
291 <literal>no</literal>, the inhibitor
292 locks taken by applications in order
293 to block the requested operation are
294 respected. If <literal>yes</literal>,
295 the requested operation is executed in
297 case. <varname>PowerKeyIgnoreInhibited=</varname>,
298 <varname>SuspendKeyIgnoreInhibited=</varname>
300 <varname>HibernateKeyIgnoreInhibited=</varname>
301 default to <literal>no</literal>.
302 <varname>LidSwitchIgnoreInhibited=</varname>
304 <literal>yes</literal>. This means
305 that the lid switch does not respect
306 suspend blockers by default, but the
307 power and sleep keys do.
312 <term><varname>RuntimeDirectorySize=</varname></term>
314 <listitem><para>Sets the size limit on
316 <varname>$XDG_RUNTIME_DIR</varname>
317 runtime directory for each user who
318 logs in. Takes a size in bytes,
319 optionally suffixed with the usual K, G,
320 M, and T suffixes, to the base 1024
321 (IEC). Alternatively, a numerical
322 percentage suffixed by <literal>%</literal>
323 may be specified, which sets the size
324 limit relative to the amount of
325 physical RAM. Defaults to 10%. Note
326 that this size is a safety limit
327 only. As each runtime directory is a
328 tmpfs file system, it will only consume
329 as much memory as is needed.
334 <term><varname>RemoveIPC=</varname></term>
336 <listitem><para>Controls whether
337 System V and POSIX IPC objects
338 belonging to the user shall be removed
339 when the user fully logs out. Takes a
340 boolean argument. If enabled, the user
341 may not consume IPC resources after
342 the last of the user's sessions
343 terminated. This covers System V
344 semaphores, shared memory and message
345 queues, as well as POSIX shared memory
346 and message queues. Note that IPC
347 objects of the root user are excluded
348 from the effect of this
350 <literal>yes</literal>.</para></listitem>
357 <title>See Also</title>
359 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
360 <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
361 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
362 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>