[thirdparty/systemd.git] / man / logind.conf.xml

<?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
  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
  (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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="logind.conf">
        <refentryinfo>
                <title>logind.conf</title>
                <productname>systemd</productname>

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

        <refmeta>
                <refentrytitle>logind.conf</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>logind.conf</refname>
                <refpurpose>Login manager configuration file</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>logind.conf</filename></para>
        </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>

                <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>
Commit	Line	Data
8fa365e5 LP	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
5430f7f2 LP	12	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	13	the Free Software Foundation; either version 2.1 of the License, or
8fa365e5 LP	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
5430f7f2	19	Lesser General Public License for more details.
8fa365e5	20
5430f7f2	21	You should have received a copy of the GNU Lesser General Public License
8fa365e5 LP	22	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	23	-->
	24
18b754d3	25	<refentry id="logind.conf">
8fa365e5	26	<refentryinfo>
18b754d3	27	<title>logind.conf</title>
8fa365e5 LP	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>
18b754d3	41	<refentrytitle>logind.conf</refentrytitle>
8fa365e5 LP	42	<manvolnum>5</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
18b754d3	46	<refname>logind.conf</refname>
b47ffcfd	47	<refpurpose>Login manager configuration file</refpurpose>
8fa365e5 LP	48	</refnamediv>
	49
	50	<refsynopsisdiv>
18b754d3	51	<para><filename>logind.conf</filename></para>
8fa365e5 LP	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>
c36eecdf LP	150
	151	<para>Note that setting
	152	<varname>KillUserProcesses=1</varname> will break tools
	153	like
	154	<citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
	155
	156	<para>Note that <varname>KillUserProcesses=1</varname>
	157	is a weaker version of
	158	<varname>kill-session-processes=1</varname> which may
	159	be configured per-service for
	160	<citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The
	161	latter kills processes of a session as soon as it
	162	ends, the former kills processes as soon as the last
	163	session of the user ends.</para>
8fa365e5 LP	164	</refsect1>
	165
	166	<refsect1>
	167	<title>See Also</title>
	168	<para>
	169	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
169c4f65	170	<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
8fa365e5 LP	171	<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	172	</para>
	173	</refsect1>
	174
	175	</refentry>