man/logind.conf.xml

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