]> git.proxmox.com Git - systemd.git/blame - man/logind.conf.html
Imported Upstream version 218
[systemd.git] / man / logind.conf.html
CommitLineData
663996b3
MS
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>logind.conf</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
2 a.headerlink {
3 color: #c60f0f;
4 font-size: 0.8em;
5 padding: 0 4px 0 4px;
6 text-decoration: none;
7 visibility: hidden;
8 }
9
10 a.headerlink:hover {
11 background-color: #c60f0f;
12 color: white;
13 }
14
15 h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
16 visibility: visible;
17 }
18 </style><a href="index.html">Index </a>·
19 <a href="systemd.directives.html">Directives </a>·
20 <a href="../python-systemd/index.html">Python </a>·
21 <a href="../libudev/index.html">libudev </a>·
f47781d8
MP
22 <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 218</span><hr><div class="refentry"><a name="logind.conf"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>logind.conf, logind.conf.d — Login manager configuration files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">/etc/systemd/logind.conf</code></p><p><code class="filename">/etc/systemd/logind.conf.d/*.conf</code></p><p><code class="filename">/run/systemd/logind.conf.d/*.conf</code></p><p><code class="filename">/usr/lib/systemd/logind.conf.d/*.conf</code></p></div><div class="refsect1"><a name="idm140501090265024"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p>These files configure various parameters of the systemd login manager, <a href="systemd-logind.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-logind.service</span>(8)</span></a>.</p></div><div class="refsection"><a name="confd"></a><h2>Configuration Directories and Precedence</h2><p>Configuration files are read from directories in
23 <code class="filename">/etc/</code>, <code class="filename">/run/</code>, and
24 <code class="filename">/usr/lib/</code>, in order of precedence.
25 Each configuration file in these configuration directories shall be named in
26 the style of <code class="filename"><em class="replaceable"><code>filename</code></em>.conf</code>.
27 Files in <code class="filename">/etc/</code> override files with the same name in
28 <code class="filename">/run/</code> and <code class="filename">/usr/lib/</code>. Files in
29 <code class="filename">/run/</code> override files with the same name in
30 <code class="filename">/usr/lib/</code>.</p><p>Packages should install their configuration files in
31 <code class="filename">/usr/lib/</code>. Files in <code class="filename">/etc/</code> are
32 reserved for the local administrator, who may use this logic to override the
33 configuration files installed by vendor packages. All configuration files
34 are sorted by their filename in lexicographic order, regardless of which of
35 the directories they reside in. If multiple files specify the same option,
36 the entry in the file with the lexicographically latest name will take
37 precedence. It is recommended to prefix all filenames with a two-digit number
38 and a dash, to simplify the ordering of the files.</p><p>If the administrator wants to disable a configuration file supplied by
39 the vendor, the recommended way is to place a symlink to
40 <code class="filename">/dev/null</code> in the configuration directory in
41 <code class="filename">/etc/</code>, with the same filename as the vendor
42 configuration file.</p></div><div class="refsection"><a name="conf"></a><h2>Configuration File</h2><p>Configuration is also read from a single configuration file in
43 <code class="filename">/etc/</code>. This file is read before any of the
44 configuration directories, and has the lowest precedence; entries in a file
45 in any configuration directory override entries in the single configuration
46 file.</p></div><div class="refsect1"><a name="idm140501090261344"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>All options are configured in the
14228c0d 47 "<code class="literal">[Login]</code>" section:</p><div class="variablelist"><dl class="variablelist"><dt id="NAutoVTs="><span class="term"><code class="varname">NAutoVTs=</code></span><a class="headerlink" title="Permalink to this term" href="#NAutoVTs=">¶</a></dt><dd><p>Takes a positive
663996b3
MS
48 integer. Configures how many virtual
49 terminals (VTs) to allocate by default
14228c0d
MB
50 that, when switched to and are
51 previously unused,
52 "<code class="literal">autovt</code>" services are
663996b3
MS
53 automatically spawned on. These
54 services are instantiated from the
55 template unit
56 <code class="filename">autovt@.service</code>
57 for the respective VT TTY name,
60f067b4 58 for example, <code class="filename">autovt@tty4.service</code>. By
14228c0d 59 default,
663996b3
MS
60 <code class="filename">autovt@.service</code>
61 is linked to
60f067b4
JS
62 <code class="filename">getty@.service</code>.
63 In other words, login prompts are started
663996b3
MS
64 dynamically as the user switches to
65 unused virtual terminals. Hence, this
66 parameter controls how many login
14228c0d 67 "<code class="literal">gettys</code>" are
663996b3
MS
68 available on the VTs. If a VT is
69 already used by some other subsystem
60f067b4 70 (for example, a graphical login), this
663996b3
MS
71 kind of activation will not be
72 attempted. Note that the VT configured
73 in <code class="varname">ReserveVT=</code> is
74 always subject to this kind of
75 activation, even if it is not one of
60f067b4 76 the VTs configured with the
663996b3
MS
77 <code class="varname">NAutoVTs=</code>
78 directive. Defaults to 6. When set to
79 0, automatic spawning of
14228c0d
MB
80 "<code class="literal">autovt</code>" services is
81 disabled.</p></dd><dt id="ReserveVT="><span class="term"><code class="varname">ReserveVT=</code></span><a class="headerlink" title="Permalink to this term" href="#ReserveVT=">¶</a></dt><dd><p>Takes a positive
60f067b4 82 integer. Identifies one
663996b3
MS
83 virtual terminal that shall
84 unconditionally be reserved for
85 <code class="filename">autovt@.service</code>
86 activation (see above). The VT
87 selected with this option will be
14228c0d 88 marked busy unconditionally, so that no
663996b3 89 other subsystem will allocate it. This
60f067b4 90 functionality is useful to ensure that,
14228c0d
MB
91 regardless of how many VTs are allocated
92 by other subsystems, one login
93 "<code class="literal">getty</code>" is always
94 available. Defaults to 6 (in other
95 words, there will always be a
96 "<code class="literal">getty</code>" available on
663996b3
MS
97 Alt-F6.). When set to 0, VT
98 reservation is
99 disabled.</p></dd><dt id="KillUserProcesses="><span class="term"><code class="varname">KillUserProcesses=</code></span><a class="headerlink" title="Permalink to this term" href="#KillUserProcesses=">¶</a></dt><dd><p>Takes a boolean
100 argument. Configures whether the
101 processes of a user should be killed
60f067b4
JS
102 when the user completely logs out (i.e. after
103 the user's last session ended). Defaults to
14228c0d
MB
104 "<code class="literal">no</code>".</p><p>Note that setting
105 <code class="varname">KillUserProcesses=1</code>
106 will break tools like
107 <a href="screen.html"><span class="citerefentry"><span class="refentrytitle">screen</span>(1)</span></a>.</p></dd><dt id="KillOnlyUsers="><span class="term"><code class="varname">KillOnlyUsers=</code>, </span><span class="term"><code class="varname">KillExcludeUsers=</code></span><a class="headerlink" title="Permalink to this term" href="#KillOnlyUsers=">¶</a></dt><dd><p>These settings take
108 space-separated lists of usernames
663996b3
MS
109 that influence the effect of
110 <code class="varname">KillUserProcesses=</code>. If
14228c0d 111 not empty, only processes of users
663996b3 112 listed in
14228c0d 113 <code class="varname">KillOnlyUsers=</code> will
663996b3
MS
114 be killed when they log out
115 entirely. Processes of users listed in
116 <code class="varname">KillExcludeUsers=</code>
117 are excluded from being
118 killed. <code class="varname">KillExcludeUsers=</code>
14228c0d 119 defaults to "<code class="literal">root</code>"
663996b3 120 and takes precedence over
14228c0d
MB
121 <code class="varname">KillOnlyUsers=</code>,
122 which defaults to the empty list.</p></dd><dt id="IdleAction="><span class="term"><code class="varname">IdleAction=</code></span><a class="headerlink" title="Permalink to this term" href="#IdleAction=">¶</a></dt><dd><p>Configures the action
123 to take when the system is idle. Takes
124 one of "<code class="literal">ignore</code>",
125 "<code class="literal">poweroff</code>",
126 "<code class="literal">reboot</code>",
127 "<code class="literal">halt</code>",
128 "<code class="literal">kexec</code>",
129 "<code class="literal">suspend</code>",
130 "<code class="literal">hibernate</code>",
60f067b4 131 "<code class="literal">hybrid-sleep</code>", and
14228c0d
MB
132 "<code class="literal">lock</code>". Defaults to
133 "<code class="literal">ignore</code>".</p><p>Note that this requires that
134 user sessions correctly report the
135 idle status to the system. The system
136 will execute the action after all
137 sessions report that they are idle,
138 no idle inhibitor lock is active,
139 and subsequently, the time configured
140 with <code class="varname">IdleActionSec=</code>
141 (see below) has expired.</p></dd><dt id="IdleActionSec="><span class="term"><code class="varname">IdleActionSec=</code></span><a class="headerlink" title="Permalink to this term" href="#IdleActionSec=">¶</a></dt><dd><p>Configures the delay
142 after which the action configured in
143 <code class="varname">IdleAction=</code> (see
144 above) is taken after the system is
145 idle.</p></dd><dt id="InhibitDelayMaxSec="><span class="term"><code class="varname">InhibitDelayMaxSec=</code></span><a class="headerlink" title="Permalink to this term" href="#InhibitDelayMaxSec=">¶</a></dt><dd><p>Specifies the maximum
663996b3
MS
146 time a system shutdown or sleep
147 request is delayed due to an inhibitor
14228c0d
MB
148 lock of type "<code class="literal">delay</code>"
149 being active before the inhibitor is
150 ignored and the operation executes
663996b3 151 anyway. Defaults to
5eef597e 152 5.</p></dd><dt id="HandlePowerKey="><span class="term"><code class="varname">HandlePowerKey=</code>, </span><span class="term"><code class="varname">HandleSuspendKey=</code>, </span><span class="term"><code class="varname">HandleHibernateKey=</code>, </span><span class="term"><code class="varname">HandleLidSwitch=</code>, </span><span class="term"><code class="varname">HandleLidSwitchDocked=</code></span><a class="headerlink" title="Permalink to this term" href="#HandlePowerKey=">¶</a></dt><dd><p>Controls whether
663996b3
MS
153 logind shall handle the system power
154 and sleep keys and the lid switch to
155 trigger actions such as system
156 power-off or suspend. Can be one of
14228c0d
MB
157 "<code class="literal">ignore</code>",
158 "<code class="literal">poweroff</code>",
159 "<code class="literal">reboot</code>",
160 "<code class="literal">halt</code>",
161 "<code class="literal">kexec</code>",
162 "<code class="literal">suspend</code>",
163 "<code class="literal">hibernate</code>",
60f067b4 164 "<code class="literal">hybrid-sleep</code>", and
14228c0d
MB
165 "<code class="literal">lock</code>". If
166 "<code class="literal">ignore</code>", logind will
663996b3 167 never handle these keys. If
14228c0d 168 "<code class="literal">lock</code>", all running
60f067b4
JS
169 sessions will be screen-locked;
170 otherwise, the specified action will
171 be taken in the respective event. Only
172 input devices with the
14228c0d 173 "<code class="literal">power-switch</code>" udev
663996b3
MS
174 tag will be watched for key/lid switch
175 events. <code class="varname">HandlePowerKey=</code>
176 defaults to
14228c0d 177 "<code class="literal">poweroff</code>".
663996b3
MS
178 <code class="varname">HandleSuspendKey=</code>
179 and
180 <code class="varname">HandleLidSwitch=</code>
14228c0d 181 default to "<code class="literal">suspend</code>".
5eef597e
MP
182 <code class="varname">HandleLidSwitchDocked=</code>
183 defaults to "<code class="literal">ignore</code>".
663996b3
MS
184 <code class="varname">HandleHibernateKey=</code>
185 defaults to
5eef597e
MP
186 "<code class="literal">hibernate</code>". If the
187 system is inserted in a docking station,
188 or if more than one display is connected,
189 the action specified by
190 <code class="varname">HandleLidSwitchDocked=</code>
191 occurs; otherwise the
192 <code class="varname">HandleLidSwitch=</code>
193 action occurs.</p></dd><dt id="PowerKeyIgnoreInhibited="><span class="term"><code class="varname">PowerKeyIgnoreInhibited=</code>, </span><span class="term"><code class="varname">SuspendKeyIgnoreInhibited=</code>, </span><span class="term"><code class="varname">HibernateKeyIgnoreInhibited=</code>, </span><span class="term"><code class="varname">LidSwitchIgnoreInhibited=</code></span><a class="headerlink" title="Permalink to this term" href="#PowerKeyIgnoreInhibited=">¶</a></dt><dd><p>Controls whether
663996b3
MS
194 actions triggered by the power and
195 sleep keys and the lid switch are
196 subject to inhibitor locks. These
197 settings take boolean arguments. If
f47781d8 198 "<code class="literal">no</code>", the inhibitor
663996b3
MS
199 locks taken by applications in order
200 to block the requested operation are
f47781d8 201 respected. If "<code class="literal">yes</code>",
663996b3
MS
202 the requested operation is executed in
203 any
204 case. <code class="varname">PowerKeyIgnoreInhibited=</code>,
205 <code class="varname">SuspendKeyIgnoreInhibited=</code>
206 and
207 <code class="varname">HibernateKeyIgnoreInhibited=</code>
f47781d8 208 default to "<code class="literal">no</code>".
663996b3
MS
209 <code class="varname">LidSwitchIgnoreInhibited=</code>
210 defaults to
14228c0d 211 "<code class="literal">yes</code>". This means
663996b3
MS
212 that the lid switch does not respect
213 suspend blockers by default, but the
214 power and sleep keys do.
60f067b4
JS
215 </p></dd><dt id="RuntimeDirectorySize="><span class="term"><code class="varname">RuntimeDirectorySize=</code></span><a class="headerlink" title="Permalink to this term" href="#RuntimeDirectorySize=">¶</a></dt><dd><p>Sets the size limit on
216 the
217 <code class="varname">$XDG_RUNTIME_DIR</code>
218 runtime directory for each user who
219 logs in. Takes a size in bytes,
220 optionally suffixed with the usual K, G,
221 M, and T suffixes, to the base 1024
222 (IEC). Alternatively, a numerical
223 percentage suffixed by "<code class="literal">%</code>"
224 may be specified, which sets the size
225 limit relative to the amount of
226 physical RAM. Defaults to 10%. Note
227 that this size is a safety limit
228 only. As each runtime directory is a
229 tmpfs file system, it will only consume
230 as much memory as is needed.
231 </p></dd><dt id="RemoveIPC="><span class="term"><code class="varname">RemoveIPC=</code></span><a class="headerlink" title="Permalink to this term" href="#RemoveIPC=">¶</a></dt><dd><p>Controls whether
232 System V and POSIX IPC objects
233 belonging to the user shall be removed
234 when the user fully logs out. Takes a
235 boolean argument. If enabled, the user
236 may not consume IPC resources after
5eef597e 237 the last of the user's sessions
60f067b4
JS
238 terminated. This covers System V
239 semaphores, shared memory and message
240 queues, as well as POSIX shared memory
241 and message queues. Note that IPC
242 objects of the root user are excluded
243 from the effect of this
244 setting. Defaults to
f47781d8 245 "<code class="literal">yes</code>".</p></dd></dl></div></div><div class="refsect1"><a name="idm140501089170336"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
663996b3
MS
246 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
247 <a href="systemd-logind.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-logind.service</span>(8)</span></a>,
248 <a href="loginctl.html"><span class="citerefentry"><span class="refentrytitle">loginctl</span>(1)</span></a>,
249 <a href="systemd-system.conf.html"><span class="citerefentry"><span class="refentrytitle">systemd-system.conf</span>(5)</span></a>
250 </p></div></div></body></html>