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