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" xmlns:xi="http://www.w3.org/2001/XInclude">
  25   <refentryinfo>
  26     <title>logind.conf</title>
  27     <productname>systemd</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     <refname>logind.conf.d</refname>
  47     <refpurpose>Login manager configuration files</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>/etc/systemd/logind.conf</filename></para>
  52     <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para>
  53     <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para>
  54     <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para>These files configure various parameters of the systemd
  61     login manager,
  62     <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  63     </para>
  64   </refsect1>
  65
  66   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  67
  68   <refsect1>
  69     <title>Options</title>
  70
  71     <para>All options are configured in the
  72     <literal>[Login]</literal> section:</para>
  73
  74     <variablelist>
  75
  76       <varlistentry>
  77         <term><varname>KillUserProcesses=</varname></term>
  78
  79         <listitem><para>Takes a boolean argument. Configures whether
  80         the processes of a user should be killed when the user
  81         completely logs out (i.e. after the user's last session
  82         ended). Defaults to <literal>no</literal>.</para>
  83
  84         <para>Note that setting <varname>KillUserProcesses=1</varname>
  85         will break tools like
  86         <citerefentry project='die-net'><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term><varname>KillOnlyUsers=</varname></term>
  91         <term><varname>KillExcludeUsers=</varname></term>
  92
  93         <listitem><para>These settings take space-separated lists of
  94         usernames that influence the effect of
  95         <varname>KillUserProcesses=</varname>. If not empty, only
  96         processes of users listed in <varname>KillOnlyUsers=</varname>
  97         will be killed when they log out entirely. Processes of users
  98         listed in <varname>KillExcludeUsers=</varname> are excluded
  99         from being killed. <varname>KillExcludeUsers=</varname>
 100         defaults to <literal>root</literal> and takes precedence over
 101         <varname>KillOnlyUsers=</varname>, which defaults to the empty
 102         list.</para></listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><varname>IdleAction=</varname></term>
 107
 108         <listitem><para>Configures the action to take when the system
 109         is idle. Takes one of
 110         <literal>ignore</literal>,
 111         <literal>poweroff</literal>,
 112         <literal>reboot</literal>,
 113         <literal>halt</literal>,
 114         <literal>kexec</literal>,
 115         <literal>suspend</literal>,
 116         <literal>hibernate</literal>,
 117         <literal>hybrid-sleep</literal>, and
 118         <literal>lock</literal>.
 119         Defaults to <literal>ignore</literal>.</para>
 120
 121         <para>Note that this requires that user sessions correctly
 122         report the idle status to the system. The system will execute
 123         the action after all sessions report that they are idle, no
 124         idle inhibitor lock is active, and subsequently, the time
 125         configured with <varname>IdleActionSec=</varname> (see below)
 126         has expired.</para>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term><varname>IdleActionSec=</varname></term>
 132
 133         <listitem><para>Configures the delay after which the action
 134         configured in <varname>IdleAction=</varname> (see above) is
 135         taken after the system is idle.</para></listitem>
 136       </varlistentry>
 137
 138       <varlistentry>
 139         <term><varname>InhibitDelayMaxSec=</varname></term>
 140
 141         <listitem><para>Specifies the maximum time a system shutdown
 142         or sleep request is delayed due to an inhibitor lock of type
 143         <literal>delay</literal> being active before the inhibitor is
 144         ignored and the operation executes anyway. Defaults to
 145         5.</para></listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term><varname>HandlePowerKey=</varname></term>
 150         <term><varname>HandleSuspendKey=</varname></term>
 151         <term><varname>HandleHibernateKey=</varname></term>
 152         <term><varname>HandleLidSwitch=</varname></term>
 153         <term><varname>HandleLidSwitchDocked=</varname></term>
 154
 155         <listitem><para>Controls whether logind shall handle the
 156         system power and sleep keys and the lid switch to trigger
 157         actions such as system power-off or suspend. Can be one of
 158         <literal>ignore</literal>,
 159         <literal>poweroff</literal>,
 160         <literal>reboot</literal>,
 161         <literal>halt</literal>,
 162         <literal>kexec</literal>,
 163         <literal>suspend</literal>,
 164         <literal>hibernate</literal>,
 165         <literal>hybrid-sleep</literal>, and
 166         <literal>lock</literal>.
 167         If <literal>ignore</literal>, logind will never handle these
 168         keys. If <literal>lock</literal>, all running sessions will be
 169         screen-locked; otherwise, the specified action will be taken
 170         in the respective event. Only input devices with the
 171         <literal>power-switch</literal> udev tag will be watched for
 172         key/lid switch events. <varname>HandlePowerKey=</varname>
 173         defaults to <literal>poweroff</literal>.
 174         <varname>HandleSuspendKey=</varname> and
 175         <varname>HandleLidSwitch=</varname> default to
 176         <literal>suspend</literal>.
 177         <varname>HandleLidSwitchDocked=</varname> defaults to
 178         <literal>ignore</literal>.
 179         <varname>HandleHibernateKey=</varname> defaults to
 180         <literal>hibernate</literal>. If the system is inserted in a
 181         docking station, or if more than one display is connected, the
 182         action specified by <varname>HandleLidSwitchDocked=</varname>
 183         occurs; otherwise the <varname>HandleLidSwitch=</varname>
 184         action occurs.</para></listitem>
 185       </varlistentry>
 186
 187       <varlistentry>
 188         <term><varname>PowerKeyIgnoreInhibited=</varname></term>
 189         <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
 190         <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
 191         <term><varname>LidSwitchIgnoreInhibited=</varname></term>
 192
 193         <listitem><para>Controls whether actions triggered by the
 194         power and sleep keys and the lid switch are subject to
 195         inhibitor locks. These settings take boolean arguments. If
 196         <literal>no</literal>, the inhibitor locks taken by
 197         applications in order to block the requested operation are
 198         respected. If <literal>yes</literal>, the requested operation
 199         is executed in any case.
 200         <varname>PowerKeyIgnoreInhibited=</varname>,
 201         <varname>SuspendKeyIgnoreInhibited=</varname> and
 202         <varname>HibernateKeyIgnoreInhibited=</varname> default to
 203         <literal>no</literal>.
 204         <varname>LidSwitchIgnoreInhibited=</varname> defaults to
 205         <literal>yes</literal>. This means that the lid switch does
 206         not respect suspend blockers by default, but the power and
 207         sleep keys do. </para></listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term><varname>HoldoffTimeoutSec=</varname></term>
 212
 213         <listitem><para>Specifies the timeout after system startup or
 214         system resume in which systemd will hold off on reacting to
 215         LID events. This is required for the system to properly
 216         detect any hotplugged devices so systemd can ignore LID events
 217         if external monitors, or docks, are connected. If set to 0,
 218         systemd will always react immediately, possibly before the
 219         kernel fully probed all hotplugged devices. This is safe, as
 220         long as you do not care for systemd to account for devices
 221         that have been plugged or unplugged while the system was off.
 222         Defaults to 30s.</para></listitem>
 223       </varlistentry>
 224
 225       <varlistentry>
 226         <term><varname>RuntimeDirectorySize=</varname></term>
 227
 228         <listitem><para>Sets the size limit on the
 229         <varname>$XDG_RUNTIME_DIR</varname> runtime directory for each
 230         user who logs in. Takes a size in bytes, optionally suffixed
 231         with the usual K, G, M, and T suffixes, to the base 1024
 232         (IEC). Alternatively, a numerical percentage suffixed by
 233         <literal>%</literal> may be specified, which sets the size
 234         limit relative to the amount of physical RAM. Defaults to 10%.
 235         Note that this size is a safety limit only. As each runtime
 236         directory is a tmpfs file system, it will only consume as much
 237         memory as is needed. </para></listitem>
 238       </varlistentry>
 239
 240       <varlistentry>
 241         <term><varname>RemoveIPC=</varname></term>
 242
 243         <listitem><para>Controls whether System V and POSIX IPC
 244         objects belonging to the user shall be removed when the user
 245         fully logs out. Takes a boolean argument. If enabled, the user
 246         may not consume IPC resources after the last of the user's
 247         sessions terminated. This covers System V semaphores, shared
 248         memory and message queues, as well as POSIX shared memory and
 249         message queues. Note that IPC objects of the root user are
 250         excluded from the effect of this setting. Defaults to
 251         <literal>yes</literal>.</para></listitem>
 252       </varlistentry>
 253
 254     </variablelist>
 255   </refsect1>
 256
 257   <refsect1>
 258       <title>See Also</title>
 259       <para>
 260         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 261         <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 262         <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 263         <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 264       </para>
 265   </refsect1>
 266
 267 </refentry>