picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Systemd/man/logind.conf.xml

244 lines
12 KiB
XML
Raw Normal View History

logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
<?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
relicense to LGPLv2.1 (with exceptions) We finally got the OK from all contributors with non-trivial commits to relicense systemd from GPL2+ to LGPL2.1+. Some udev bits continue to be GPL2+ for now, but we are looking into relicensing them too, to allow free copy/paste of all code within systemd. The bits that used to be MIT continue to be MIT. The big benefit of the relicensing is that closed source code may now link against libsystemd-login.so and friends.
2012-04-12 00:20:58 +02:00
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
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
(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
relicense to LGPLv2.1 (with exceptions) We finally got the OK from all contributors with non-trivial commits to relicense systemd from GPL2+ to LGPL2.1+. Some udev bits continue to be GPL2+ for now, but we are looking into relicensing them too, to allow free copy/paste of all code within systemd. The bits that used to be MIT continue to be MIT. The big benefit of the relicensing is that closed source code may now link against libsystemd-login.so and friends.
2012-04-12 00:20:58 +02:00
Lesser General Public License for more details.
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
relicense to LGPLv2.1 (with exceptions) We finally got the OK from all contributors with non-trivial commits to relicense systemd from GPL2+ to LGPL2.1+. Some udev bits continue to be GPL2+ for now, but we are looking into relicensing them too, to allow free copy/paste of all code within systemd. The bits that used to be MIT continue to be MIT. The big benefit of the relicensing is that closed source code may now link against libsystemd-login.so and friends.
2012-04-12 00:20:58 +02:00
You should have received a copy of the GNU Lesser General Public License
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
rename /etc/systemd/systemd-{login,journal}d.conf to {login,journal}d.conf
2012-03-30 23:18:33 +02:00
<refentry id="logind.conf">
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
<refentryinfo>
rename /etc/systemd/systemd-{login,journal}d.conf to {login,journal}d.conf
2012-03-30 23:18:33 +02:00
<title>logind.conf</title>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Lennart</firstname>
<surname>Poettering</surname>
<email>lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
rename /etc/systemd/systemd-{login,journal}d.conf to {login,journal}d.conf
2012-03-30 23:18:33 +02:00
<refentrytitle>logind.conf</refentrytitle>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
rename /etc/systemd/systemd-{login,journal}d.conf to {login,journal}d.conf
2012-03-30 23:18:33 +02:00
<refname>logind.conf</refname>
man: document systemd-journald.conf(5)
2012-03-15 23:25:14 +01:00
<refpurpose>Login manager configuration file</refpurpose>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
</refnamediv>
<refsynopsisdiv>
man: document systemd-journal
2012-06-01 01:05:38 +02:00
<para><filename>/etc/systemd/logind.conf</filename></para>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: write man page for systemd-logind
2012-06-01 00:14:07 +02:00
<para>This files configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
</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>
logind: implement delay inhibitor locks in addition to block inhibitor locks This is useful to allow applications to synchronously save data before the system is suspended or shut down.
2012-05-05 00:34:48 +02:00
<varlistentry>
<term><varname>InhibitDelayMaxSec=</varname></term>
<listitem><para>Specifies the maximum
logind: use "sleep" as generic term for "suspend", "hibernate", and later on "hybrid suspend"
2012-05-05 00:46:31 +02:00
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
logind: implement delay inhibitor locks in addition to block inhibitor locks This is useful to allow applications to synchronously save data before the system is suspended or shut down.
2012-05-05 00:34:48 +02:00
5s.</para></listitem>
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
</varlistentry>
logind: implement delay inhibitor locks in addition to block inhibitor locks This is useful to allow applications to synchronously save data before the system is suspended or shut down.
2012-05-05 00:34:48 +02:00
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
<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
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
<literal>off</literal>,
<literal>no-session</literal>,
<literal>tty-session</literal>,
<literal>any-session</literal> and
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
<literal>always</literal>. If
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
<literal>off</literal> logind will
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
never handle these keys. If
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
<literal>no-session</literal> logind
will handle these keys when no user is
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
logged in and no inhibitor lock is
taken, and trigger a warnig beep
otherwise. If set to
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
<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
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
<literal>always</literal> logind will
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
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
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
events. <varname>HandlePowerKey=</varname>
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
defaults to
<literal>no-session</literal>.
<varname>HandleSleepKey=</varname>
defaults to
<literal>tty-session</literal>,
logind: optionally handle power, sleep and lid switch events This takes handling of chassis power and sleep keys as well as the lid switch over from acpid. This logic is enabled by default for power and sleep keys, but not for the lid switch. If a graphical session is in the foreground no action is taken under the assumption that the graphical session does this.
2012-05-30 15:01:51 +02:00
<varname>HandleLidSwitch=</varname>
defaults to
logind: rework button setting semantics If a graphical session without full DE that handles power/suspend events is used this can now be controlled by logind instead, optionally.
2012-05-30 21:40:32 +02:00
<literal>off</literal>.</para></listitem>
logind: implement delay inhibitor locks in addition to block inhibitor locks This is useful to allow applications to synchronously save data before the system is suspended or shut down.
2012-05-05 00:34:48 +02:00
</varlistentry>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
</variablelist>
man: update pam_systemd page to document new behaviour
2011-06-29 02:46:20 +02:00
<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>
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: write man page for systemd-logind
2012-06-01 00:14:07 +02:00
<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
journalctl,loginctl: drop systemd- prefix in binary names Let's make things a bit easier to type, drop the systemd- prefix for journalctl and loginctl, but provide the old names for compat. All systemd binaries are hence now prefixed with "systemd-" with the exception of the three primary user interface binaries: systemctl loginctl journalctl For those three we do provide systemd-xyz names as well, via symlinks: systemd-systemctl → systemctl systemd-loginctl → loginctl systemd-journalctl → journalctl We do this only for the *primary* user tools, in order to avoid unnecessary namespace problems. That means tools like systemd-notify stay the way they are.
2012-03-26 20:58:47 +02:00
<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
logind: add man page for configuration file
2011-06-29 02:27:53 +02:00
<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
Reference in a new issue Copy permalink