logind.conf.xml revision e93549ef29c4123d9ee45acb5815048390201e49
843e19887f64dde75055cf8842fc4db2171eff45johnlev<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
843e19887f64dde75055cf8842fc4db2171eff45johnlev "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
843e19887f64dde75055cf8842fc4db2171eff45johnlev This file is part of systemd.
843e19887f64dde75055cf8842fc4db2171eff45johnlev Copyright 2010 Lennart Poettering
843e19887f64dde75055cf8842fc4db2171eff45johnlev systemd is free software; you can redistribute it and/or modify it
843e19887f64dde75055cf8842fc4db2171eff45johnlev under the terms of the GNU Lesser General Public License as published by
843e19887f64dde75055cf8842fc4db2171eff45johnlev the Free Software Foundation; either version 2.1 of the License, or
843e19887f64dde75055cf8842fc4db2171eff45johnlev (at your option) any later version.
843e19887f64dde75055cf8842fc4db2171eff45johnlev systemd is distributed in the hope that it will be useful, but
843e19887f64dde75055cf8842fc4db2171eff45johnlev WITHOUT ANY WARRANTY; without even the implied warranty of
843e19887f64dde75055cf8842fc4db2171eff45johnlev MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
843e19887f64dde75055cf8842fc4db2171eff45johnlev Lesser General Public License for more details.
843e19887f64dde75055cf8842fc4db2171eff45johnlev You should have received a copy of the GNU Lesser General Public License
843e19887f64dde75055cf8842fc4db2171eff45johnlev along with systemd; If not, see <http://www.gnu.org/licenses/>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev<refentry id="logind.conf" conditional='ENABLE_LOGIND'
843e19887f64dde75055cf8842fc4db2171eff45johnlev <refentryinfo>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <authorgroup>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </authorgroup>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </refentryinfo>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <refnamediv>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <refpurpose>Login manager configuration files</refpurpose>
843e19887f64dde75055cf8842fc4db2171eff45johnlev </refnamediv>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <refsynopsisdiv>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <para><filename>/etc/systemd/logind.conf</filename></para>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para>
843e19887f64dde75055cf8842fc4db2171eff45johnlev </refsynopsisdiv>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <para>These files configure various parameters of the systemd
843e19887f64dde75055cf8842fc4db2171eff45johnlev login manager,
843e19887f64dde75055cf8842fc4db2171eff45johnlev <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev </refsect1>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <xi:include href="standard-conf.xml" xpointer="main-conf" />
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <para>All options are configured in the
843e19887f64dde75055cf8842fc4db2171eff45johnlev <variablelist>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <listitem><para>Takes a positive integer. Configures how many
843e19887f64dde75055cf8842fc4db2171eff45johnlev virtual terminals (VTs) to allocate by default that, when
843e19887f64dde75055cf8842fc4db2171eff45johnlev switched to and are previously unused,
843e19887f64dde75055cf8842fc4db2171eff45johnlev <literal>autovt</literal> services are automatically spawned
843e19887f64dde75055cf8842fc4db2171eff45johnlev on. These services are instantiated from the template unit
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <filename>autovt@.service</filename> for the respective VT TTY
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab name, for example, <filename>autovt@tty4.service</filename>.
5d2eda970e48f8985448151c73e699614ce9f357John Levon By default, <filename>autovt@.service</filename> is linked to
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <filename>getty@.service</filename>. In other words, login
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab prompts are started dynamically as the user switches to unused
5d2eda970e48f8985448151c73e699614ce9f357John Levon virtual terminals. Hence, this parameter controls how many
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab login <literal>gettys</literal> are available on the VTs. If a
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab VT is already used by some other subsystem (for example, a
843e19887f64dde75055cf8842fc4db2171eff45johnlev graphical login), this kind of activation will not be
843e19887f64dde75055cf8842fc4db2171eff45johnlev attempted. Note that the VT configured in
843e19887f64dde75055cf8842fc4db2171eff45johnlev <varname>ReserveVT=</varname> is always subject to this kind
843e19887f64dde75055cf8842fc4db2171eff45johnlev of activation, even if it is not one of the VTs configured
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab with the <varname>NAutoVTs=</varname> directive. Defaults to
5d2eda970e48f8985448151c73e699614ce9f357John Levon 6. When set to 0, automatic spawning of
5d2eda970e48f8985448151c73e699614ce9f357John Levon </varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <listitem><para>Takes a positive integer. Identifies one
843e19887f64dde75055cf8842fc4db2171eff45johnlev virtual terminal that shall unconditionally be reserved for
843e19887f64dde75055cf8842fc4db2171eff45johnlev <filename>autovt@.service</filename> activation (see above).
843e19887f64dde75055cf8842fc4db2171eff45johnlev The VT selected with this option will be marked busy
843e19887f64dde75055cf8842fc4db2171eff45johnlev unconditionally, so that no other subsystem will allocate it.
843e19887f64dde75055cf8842fc4db2171eff45johnlev This functionality is useful to ensure that, regardless of how
843e19887f64dde75055cf8842fc4db2171eff45johnlev many VTs are allocated by other subsystems, one login
843e19887f64dde75055cf8842fc4db2171eff45johnlev <literal>getty</literal> is always available. Defaults to 6
843e19887f64dde75055cf8842fc4db2171eff45johnlev (in other words, there will always be a
843e19887f64dde75055cf8842fc4db2171eff45johnlev <literal>getty</literal> available on Alt-F6.). When set to 0,
843e19887f64dde75055cf8842fc4db2171eff45johnlev </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <listitem><para>Takes a boolean argument. Configures whether
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab the processes of a user should be killed when the user
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab completely logs out (i.e. after the user's last session
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <para>Note that setting <varname>KillUserProcesses=1</varname>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab will break tools like
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <listitem><para>These settings take space-separated lists of
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab usernames that influence the effect of
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varname>KillUserProcesses=</varname>. If not empty, only
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab processes of users listed in <varname>KillOnlyUsers=</varname>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab will be killed when they log out entirely. Processes of users
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab listed in <varname>KillExcludeUsers=</varname> are excluded
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab defaults to <literal>root</literal> and takes precedence over
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varname>KillOnlyUsers=</varname>, which defaults to the empty
843e19887f64dde75055cf8842fc4db2171eff45johnlev </varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <listitem><para>Configures the action to take when the system
843e19887f64dde75055cf8842fc4db2171eff45johnlev is idle. Takes one of
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <para>Note that this requires that user sessions correctly
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab report the idle status to the system. The system will execute
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab the action after all sessions report that they are idle, no
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab idle inhibitor lock is active, and subsequently, the time
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab configured with <varname>IdleActionSec=</varname> (see below)
843e19887f64dde75055cf8842fc4db2171eff45johnlev has expired.</para>
843e19887f64dde75055cf8842fc4db2171eff45johnlev </listitem>
843e19887f64dde75055cf8842fc4db2171eff45johnlev </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <listitem><para>Configures the delay after which the action
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab configured in <varname>IdleAction=</varname> (see above) is
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <listitem><para>Specifies the maximum time a system shutdown
843e19887f64dde75055cf8842fc4db2171eff45johnlev or sleep request is delayed due to an inhibitor lock of type
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <literal>delay</literal> being active before the inhibitor is
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab ignored and the operation executes anyway. Defaults to
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <term><varname>HandleLidSwitchDocked=</varname></term>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <listitem><para>Controls whether logind shall handle the
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab system power and sleep keys and the lid switch to trigger
843e19887f64dde75055cf8842fc4db2171eff45johnlev actions such as system power-off or suspend. Can be one of
843e19887f64dde75055cf8842fc4db2171eff45johnlev If <literal>ignore</literal>, logind will never handle these
843e19887f64dde75055cf8842fc4db2171eff45johnlev keys. If <literal>lock</literal>, all running sessions will be
843e19887f64dde75055cf8842fc4db2171eff45johnlev screen-locked; otherwise, the specified action will be taken
843e19887f64dde75055cf8842fc4db2171eff45johnlev in the respective event. Only input devices with the
843e19887f64dde75055cf8842fc4db2171eff45johnlev <literal>power-switch</literal> udev tag will be watched for
843e19887f64dde75055cf8842fc4db2171eff45johnlev key/lid switch events. <varname>HandlePowerKey=</varname>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <literal>hibernate</literal>. If the system is inserted in a
843e19887f64dde75055cf8842fc4db2171eff45johnlev docking station, or if more than one display is connected, the
843e19887f64dde75055cf8842fc4db2171eff45johnlev action specified by <varname>HandleLidSwitchDocked=</varname>
843e19887f64dde75055cf8842fc4db2171eff45johnlev occurs; otherwise the <varname>HandleLidSwitch=</varname>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <term><varname>PowerKeyIgnoreInhibited=</varname></term>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <term><varname>LidSwitchIgnoreInhibited=</varname></term>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <listitem><para>Controls whether actions triggered by the
843e19887f64dde75055cf8842fc4db2171eff45johnlev power and sleep keys and the lid switch are subject to
843e19887f64dde75055cf8842fc4db2171eff45johnlev inhibitor locks. These settings take boolean arguments. If
843e19887f64dde75055cf8842fc4db2171eff45johnlev applications in order to block the requested operation are
843e19887f64dde75055cf8842fc4db2171eff45johnlev respected. If <literal>yes</literal>, the requested operation
843e19887f64dde75055cf8842fc4db2171eff45johnlev is executed in any case.
843e19887f64dde75055cf8842fc4db2171eff45johnlev <varname>HibernateKeyIgnoreInhibited=</varname> default to
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varname>LidSwitchIgnoreInhibited=</varname> defaults to
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <literal>yes</literal>. This means that the lid switch does
843e19887f64dde75055cf8842fc4db2171eff45johnlev not respect suspend blockers by default, but the power and
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
843e19887f64dde75055cf8842fc4db2171eff45johnlev <term><varname>RuntimeDirectorySize=</varname></term>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varname>$XDG_RUNTIME_DIR</varname> runtime directory for each
843e19887f64dde75055cf8842fc4db2171eff45johnlev user who logs in. Takes a size in bytes, optionally suffixed
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab with the usual K, G, M, and T suffixes, to the base 1024
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab (IEC). Alternatively, a numerical percentage suffixed by
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <literal>%</literal> may be specified, which sets the size
843e19887f64dde75055cf8842fc4db2171eff45johnlev limit relative to the amount of physical RAM. Defaults to 10%.
843e19887f64dde75055cf8842fc4db2171eff45johnlev Note that this size is a safety limit only. As each runtime
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab directory is a tmpfs file system, it will only consume as much
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab objects belonging to the user shall be removed when the user
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab fully logs out. Takes a boolean argument. If enabled, the user
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab may not consume IPC resources after the last of the user's
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab sessions terminated. This covers System V semaphores, shared
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab memory and message queues, as well as POSIX shared memory and
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab message queues. Note that IPC objects of the root user are
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab excluded from the effect of this setting. Defaults to
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </varlistentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </variablelist>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </refsect1>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <refsect1>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab </refsect1>
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab</refentry>