chiark / gitweb /
889bd1567e1463ce02f7baedde5982ab8cd1e600
[elogind.git] / man / systemd-logind.conf.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <!--
7   This file is part of systemd.
8
9   Copyright 2010 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU General Public License as published by
13   the Free Software Foundation; either version 2 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   General Public License for more details.
20
21   You should have received a copy of the GNU General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 -->
24
25 <refentry id="systemd-logind.conf">
26         <refentryinfo>
27                 <title>systemd-logind.conf</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>systemd-logind.conf</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd-logind.conf</refname>
47                 <refpurpose>login manager configuration file</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <para><filename>systemd-login.conf</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para>This files configures various parameters of the systemd login manager.</para>
58
59         </refsect1>
60
61         <refsect1>
62                 <title>Options</title>
63
64                 <para>All options are configured in the
65                 <literal>[Login]</literal> section:</para>
66
67                 <variablelist>
68
69                         <varlistentry>
70                                 <term><varname>NAutoVTs=</varname></term>
71
72                                 <listitem><para>Takes a positive
73                                 integer. How many virtual terminals to
74                                 allocate by default and when switched
75                                 to autospawn <literal>autovt</literal>
76                                 services on (if they are otherwise
77                                 unused). These services are
78                                 instantiated from a template of
79                                 <filename>autovt@.service</filename>
80                                 with the virtual terminal TTY name,
81                                 e.g. <filename>autovt@tty4.service</filename>. By
82                                 default
83                                 <filename>autovt@.service</filename>
84                                 is linked to
85                                 <filename>getty@.service</filename>,
86                                 i.e. login prompts are started
87                                 dynamically as the user switches to
88                                 unused virtual terminals, and this
89                                 parameter hence controls how many
90                                 gettys are available on the virtual
91                                 terminals. Defaults to 6. When set to
92                                 0, automatic spawning of
93                                 <literal>autovt</literal> services is
94                                 disabled.</para></listitem>
95                         </varlistentry>
96
97                         <varlistentry>
98                                 <term><varname>KillUserProcesses=</varname></term>
99
100                                 <listitem><para>Takes a boolean
101                                 argument. Configures whether the
102                                 processes of a user should be killed
103                                 when she or he completely logs out (i.e. after
104                                 her/his last session ended). Defaults to
105                                 <literal>no</literal>.</para></listitem>
106                         </varlistentry>
107
108                         <varlistentry>
109                                 <term><varname>KillOnlyUsers=</varname></term>
110                                 <term><varname>KillExcludeUsers=</varname></term>
111
112                                 <listitem><para>These settings take
113                                 space separated lists of user names
114                                 that influence the effect of
115                                 <varname>KillUserProcesses=</varname>. If
116                                 not empty only processes of users
117                                 listed in
118                                 <varname>KillOnlyUsers</varname> will
119                                 be killed when they log out
120                                 entirely. Processes of users listed in
121                                 <varname>KillExcludeUsers=</varname>
122                                 are excluded from being
123                                 killed. <varname>KillExcludeUsers=</varname>
124                                 defaults to <literal>root</literal>
125                                 and takes precedence over
126                                 <varname>KillOnlyUsers=</varname>
127                                 which defaults to the empty list.</para></listitem>
128                         </varlistentry>
129
130                         <varlistentry>
131                                 <term><varname>Controllers=</varname></term>
132                                 <term><varname>ResetControllers=</varname></term>
133
134                                 <listitem><para>These settings control
135                                 the default control group hierarchies
136                                 users logging are added to. When
137                                 logging in users will get private
138                                 control groups in all hierarchies
139                                 listed in
140                                 <varname>Controllers=</varname> and be
141                                 reset to the root control group in all
142                                 hierarchies listed in
143                                 <varname>ResetControllers=</varname>. <varname>Controllers=</varname>
144                                 defaults to the empty list,
145                                 <varname>ResetControllers=</varname>
146                                 defaults to
147                                 <literal>cpu</literal>.</para></listitem>
148                         </varlistentry>
149                 </variablelist>
150         </refsect1>
151
152         <refsect1>
153                   <title>See Also</title>
154                   <para>
155                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
156                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
157                   </para>
158         </refsect1>
159
160 </refentry>