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