1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of elogind.
8 Copyright 2010 Lennart Poettering
10 elogind is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 elogind is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with elogind; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="elogind.conf" conditional='ENABLE_LOGIND'
25 xmlns:xi="http://www.w3.org/2001/XInclude">
27 <title>elogind.conf</title>
28 <productname>elogind</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>elogind.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>elogind.conf</refname>
47 <refpurpose>Login manager configuration files</refpurpose>
51 <para><filename>/etc/elogind/elogind.conf</filename></para>
55 <title>Description</title>
57 <para>These files configure various parameters of the elogind
59 <citerefentry><refentrytitle>elogind-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
63 <xi:include href="standard-conf.xml" xpointer="main-conf" />
66 <title>Options</title>
68 <para>All options are configured in the
69 <literal>[Login]</literal> section:</para>
74 <term><varname>NAutoVTs=</varname></term>
76 <listitem><para>Takes a positive integer. Configures how many
77 virtual terminals (VTs) to allocate by default that, when
78 switched to and are previously unused,
79 <literal>autovt</literal> services are automatically spawned
80 on. These services are instantiated from the template unit
81 <filename>autovt@.service</filename> for the respective VT TTY
82 name, for example, <filename>autovt@tty4.service</filename>.
83 By default, <filename>autovt@.service</filename> is linked to
84 <filename>getty@.service</filename>. In other words, login
85 prompts are started dynamically as the user switches to unused
86 virtual terminals. Hence, this parameter controls how many
87 login <literal>gettys</literal> are available on the VTs. If a
88 VT is already used by some other subsystem (for example, a
89 graphical login), this kind of activation will not be
90 attempted. Note that the VT configured in
91 <varname>ReserveVT=</varname> is always subject to this kind
92 of activation, even if it is not one of the VTs configured
93 with the <varname>NAutoVTs=</varname> directive. Defaults to
94 6. When set to 0, automatic spawning of
95 <literal>autovt</literal> services is
96 disabled.</para></listitem>
100 <term><varname>ReserveVT=</varname></term>
102 <listitem><para>Takes a positive integer. Identifies one
103 virtual terminal that shall unconditionally be reserved for
104 <filename>autovt@.service</filename> activation (see above).
105 The VT selected with this option will be marked busy
106 unconditionally, so that no other subsystem will allocate it.
107 This functionality is useful to ensure that, regardless of how
108 many VTs are allocated by other subsystems, one login
109 <literal>getty</literal> is always available. Defaults to 6
110 (in other words, there will always be a
111 <literal>getty</literal> available on Alt-F6.). When set to 0,
112 VT reservation is disabled.</para></listitem>
116 <term><varname>KillUserProcesses=</varname></term>
118 <listitem><para>Takes a boolean argument. Configures whether
119 the processes of a user should be killed when the user
120 completely logs out (i.e. after the user's last session
121 ended). Defaults to <literal>no</literal>.</para>
123 <para>Note that setting <varname>KillUserProcesses=1</varname>
124 will break tools like
125 <citerefentry project='die-net'><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
129 <term><varname>KillOnlyUsers=</varname></term>
130 <term><varname>KillExcludeUsers=</varname></term>
132 <listitem><para>These settings take space-separated lists of
133 usernames that influence the effect of
134 <varname>KillUserProcesses=</varname>. If not empty, only
135 processes of users listed in <varname>KillOnlyUsers=</varname>
136 will be killed when they log out entirely. Processes of users
137 listed in <varname>KillExcludeUsers=</varname> are excluded
138 from being killed. <varname>KillExcludeUsers=</varname>
139 defaults to <literal>root</literal> and takes precedence over
140 <varname>KillOnlyUsers=</varname>, which defaults to the empty
141 list.</para></listitem>
145 <term><varname>IdleAction=</varname></term>
147 <listitem><para>Configures the action to take when the system
148 is idle. Takes one of
149 <literal>ignore</literal>,
150 <literal>poweroff</literal>,
151 <literal>reboot</literal>,
152 <literal>halt</literal>,
153 <literal>kexec</literal>,
154 <literal>suspend</literal>,
155 <literal>hibernate</literal>,
156 <literal>hybrid-sleep</literal>, and
157 <literal>lock</literal>.
158 Defaults to <literal>ignore</literal>.</para>
160 <para>Note that this requires that user sessions correctly
161 report the idle status to the system. The system will execute
162 the action after all sessions report that they are idle, no
163 idle inhibitor lock is active, and subsequently, the time
164 configured with <varname>IdleActionSec=</varname> (see below)
170 <term><varname>IdleActionSec=</varname></term>
172 <listitem><para>Configures the delay after which the action
173 configured in <varname>IdleAction=</varname> (see above) is
174 taken after the system is idle.</para></listitem>
178 <term><varname>InhibitDelayMaxSec=</varname></term>
180 <listitem><para>Specifies the maximum time a system shutdown
181 or sleep request is delayed due to an inhibitor lock of type
182 <literal>delay</literal> being active before the inhibitor is
183 ignored and the operation executes anyway. Defaults to
188 <term><varname>HandlePowerKey=</varname></term>
189 <term><varname>HandleSuspendKey=</varname></term>
190 <term><varname>HandleHibernateKey=</varname></term>
191 <term><varname>HandleLidSwitch=</varname></term>
192 <term><varname>HandleLidSwitchDocked=</varname></term>
194 <listitem><para>Controls whether logind shall handle the
195 system power and sleep keys and the lid switch to trigger
196 actions such as system power-off or suspend. Can be one of
197 <literal>ignore</literal>,
198 <literal>poweroff</literal>,
199 <literal>reboot</literal>,
200 <literal>halt</literal>,
201 <literal>kexec</literal>,
202 <literal>suspend</literal>,
203 <literal>hibernate</literal>,
204 <literal>hybrid-sleep</literal>, and
205 <literal>lock</literal>.
206 If <literal>ignore</literal>, logind will never handle these
207 keys. If <literal>lock</literal>, all running sessions will be
208 screen-locked; otherwise, the specified action will be taken
209 in the respective event. Only input devices with the
210 <literal>power-switch</literal> udev tag will be watched for
211 key/lid switch events. <varname>HandlePowerKey=</varname>
212 defaults to <literal>poweroff</literal>.
213 <varname>HandleSuspendKey=</varname> and
214 <varname>HandleLidSwitch=</varname> default to
215 <literal>suspend</literal>.
216 <varname>HandleLidSwitchDocked=</varname> defaults to
217 <literal>ignore</literal>.
218 <varname>HandleHibernateKey=</varname> defaults to
219 <literal>hibernate</literal>. If the system is inserted in a
220 docking station, or if more than one display is connected, the
221 action specified by <varname>HandleLidSwitchDocked=</varname>
222 occurs; otherwise the <varname>HandleLidSwitch=</varname>
223 action occurs.</para></listitem>
227 <term><varname>PowerKeyIgnoreInhibited=</varname></term>
228 <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
229 <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
230 <term><varname>LidSwitchIgnoreInhibited=</varname></term>
232 <listitem><para>Controls whether actions triggered by the
233 power and sleep keys and the lid switch are subject to
234 inhibitor locks. These settings take boolean arguments. If
235 <literal>no</literal>, the inhibitor locks taken by
236 applications in order to block the requested operation are
237 respected. If <literal>yes</literal>, the requested operation
238 is executed in any case.
239 <varname>PowerKeyIgnoreInhibited=</varname>,
240 <varname>SuspendKeyIgnoreInhibited=</varname> and
241 <varname>HibernateKeyIgnoreInhibited=</varname> default to
242 <literal>no</literal>.
243 <varname>LidSwitchIgnoreInhibited=</varname> defaults to
244 <literal>yes</literal>. This means that the lid switch does
245 not respect suspend blockers by default, but the power and
246 sleep keys do. </para></listitem>
250 <term><varname>HoldoffTimeoutSec=</varname></term>
252 <listitem><para>Specifies the timeout after system startup or
253 system resume in which elogind will hold off on reacting to
254 LID events. This is required for the system to properly
255 detect any hotplugged devices so elogind can ignore LID events
256 if external monitors, or docks, are connected. If set to 0,
257 elogind will always react immediately, possibly before the
258 kernel fully probed all hotplugged devices. This is safe, as
259 long as you do not care for elogind to account for devices
260 that have been plugged or unplugged while the system was off.
261 Defaults to 30s.</para></listitem>
265 <term><varname>RuntimeDirectorySize=</varname></term>
267 <listitem><para>Sets the size limit on the
268 <varname>$XDG_RUNTIME_DIR</varname> runtime directory for each
269 user who logs in. Takes a size in bytes, optionally suffixed
270 with the usual K, G, M, and T suffixes, to the base 1024
271 (IEC). Alternatively, a numerical percentage suffixed by
272 <literal>%</literal> may be specified, which sets the size
273 limit relative to the amount of physical RAM. Defaults to 10%.
274 Note that this size is a safety limit only. As each runtime
275 directory is a tmpfs file system, it will only consume as much
276 memory as is needed. </para></listitem>
280 <term><varname>RemoveIPC=</varname></term>
282 <listitem><para>Controls whether System V and POSIX IPC
283 objects belonging to the user shall be removed when the user
284 fully logs out. Takes a boolean argument. If enabled, the user
285 may not consume IPC resources after the last of the user's
286 sessions terminated. This covers System V semaphores, shared
287 memory and message queues, as well as POSIX shared memory and
288 message queues. Note that IPC objects of the root user are
289 excluded from the effect of this setting. Defaults to
290 <literal>yes</literal>.</para></listitem>
297 <title>See Also</title>
299 <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
300 <citerefentry><refentrytitle>elogind-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
301 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
302 <citerefentry><refentrytitle>elogind-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>