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