logind.conf.xml revision 069cfc85f876bb6966cb5a9bbe0235f5064622cd
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor<?xml version='1.0'?> <!--*-nxml-*-->
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
a52bc627e27a94219f06896ac183d90deb79ad31lgentis "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor<!--
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor This file is part of systemd.
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor Copyright 2010 Lennart Poettering
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor systemd is free software; you can redistribute it and/or modify it
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor under the terms of the GNU Lesser General Public License as published by
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor the Free Software Foundation; either version 2.1 of the License, or
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor (at your option) any later version.
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor systemd is distributed in the hope that it will be useful, but
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor WITHOUT ANY WARRANTY; without even the implied warranty of
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor Lesser General Public License for more details.
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor You should have received a copy of the GNU Lesser General Public License
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor along with systemd; If not, see <http://www.gnu.org/licenses/>.
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor-->
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor<refentry id="logind.conf">
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <refentryinfo>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <title>logind.conf</title>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <productname>systemd</productname>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <authorgroup>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <author>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <contrib>Developer</contrib>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <firstname>Lennart</firstname>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <surname>Poettering</surname>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <email>lennart@poettering.net</email>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor </author>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor </authorgroup>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor </refentryinfo>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <refmeta>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <refentrytitle>logind.conf</refentrytitle>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <manvolnum>5</manvolnum>
3841a292dc897875faf23e639807abcc90082f3clgentis </refmeta>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <refnamediv>
3841a292dc897875faf23e639807abcc90082f3clgentis <refname>logind.conf</refname>
3841a292dc897875faf23e639807abcc90082f3clgentis <refpurpose>Login manager configuration file</refpurpose>
3841a292dc897875faf23e639807abcc90082f3clgentis </refnamediv>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <refsynopsisdiv>
3841a292dc897875faf23e639807abcc90082f3clgentis <para><filename>logind.conf</filename></para>
a52bc627e27a94219f06896ac183d90deb79ad31lgentis </refsynopsisdiv>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <refsect1>
3841a292dc897875faf23e639807abcc90082f3clgentis <title>Description</title>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <para>This files configures various parameters of the systemd login manager.</para>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis </refsect1>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <refsect1>
3841a292dc897875faf23e639807abcc90082f3clgentis <title>Options</title>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <para>All options are configured in the
3841a292dc897875faf23e639807abcc90082f3clgentis <literal>[Login]</literal> section:</para>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <variablelist>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <varlistentry>
3841a292dc897875faf23e639807abcc90082f3clgentis <term><varname>NAutoVTs=</varname></term>
3841a292dc897875faf23e639807abcc90082f3clgentis
3841a292dc897875faf23e639807abcc90082f3clgentis <listitem><para>Takes a positive
3841a292dc897875faf23e639807abcc90082f3clgentis integer. How many virtual terminals to
3841a292dc897875faf23e639807abcc90082f3clgentis allocate by default and when switched
3841a292dc897875faf23e639807abcc90082f3clgentis to autospawn <literal>autovt</literal>
3841a292dc897875faf23e639807abcc90082f3clgentis services on (if they are otherwise
3841a292dc897875faf23e639807abcc90082f3clgentis unused). These services are
3841a292dc897875faf23e639807abcc90082f3clgentis instantiated from a template of
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <filename>autovt@.service</filename>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor with the virtual terminal TTY name,
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor e.g. <filename>autovt@tty4.service</filename>. By
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor default
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <filename>autovt@.service</filename>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor is linked to
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <filename>getty@.service</filename>,
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor i.e. login prompts are started
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor dynamically as the user switches to
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor unused virtual terminals, and this
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor parameter hence controls how many
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor gettys are available on the virtual
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor terminals. Defaults to 6. When set to
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor 0, automatic spawning of
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <literal>autovt</literal> services is
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor disabled.</para></listitem>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor </varlistentry>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <varlistentry>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <term><varname>KillUserProcesses=</varname></term>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <listitem><para>Takes a boolean
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor argument. Configures whether the
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor processes of a user should be killed
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor when she or he completely logs out (i.e. after
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor her/his last session ended). Defaults to
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <literal>no</literal>.</para></listitem>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor </varlistentry>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <varlistentry>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <term><varname>KillOnlyUsers=</varname></term>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <term><varname>KillExcludeUsers=</varname></term>
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <listitem><para>These settings take
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor space separated lists of user names
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor that influence the effect of
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <varname>KillUserProcesses=</varname>. If
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor not empty only processes of users
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor listed in
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor <varname>KillOnlyUsers</varname> will
69cbd335b8c18c32569dfd8a62e7c56e2e1724b5gryzor 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 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 taken 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>no</literal>,
<literal>yes</literal> and
<literal>always</literal>. If
<literal>no</literal> logind will
never handle these keys. If
<literal>yes</literal> logind will
handle these keys when no user is
logged in and no inhibitor lock is
taken, and trigger a warnig beep
otherwise. If set to
<literal>always</literal> logind will
handle these keys even if a user is
logged in or an inhibitor lock is
taken. In all cases logind will not
handle these keys if a graphical
session is in the foreground under the
assumption that the graphical session
will handle these keys
internally. Only input devices with
the <literal>power-switch</literal>
udev tag will be watched for key
events. <varname>HandlePowerKey=</varname>
and <varname>HandleSleepKey=</varname>
default to <literal>yes</literal>,
<varname>HandleLidSwitch=</varname>
defaults to
<literal>no</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>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>