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