logind.conf.xml 8.21 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
12 13
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
14 15 16 17 18
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  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 23 24
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

25
<refentry id="logind.conf">
26
        <refentryinfo>
27
                <title>logind.conf</title>
28 29 30 31 32 33 34 35 36 37 38 39 40
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
41
                <refentrytitle>logind.conf</refentrytitle>
42 43 44 45
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
46
                <refname>logind.conf</refname>
47
                <refpurpose>Login manager configuration file</refpurpose>
48 49 50
        </refnamediv>

        <refsynopsisdiv>
51
                <para><filename>logind.conf</filename></para>
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>This files configures various parameters of the systemd login manager.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>All options are configured in the
                <literal>[Login]</literal> section:</para>

                <variablelist>

                        <varlistentry>
                                <term><varname>NAutoVTs=</varname></term>

                                <listitem><para>Takes a positive
                                integer. How many virtual terminals to
                                allocate by default and when switched
                                to autospawn <literal>autovt</literal>
                                services on (if they are otherwise
                                unused). These services are
                                instantiated from a template of
                                <filename>autovt@.service</filename>
                                with the virtual terminal TTY name,
                                e.g. <filename>autovt@tty4.service</filename>. By
                                default
                                <filename>autovt@.service</filename>
                                is linked to
                                <filename>getty@.service</filename>,
                                i.e. login prompts are started
                                dynamically as the user switches to
                                unused virtual terminals, and this
                                parameter hence controls how many
                                gettys are available on the virtual
                                terminals. Defaults to 6. When set to
                                0, automatic spawning of
                                <literal>autovt</literal> services 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 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>
                </variablelist>
150 151 152 153 154 155 156 157 158 159 160 161 162 163

                <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>
164 165 166 167 168 169
        </refsect1>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
170
                          <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
171 172 173 174 175
                          <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                  </para>
        </refsect1>

</refentry>