systemd/man/logind.conf.xml

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

</refentry>