]> git.proxmox.com Git - systemd.git/blob - man/logind.conf.html
Imported Upstream version 208
[systemd.git] / man / logind.conf.html
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>·
22 <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 208</span><hr><div class="refentry"><a name="logind.conf"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>logind.conf — Login manager configuration file</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">/etc/systemd/logind.conf</code></p></div><div class="refsect1"><a name="idm274690860784"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description"></a></h2><p>This file configures 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="refsect1"><a name="idm274690954496"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options"></a></h2><p>All options are configured in the
23 "<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
24 integer. Configures how many virtual
25 terminals (VTs) to allocate by default
26 that, when switched to and are
27 previously unused,
28 "<code class="literal">autovt</code>" services are
29 automatically spawned on. These
30 services are instantiated from the
31 template unit
32 <code class="filename">autovt@.service</code>
33 for the respective VT TTY name,
34 e.g. <code class="filename">autovt@tty4.service</code>. By
35 default,
36 <code class="filename">autovt@.service</code>
37 is linked to
38 <code class="filename">getty@.service</code>,
39 i.e. login prompts are started
40 dynamically as the user switches to
41 unused virtual terminals. Hence, this
42 parameter controls how many login
43 "<code class="literal">gettys</code>" are
44 available on the VTs. If a VT is
45 already used by some other subsystem
46 (for example a graphical login), this
47 kind of activation will not be
48 attempted. Note that the VT configured
49 in <code class="varname">ReserveVT=</code> is
50 always subject to this kind of
51 activation, even if it is not one of
52 VTs configured with the
53 <code class="varname">NAutoVTs=</code>
54 directive. Defaults to 6. When set to
55 0, automatic spawning of
56 "<code class="literal">autovt</code>" services is
57 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
58 integer. Configures the number of one
59 virtual terminal that shall
60 unconditionally be reserved for
61 <code class="filename">autovt@.service</code>
62 activation (see above). The VT
63 selected with this option will be
64 marked busy unconditionally, so that no
65 other subsystem will allocate it. This
66 functionality is useful to ensure that
67 regardless of how many VTs are allocated
68 by other subsystems, one login
69 "<code class="literal">getty</code>" is always
70 available. Defaults to 6 (in other
71 words, there will always be a
72 "<code class="literal">getty</code>" available on
73 Alt-F6.). When set to 0, VT
74 reservation is
75 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
76 argument. Configures whether the
77 processes of a user should be killed
78 when she or he completely logs out (i.e. after
79 her/his last session ended). Defaults to
80 "<code class="literal">no</code>".</p><p>Note that setting
81 <code class="varname">KillUserProcesses=1</code>
82 will break tools like
83 <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
84 space-separated lists of usernames
85 that influence the effect of
86 <code class="varname">KillUserProcesses=</code>. If
87 not empty, only processes of users
88 listed in
89 <code class="varname">KillOnlyUsers=</code> will
90 be killed when they log out
91 entirely. Processes of users listed in
92 <code class="varname">KillExcludeUsers=</code>
93 are excluded from being
94 killed. <code class="varname">KillExcludeUsers=</code>
95 defaults to "<code class="literal">root</code>"
96 and takes precedence over
97 <code class="varname">KillOnlyUsers=</code>,
98 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
99 to take when the system is idle. Takes
100 one of "<code class="literal">ignore</code>",
101 "<code class="literal">poweroff</code>",
102 "<code class="literal">reboot</code>",
103 "<code class="literal">halt</code>",
104 "<code class="literal">kexec</code>",
105 "<code class="literal">suspend</code>",
106 "<code class="literal">hibernate</code>",
107 "<code class="literal">hybrid-sleep</code>",
108 "<code class="literal">lock</code>". Defaults to
109 "<code class="literal">ignore</code>".</p><p>Note that this requires that
110 user sessions correctly report the
111 idle status to the system. The system
112 will execute the action after all
113 sessions report that they are idle,
114 no idle inhibitor lock is active,
115 and subsequently, the time configured
116 with <code class="varname">IdleActionSec=</code>
117 (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
118 after which the action configured in
119 <code class="varname">IdleAction=</code> (see
120 above) is taken after the system is
121 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
122 time a system shutdown or sleep
123 request is delayed due to an inhibitor
124 lock of type "<code class="literal">delay</code>"
125 being active before the inhibitor is
126 ignored and the operation executes
127 anyway. Defaults to
128 5s.</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><a class="headerlink" title="Permalink to this term" href="#HandlePowerKey="></a></dt><dd><p>Controls whether
129 logind shall handle the system power
130 and sleep keys and the lid switch to
131 trigger actions such as system
132 power-off or suspend. Can be one of
133 "<code class="literal">ignore</code>",
134 "<code class="literal">poweroff</code>",
135 "<code class="literal">reboot</code>",
136 "<code class="literal">halt</code>",
137 "<code class="literal">kexec</code>",
138 "<code class="literal">suspend</code>",
139 "<code class="literal">hibernate</code>",
140 "<code class="literal">hybrid-sleep</code>" and
141 "<code class="literal">lock</code>". If
142 "<code class="literal">ignore</code>", logind will
143 never handle these keys. If
144 "<code class="literal">lock</code>", all running
145 sessions will be screen-locked; otherwise,
146 the specified action
147 will be taken in the respective
148 event. Only input devices with the
149 "<code class="literal">power-switch</code>" udev
150 tag will be watched for key/lid switch
151 events. <code class="varname">HandlePowerKey=</code>
152 defaults to
153 "<code class="literal">poweroff</code>".
154 <code class="varname">HandleSuspendKey=</code>
155 and
156 <code class="varname">HandleLidSwitch=</code>
157 default to "<code class="literal">suspend</code>".
158 <code class="varname">HandleHibernateKey=</code>
159 defaults to
160 "<code class="literal">hibernate</code>".</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
161 actions triggered by the power and
162 sleep keys and the lid switch are
163 subject to inhibitor locks. These
164 settings take boolean arguments. If
165 "<code class="literal">off</code>", the inhibitor
166 locks taken by applications in order
167 to block the requested operation are
168 respected. If "<code class="literal">on</code>",
169 the requested operation is executed in
170 any
171 case. <code class="varname">PowerKeyIgnoreInhibited=</code>,
172 <code class="varname">SuspendKeyIgnoreInhibited=</code>
173 and
174 <code class="varname">HibernateKeyIgnoreInhibited=</code>
175 default to "<code class="literal">off</code>".
176 <code class="varname">LidSwitchIgnoreInhibited=</code>
177 defaults to
178 "<code class="literal">yes</code>". This means
179 that the lid switch does not respect
180 suspend blockers by default, but the
181 power and sleep keys do.
182 </p></dd></dl></div></div><div class="refsect1"><a name="idm274691758112"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also"></a></h2><p>
183 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
184 <a href="systemd-logind.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-logind.service</span>(8)</span></a>,
185 <a href="loginctl.html"><span class="citerefentry"><span class="refentrytitle">loginctl</span>(1)</span></a>,
186 <a href="systemd-system.conf.html"><span class="citerefentry"><span class="refentrytitle">systemd-system.conf</span>(5)</span></a>
187 </p></div></div></body></html>