[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" conditional='ENABLE_LOGIND'>
        <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>/etc/systemd/logind.conf</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>This file configures various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</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. Configures how many virtual
                                terminals (VTs) to allocate by default
                                that, when switched to and are
                                previously unused,
                                <literal>autovt</literal> services are
                                automatically spawned on. These
                                services are instantiated from the
                                template unit
                                <filename>autovt@.service</filename>
                                for the respective VT 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. Hence, this
                                parameter controls how many login
                                <literal>gettys</literal> are
                                available on the VTs. If a VT is
                                already used by some other subsystem
                                (for example a graphical login), this
                                kind of activation will not be
                                attempted. Note that the VT configured
                                in <varname>ReserveVT=</varname> is
                                always subject to this kind of
                                activation, even if it is not one of
                                VTs configured with the
                                <varname>NAutoVTs=</varname>
                                directive. Defaults to 6. When set to
                                0, automatic spawning of
                                <literal>autovt</literal> services is
                                disabled.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>ReserveVT=</varname></term>

                                <listitem><para>Takes a positive
                                integer. Configures the number of one
                                virtual terminal that shall
                                unconditionally be reserved for
                                <filename>autovt@.service</filename>
                                activation (see above). The VT
                                selected with this option will be
                                marked busy unconditionally, so that no
                                other subsystem will allocate it. This
                                functionality is useful to ensure that
                                regardless of how many VTs are allocated
                                by other subsystems, one login
                                <literal>getty</literal> is always
                                available. Defaults to 6 (in other
                                words, there will always be a
                                <literal>getty</literal> available on
                                Alt-F6.). When set to 0, VT
                                reservation 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>

                                <para>Note that setting
                                <varname>KillUserProcesses=1</varname>
                                will break tools like
                                <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>KillOnlyUsers=</varname></term>
                                <term><varname>KillExcludeUsers=</varname></term>

                                <listitem><para>These settings take
                                space-separated lists of usernames
                                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>IdleAction=</varname></term>

                                <listitem><para>Configures the action
                                to take when the system is idle. Takes
                                one of <literal>ignore</literal>,
                                <literal>poweroff</literal>,
                                <literal>reboot</literal>,
                                <literal>halt</literal>,
                                <literal>kexec</literal>,
                                <literal>suspend</literal>,
                                <literal>hibernate</literal>,
                                <literal>hybrid-sleep</literal>,
                                <literal>lock</literal>. Defaults to
                                <literal>ignore</literal>.</para>

                                <para>Note that this requires that
                                user sessions correctly report the
                                idle status to the system. The system
                                will execute the action after all
                                sessions report that they are idle,
                                no idle inhibitor lock is active,
                                and subsequently, the time configured
                                with <varname>IdleActionSec=</varname>
                                (see below) has expired.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>IdleActionSec=</varname></term>

                                <listitem><para>Configures the delay
                                after which the action configured in
                                <varname>IdleAction=</varname> (see
                                above) is taken after the system is
                                idle.</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 active before the inhibitor is
                                ignored and the operation executes
                                anyway. Defaults to
                                5s.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>HandlePowerKey=</varname></term>
                                <term><varname>HandleSuspendKey=</varname></term>
                                <term><varname>HandleHibernateKey=</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 actions such as system
                                power-off or suspend. Can be one of
                                <literal>ignore</literal>,
                                <literal>poweroff</literal>,
                                <literal>reboot</literal>,
                                <literal>halt</literal>,
                                <literal>kexec</literal>,
                                <literal>suspend</literal>,
                                <literal>hibernate</literal>,
                                <literal>hybrid-sleep</literal> and
                                <literal>lock</literal>. If
                                <literal>ignore</literal>, logind will
                                never handle these keys. If
                                <literal>lock</literal>, all running
                                sessions will be screen-locked; otherwise,
                                the specified action
                                will be taken in the respective
                                event. Only input devices with the
                                <literal>power-switch</literal> udev
                                tag will be watched for key/lid switch
                                events. <varname>HandlePowerKey=</varname>
                                defaults to
                                <literal>poweroff</literal>.
                                <varname>HandleSuspendKey=</varname>
                                and
                                <varname>HandleLidSwitch=</varname>
                                default to <literal>suspend</literal>.
                                <varname>HandleHibernateKey=</varname>
                                defaults to
                                <literal>hibernate</literal>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>PowerKeyIgnoreInhibited=</varname></term>
                                <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
                                <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
                                <term><varname>LidSwitchIgnoreInhibited=</varname></term>

                                <listitem><para>Controls whether
                                actions triggered by the power and
                                sleep keys and the lid switch are
                                subject to inhibitor locks. These
                                settings take boolean arguments. If
                                <literal>off</literal>, the inhibitor
                                locks taken by applications in order
                                to block the requested operation are
                                respected. If <literal>on</literal>,
                                the requested operation is executed in
                                any
                                case. <varname>PowerKeyIgnoreInhibited=</varname>,
                                <varname>SuspendKeyIgnoreInhibited=</varname>
                                and
                                <varname>HibernateKeyIgnoreInhibited=</varname>
                                default to <literal>off</literal>.
                                <varname>LidSwitchIgnoreInhibited=</varname>
                                defaults to
                                <literal>yes</literal>. This means
                                that the lid switch does not respect
                                suspend blockers by default, but the
                                power and sleep keys do.
                                </para></listitem>
                        </varlistentry>

                </variablelist>
        </refsect1>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd-system.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
4fe52119	25	<refentry id="logind.conf" conditional='ENABLE_LOGIND'>
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>
01cf0ca8	51	<para><filename>/etc/systemd/logind.conf</filename></para>
8fa365e5 LP	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
409dee2e	57	<para>This file configures various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
8fa365e5 LP	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
64e441d0	73	integer. Configures how many virtual
98a77df5	74	terminals (VTs) to allocate by default
a3f6aa26 JSJ	75	that, when switched to and are
a3f6aa26 JSJ	76	previously unused,
64e441d0 LP	77	<literal>autovt</literal> services are
	78	automatically spawned on. These
	79	services are instantiated from the
98a77df5	80	template unit
8fa365e5	81	<filename>autovt@.service</filename>
98a77df5	82	for the respective VT TTY name,
8fa365e5	83	e.g. <filename>autovt@tty4.service</filename>. By
409dee2e	84	default,
8fa365e5 LP	85	<filename>autovt@.service</filename>
	86	is linked to
	87	<filename>getty@.service</filename>,
	88	i.e. login prompts are started
	89	dynamically as the user switches to
98a77df5 LP	90	unused virtual terminals. Hence, this
	91	parameter controls how many login
	92	<literal>gettys</literal> are
	93	available on the VTs. If a VT is
	94	already used by some other subsystem
409dee2e	95	(for example a graphical login), this
98a77df5 LP	96	kind of activation will not be
	97	attempted. Note that the VT configured
	98	in <varname>ReserveVT=</varname> is
	99	always subject to this kind of
	100	activation, even if it is not one of
	101	VTs configured with the
	102	<varname>NAutoVTs=</varname>
	103	directive. Defaults to 6. When set to
8fa365e5 LP	104	0, automatic spawning of
8fa365e5 LP	105	<literal>autovt</literal> services is
409dee2e	106	disabled.</para></listitem>
98a77df5 LP	107	</varlistentry>
	108
	109	<varlistentry>
	110	<term><varname>ReserveVT=</varname></term>
	111
	112	<listitem><para>Takes a positive
	113	integer. Configures the number of one
	114	virtual terminal that shall
	115	unconditionally be reserved for
	116	<filename>autovt@.service</filename>
	117	activation (see above). The VT
	118	selected with this option will be
a3f6aa26	119	marked busy unconditionally, so that no
98a77df5 LP	120	other subsystem will allocate it. This
98a77df5 LP	121	functionality is useful to ensure that
a3f6aa26	122	regardless of how many VTs are allocated
409dee2e	123	by other subsystems, one login
98a77df5	124	<literal>getty</literal> is always
a3f6aa26 JSJ	125	available. Defaults to 6 (in other
a3f6aa26 JSJ	126	words, there will always be a
98a77df5 LP	127	<literal>getty</literal> available on
	128	Alt-F6.). When set to 0, VT
	129	reservation is
8fa365e5 LP	130	disabled.</para></listitem>
	131	</varlistentry>
	132
	133	<varlistentry>
	134	<term><varname>KillUserProcesses=</varname></term>
	135
	136	<listitem><para>Takes a boolean
	137	argument. Configures whether the
	138	processes of a user should be killed
	139	when she or he completely logs out (i.e. after
	140	her/his last session ended). Defaults to
405e0255 LP	141	<literal>no</literal>.</para>
	142
	143	<para>Note that setting
	144	<varname>KillUserProcesses=1</varname>
	145	will break tools like
	146	<citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
	147	</varlistentry>
	148
	149	<varlistentry>
	150	<term><varname>KillOnlyUsers=</varname></term>
	151	<term><varname>KillExcludeUsers=</varname></term>
	152
	153	<listitem><para>These settings take
	154	space-separated lists of usernames
	155	that influence the effect of
	156	<varname>KillUserProcesses=</varname>. If
	157	not empty, only processes of users
	158	listed in
	159	<varname>KillOnlyUsers=</varname> will
	160	be killed when they log out
	161	entirely. Processes of users listed in
	162	<varname>KillExcludeUsers=</varname>
	163	are excluded from being
	164	killed. <varname>KillExcludeUsers=</varname>
	165	defaults to <literal>root</literal>
	166	and takes precedence over
	167	<varname>KillOnlyUsers=</varname>,
	168	which defaults to the empty list.</para></listitem>
8fa365e5 LP	169	</varlistentry>
8fa365e5 LP	170
c29e0646 LP	171	<varlistentry>
	172	<term><varname>IdleAction=</varname></term>
	173
	174	<listitem><para>Configures the action
	175	to take when the system is idle. Takes
	176	one of <literal>ignore</literal>,
	177	<literal>poweroff</literal>,
	178	<literal>reboot</literal>,
	179	<literal>halt</literal>,
	180	<literal>kexec</literal>,
	181	<literal>suspend</literal>,
	182	<literal>hibernate</literal>,
	183	<literal>hybrid-sleep</literal>,
	184	<literal>lock</literal>. Defaults to
	185	<literal>ignore</literal>.</para>
	186
	187	<para>Note that this requires that
	188	user sessions correctly report the
	189	idle status to the system. The system
	190	will execute the action after all
a3f6aa26 JSJ	191	sessions report that they are idle,
	192	no idle inhibitor lock is active,
	193	and subsequently, the time configured
c29e0646	194	with <varname>IdleActionSec=</varname>
a3f6aa26	195	(see below) has expired.</para>
c29e0646 LP	196	</listitem>
	197	</varlistentry>
	198
	199	<varlistentry>
	200	<term><varname>IdleActionSec=</varname></term>
	201
	202	<listitem><para>Configures the delay
	203	after which the action configured in
	204	<varname>IdleAction=</varname> (see
	205	above) is taken after the system is
	206	idle.</para></listitem>
	207	</varlistentry>
	208
eecd1362 LP	209	<varlistentry>
	210	<term><varname>InhibitDelayMaxSec=</varname></term>
	211
	212	<listitem><para>Specifies the maximum
4943c1c9 LP	213	time a system shutdown or sleep
	214	request is delayed due to an inhibitor
	215	lock of type <literal>delay</literal>
a3f6aa26 JSJ	216	being active before the inhibitor is
a3f6aa26 JSJ	217	ignored and the operation executes
4943c1c9	218	anyway. Defaults to
eecd1362	219	5s.</para></listitem>
069cfc85	220	</varlistentry>
eecd1362	221
069cfc85 LP	222	<varlistentry>
069cfc85 LP	223	<term><varname>HandlePowerKey=</varname></term>
8e7fd6ad LP	224	<term><varname>HandleSuspendKey=</varname></term>
8e7fd6ad LP	225	<term><varname>HandleHibernateKey=</varname></term>
069cfc85 LP	226	<term><varname>HandleLidSwitch=</varname></term>
	227
	228	<listitem><para>Controls whether
	229	logind shall handle the system power
	230	and sleep keys and the lid switch to
beaafb2e LP	231	trigger actions such as system
	232	power-off or suspend. Can be one of
	233	<literal>ignore</literal>,
	234	<literal>poweroff</literal>,
	235	<literal>reboot</literal>,
	236	<literal>halt</literal>,
6524990f	237	<literal>kexec</literal>,
4e84ae7e	238	<literal>suspend</literal>,
7654b2c2 LP	239	<literal>hibernate</literal>,
	240	<literal>hybrid-sleep</literal> and
	241	<literal>lock</literal>. If
e9dd9f95	242	<literal>ignore</literal>, logind will
7654b2c2	243	never handle these keys. If
e9dd9f95 JSJ	244	<literal>lock</literal>, all running
	245	sessions will be screen-locked; otherwise,
	246	the specified action
7654b2c2 LP	247	will be taken in the respective
7654b2c2 LP	248	event. Only input devices with the
6de0e0e5	249	<literal>power-switch</literal> udev
beaafb2e	250	tag will be watched for key/lid switch
069cfc85	251	events. <varname>HandlePowerKey=</varname>
6de0e0e5	252	defaults to
beaafb2e	253	<literal>poweroff</literal>.
8e7fd6ad LP	254	<varname>HandleSuspendKey=</varname>
8e7fd6ad LP	255	and
069cfc85	256	<varname>HandleLidSwitch=</varname>
8e7fd6ad LP	257	default to <literal>suspend</literal>.
	258	<varname>HandleHibernateKey=</varname>
	259	defaults to
	260	<literal>hibernate</literal>.</para></listitem>
beaafb2e LP	261	</varlistentry>
	262
	263	<varlistentry>
	264	<term><varname>PowerKeyIgnoreInhibited=</varname></term>
8e7fd6ad LP	265	<term><varname>SuspendKeyIgnoreInhibited=</varname></term>
8e7fd6ad LP	266	<term><varname>HibernateKeyIgnoreInhibited=</varname></term>
beaafb2e LP	267	<term><varname>LidSwitchIgnoreInhibited=</varname></term>
	268
	269	<listitem><para>Controls whether
	270	actions triggered by the power and
	271	sleep keys and the lid switch are
	272	subject to inhibitor locks. These
	273	settings take boolean arguments. If
e9dd9f95	274	<literal>off</literal>, the inhibitor
beaafb2e LP	275	locks taken by applications in order
beaafb2e LP	276	to block the requested operation are
409dee2e	277	respected. If <literal>on</literal>,
beaafb2e LP	278	the requested operation is executed in
beaafb2e LP	279	any
8e7fd6ad LP	280	case. <varname>PowerKeyIgnoreInhibited=</varname>,
8e7fd6ad LP	281	<varname>SuspendKeyIgnoreInhibited=</varname>
beaafb2e	282	and
8e7fd6ad	283	<varname>HibernateKeyIgnoreInhibited=</varname>
a3f6aa26	284	default to <literal>off</literal>.
beaafb2e	285	<varname>LidSwitchIgnoreInhibited=</varname>
069cfc85	286	defaults to
beaafb2e LP	287	<literal>yes</literal>. This means
	288	that the lid switch does not respect
	289	suspend blockers by default, but the
	290	power and sleep keys do.
	291	</para></listitem>
eecd1362 LP	292	</varlistentry>
eecd1362 LP	293
8fa365e5 LP	294	</variablelist>
	295	</refsect1>
	296
	297	<refsect1>
	298	<title>See Also</title>
	299	<para>
	300	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
af3bccd6	301	<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
169c4f65	302	<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
5f9cfd4c	303	<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
8fa365e5 LP	304	</para>
	305	</refsect1>
	306
	307	</refentry>