man/logind.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="logind.conf">
  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                 <refpurpose>Login manager configuration file</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <para><filename>logind.conf</filename></para>
  52         </refsynopsisdiv>
  53
  54         <refsect1>
  55                 <title>Description</title>
  56
  57                 <para>This files configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  58
  59         </refsect1>
  60
  61         <refsect1>
  62                 <title>Options</title>
  63
  64                 <para>All options are configured in the
  65                 <literal>[Login]</literal> section:</para>
  66
  67                 <variablelist>
  68
  69                         <varlistentry>
  70                                 <term><varname>NAutoVTs=</varname></term>
  71
  72                                 <listitem><para>Takes a positive
  73                                 integer. How many virtual terminals to
  74                                 allocate by default and when switched
  75                                 to autospawn <literal>autovt</literal>
  76                                 services on (if they are otherwise
  77                                 unused). These services are
  78                                 instantiated from a template of
  79                                 <filename>autovt@.service</filename>
  80                                 with the virtual terminal TTY name,
  81                                 e.g. <filename>autovt@tty4.service</filename>. By
  82                                 default
  83                                 <filename>autovt@.service</filename>
  84                                 is linked to
  85                                 <filename>getty@.service</filename>,
  86                                 i.e. login prompts are started
  87                                 dynamically as the user switches to
  88                                 unused virtual terminals, and this
  89                                 parameter hence controls how many
  90                                 gettys are available on the virtual
  91                                 terminals. Defaults to 6. When set to
  92                                 0, automatic spawning of
  93                                 <literal>autovt</literal> services is
  94                                 disabled.</para></listitem>
  95                         </varlistentry>
  96
  97                         <varlistentry>
  98                                 <term><varname>KillUserProcesses=</varname></term>
  99
 100                                 <listitem><para>Takes a boolean
 101                                 argument. Configures whether the
 102                                 processes of a user should be killed
 103                                 when she or he completely logs out (i.e. after
 104                                 her/his last session ended). Defaults to
 105                                 <literal>no</literal>.</para></listitem>
 106                         </varlistentry>
 107
 108                         <varlistentry>
 109                                 <term><varname>KillOnlyUsers=</varname></term>
 110                                 <term><varname>KillExcludeUsers=</varname></term>
 111
 112                                 <listitem><para>These settings take
 113                                 space separated lists of user names
 114                                 that influence the effect of
 115                                 <varname>KillUserProcesses=</varname>. If
 116                                 not empty only processes of users
 117                                 listed in
 118                                 <varname>KillOnlyUsers</varname> will
 119                                 be killed when they log out
 120                                 entirely. Processes of users listed in
 121                                 <varname>KillExcludeUsers=</varname>
 122                                 are excluded from being
 123                                 killed. <varname>KillExcludeUsers=</varname>
 124                                 defaults to <literal>root</literal>
 125                                 and takes precedence over
 126                                 <varname>KillOnlyUsers=</varname>
 127                                 which defaults to the empty list.</para></listitem>
 128                         </varlistentry>
 129
 130                         <varlistentry>
 131                                 <term><varname>Controllers=</varname></term>
 132                                 <term><varname>ResetControllers=</varname></term>
 133
 134                                 <listitem><para>These settings control
 135                                 the default control group hierarchies
 136                                 users logging are added to. When
 137                                 logging in users will get private
 138                                 control groups in all hierarchies
 139                                 listed in
 140                                 <varname>Controllers=</varname> and be
 141                                 reset to the root control group in all
 142                                 hierarchies listed in
 143                                 <varname>ResetControllers=</varname>. <varname>Controllers=</varname>
 144                                 defaults to the empty list,
 145                                 <varname>ResetControllers=</varname>
 146                                 defaults to
 147                                 <literal>cpu</literal>.</para></listitem>
 148                         </varlistentry>
 149
 150                         <varlistentry>
 151                                 <term><varname>InhibitDelayMaxSec=</varname></term>
 152
 153                                 <listitem><para>Specifies the maximum
 154                                 time a system shutdown or sleep
 155                                 request is delayed due to an inhibitor
 156                                 lock of type <literal>delay</literal>
 157                                 being taken before it is ignored and
 158                                 the operation executed
 159                                 anyway. Defaults to
 160                                 5s.</para></listitem>
 161                         </varlistentry>
 162
 163                         <varlistentry>
 164                                 <term><varname>HandlePowerKey=</varname></term>
 165                                 <term><varname>HandleSleepKey=</varname></term>
 166                                 <term><varname>HandleLidSwitch=</varname></term>
 167
 168                                 <listitem><para>Controls whether
 169                                 logind shall handle the system power
 170                                 and sleep keys and the lid switch to
 171                                 trigger system power-off or
 172                                 suspend. Can be one of
 173                                 <literal>off</literal>,
 174                                 <literal>no-session</literal>,
 175                                 <literal>tty-session</literal>,
 176                                 <literal>any-session</literal> and
 177                                 <literal>always</literal>. If
 178                                 <literal>off</literal> logind will
 179                                 never handle these keys. If
 180                                 <literal>no-session</literal> logind
 181                                 will handle these keys when no user is
 182                                 logged in and no inhibitor lock is
 183                                 taken, and trigger a warnig beep
 184                                 otherwise. If set to
 185                                 <literal>tty-session</literal> logind
 186                                 will handle these keys if no inhibitor
 187                                 lock is taken, and either no user is
 188                                 logged in or the foreground session is
 189                                 a text login and the only one
 190                                 existing. If
 191                                 <literal>any-session</literal> is set
 192                                 logind will handle these keys if no
 193                                 inhibitor lock is taken, and either no
 194                                 user is logged in or the foreground
 195                                 session is the only one existing
 196                                 (regardless whether graphical or
 197                                 text). If set to
 198                                 <literal>always</literal> logind will
 199                                 handle these keys in any case, even if
 200                                 one or more users are logged in or an
 201                                 inhibitor lock is taken. Only input
 202                                 devices with the
 203                                 <literal>power-switch</literal> udev
 204                                 tag will be watched for key
 205                                 events. <varname>HandlePowerKey=</varname>
 206                                 defaults to
 207                                 <literal>no-session</literal>.
 208                                 <varname>HandleSleepKey=</varname>
 209                                 defaults to
 210                                 <literal>tty-session</literal>,
 211                                 <varname>HandleLidSwitch=</varname>
 212                                 defaults to
 213                                 <literal>off</literal>.</para></listitem>
 214                         </varlistentry>
 215
 216                 </variablelist>
 217
 218                 <para>Note that setting
 219                 <varname>KillUserProcesses=1</varname> will break tools
 220                 like
 221                 <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
 222
 223                 <para>Note that <varname>KillUserProcesses=1</varname>
 224                 is a weaker version of
 225                 <varname>kill-session-processes=1</varname> which may
 226                 be configured per-service for
 227                 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The
 228                 latter kills processes of a session as soon as it
 229                 ends, the former kills processes as soon as the last
 230                 session of the user ends.</para>
 231         </refsect1>
 232
 233         <refsect1>
 234                   <title>See Also</title>
 235                   <para>
 236                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 237                           <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 238                           <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 239                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 240                   </para>
 241         </refsect1>
 242
 243 </refentry>