logind.conf.xml revision 98a77df5fe8591034c48e5d56d903ee268de37f9
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend<?xml version='1.0'?> <!--*-nxml-*-->
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7ec4d5cc4aa574e3191bc5a612e68fd8f25ab7earpluem
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend<!--
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend This file is part of systemd.
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend Copyright 2010 Lennart Poettering
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
d9b843d090f14405079b4a61a493316cd3f1e5b9minfrin systemd is free software; you can redistribute it and/or modify it
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend under the terms of the GNU Lesser General Public License as published by
367d146f245f3b1c9f77c18e6ec591b52e0b344cbnicholes the Free Software Foundation; either version 2.1 of the License, or
909ce17e2bd0faef7b1c294f2307f009793fd493nd (at your option) any later version.
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend systemd is distributed in the hope that it will be useful, but
0ce5630695a7aa568811a9dd0aceedd685f040dend WITHOUT ANY WARRANTY; without even the implied warranty of
42af92a661a06b3cebc88d585aad75064a309d51nd MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
367d146f245f3b1c9f77c18e6ec591b52e0b344cbnicholes Lesser General Public License for more details.
6fe26506780e73be2a412d758af77fafdf03291and
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend You should have received a copy of the GNU Lesser General Public License
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend along with systemd; If not, see <http://www.gnu.org/licenses/>.
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend-->
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend<refentry id="logind.conf">
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refentryinfo>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <title>logind.conf</title>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <productname>systemd</productname>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <authorgroup>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <author>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <contrib>Developer</contrib>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <firstname>Lennart</firstname>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <surname>Poettering</surname>
05ede5110427cb9dc071cc671d5aaba5d3b88c79nd <email>lennart@poettering.net</email>
e8b603fa9ccf7b17b11b42df6d8916fd97c2331dnd </author>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </authorgroup>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </refentryinfo>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
d6ce05b6521a82cc93da69f7c2116c4a5bc54f8cjim <refmeta>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refentrytitle>logind.conf</refentrytitle>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <manvolnum>5</manvolnum>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </refmeta>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refnamediv>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refname>logind.conf</refname>
03a4ff9ac4c9b8009249010e7c53bb86ff05915and <refpurpose>Login manager configuration file</refpurpose>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </refnamediv>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
7d15331eeb5429d7148d13d6fd914a641bf1c000pquerna <refsynopsisdiv>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <para><filename>/etc/systemd/logind.conf</filename></para>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </refsynopsisdiv>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refsect1>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <title>Description</title>
d2b809e5d72658bff23819d8b77f20e4939af541nd
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <para>This file configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend </refsect1>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <refsect1>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <title>Options</title>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
6b0fe1f447ba35827cd5cf1d2a703bd8517f33ffmturk <para>All options are configured in the
6b0fe1f447ba35827cd5cf1d2a703bd8517f33ffmturk <literal>[Login]</literal> section:</para>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <variablelist>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend
623eebe956d9c2d6d073ed3eae855b56030b40e9noodl <varlistentry>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <term><varname>NAutoVTs=</varname></term>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <listitem><para>Takes a positive
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin integer. Configures how many virtual
f195a136dcd90148b116fdae8ce95b41ba92b87eminfrin terminals (VTs) to allocate by default
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend that -- when switched to and
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend previously unused --
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <literal>autovt</literal> services are
0ce5630695a7aa568811a9dd0aceedd685f040dend automatically spawned on. These
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend services are instantiated from the
10eed2803538d660048f6e733602e82a75ef6885noodl template unit
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <filename>autovt@.service</filename>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend for the respective VT TTY name,
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend e.g. <filename>autovt@tty4.service</filename>. By
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend default
03c25fb6f628ac81f2ecb637d1e7502dcee783f3nd <filename>autovt@.service</filename>
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend is linked to
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <filename>getty@.service</filename>,
0ce5630695a7aa568811a9dd0aceedd685f040dend i.e. login prompts are started
7fa75a06a4fee19e995c069ee00310455d1452e1pquerna dynamically as the user switches to
0ce5630695a7aa568811a9dd0aceedd685f040dend unused virtual terminals. Hence, this
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend parameter controls how many login
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend <literal>gettys</literal> are
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend available on the VTs. If a VT is
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend already used by some other subsystem
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend (for example a graphical login) this
0ce5630695a7aa568811a9dd0aceedd685f040dend kind of activation will not be
0ce5630695a7aa568811a9dd0aceedd685f040dend attempted. Note that the VT configured
f73f2c2fae0ded6c8273c28d025ba8aa8136a0fend in <varname>ReserveVT=</varname> is
always subject to this kind of
activation, even if it is not one of
VTs configured with the
<varname>NAutoVTs=</varname>
directive. Defaults to 6. When set to
0, automatic spawning of
<literal>autovt</literal> services is
disabled. </para></listitem>
</varlistentry>
<varlistentry>
<term><varname>ReserveVT=</varname></term>
<listitem><para>Takes a positive
integer. Configures the number of one
virtual terminal that shall
unconditionally be reserved for
<filename>autovt@.service</filename>
activation (see above). The VT
selected with this option will be
marked busy unconditionally so that no
other subsystem will allocate it. This
functionality is useful to ensure that
regardless how many VTs are allocated
by other subsystems one login
<literal>getty</literal> is always
available. Defaults to 6 (with other
words: there'll always be a
<literal>getty</literal> available on
Alt-F6.). When set to 0, VT
reservation is
disabled.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>KillUserProcesses=</varname></term>
<listitem><para>Takes a boolean
argument. Configures whether the
processes of a user should be killed
when she or he completely logs out (i.e. after
her/his last session ended). Defaults to
<literal>no</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>KillOnlyUsers=</varname></term>
<term><varname>KillExcludeUsers=</varname></term>
<listitem><para>These settings take
space separated lists of user names
that influence the effect of
<varname>KillUserProcesses=</varname>. If
not empty only processes of users
listed in
<varname>KillOnlyUsers</varname> will
be killed when they log out
entirely. Processes of users listed in
<varname>KillExcludeUsers=</varname>
are excluded from being
killed. <varname>KillExcludeUsers=</varname>
defaults to <literal>root</literal>
and takes precedence over
<varname>KillOnlyUsers=</varname>
which defaults to the empty list.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>Controllers=</varname></term>
<term><varname>ResetControllers=</varname></term>
<listitem><para>These settings control
the default control group hierarchies
users logging in are added to. When
logging in users will get private
control groups in all hierarchies
listed in
<varname>Controllers=</varname> and be
reset to the root control group in all
hierarchies listed in
<varname>ResetControllers=</varname>. <varname>Controllers=</varname>
defaults to the empty list,
<varname>ResetControllers=</varname>
defaults to
<literal>cpu</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>InhibitDelayMaxSec=</varname></term>
<listitem><para>Specifies the maximum
time a system shutdown or sleep
request is delayed due to an inhibitor
lock of type <literal>delay</literal>
being active -- before it is ignored
and the operation executed
anyway. Defaults to
5s.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>HandlePowerKey=</varname></term>
<term><varname>HandleSleepKey=</varname></term>
<term><varname>HandleLidSwitch=</varname></term>
<listitem><para>Controls whether
logind shall handle the system power
and sleep keys and the lid switch to
trigger system power-off or
suspend. Can be one of
<literal>off</literal>,
<literal>no-session</literal>,
<literal>tty-session</literal>,
<literal>any-session</literal> and
<literal>always</literal>. If
<literal>off</literal> logind will
never handle these keys. If
<literal>no-session</literal> logind
will handle these keys when no user is
logged in and no inhibitor lock is
taken, and trigger a warning beep
otherwise. If set to
<literal>tty-session</literal> logind
will handle these keys if no inhibitor
lock is taken, and either no user is
logged in or the foreground session is
a text login and the only one
existing. If
<literal>any-session</literal> is set
logind will handle these keys if no
inhibitor lock is taken, and either no
user is logged in or the foreground
session is the only one existing
(regardless whether graphical or
text). If set to
<literal>always</literal> logind will
handle these keys in any case, even if
one or more users are logged in or an
inhibitor lock is taken. Only input
devices with the
<literal>power-switch</literal> udev
tag will be watched for key
events. <varname>HandlePowerKey=</varname>
defaults to
<literal>no-session</literal>.
<varname>HandleSleepKey=</varname>
defaults to
<literal>tty-session</literal>,
<varname>HandleLidSwitch=</varname>
defaults to
<literal>off</literal>.</para></listitem>
</varlistentry>
</variablelist>
<para>Note that setting
<varname>KillUserProcesses=1</varname> will break tools
like
<citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
<para>Note that <varname>KillUserProcesses=1</varname>
is a weaker version of
<varname>kill-session-processes=1</varname> which may
be configured per-service for
<citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The
latter kills processes of a session as soon as it
ends, the former kills processes as soon as the last
session of the user ends.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>