OPTIONS¶
All login options are configured in the "[Login]"
section, system sleep options are configured in the "[Sleep]"
section.
The file /etc/elogind/sleep.conf and the files in
/etc/elogind/sleep.conf.d/*.conf only have a "[Sleep]"
section.
KillUserProcesses=
Takes a boolean argument. Configures whether the
processes of a user should be killed when the user logs out. If true, the
processes listed in their session cgroup will be terminated. If false, the
session cgroup is ignored but see the options
KillOnlyUsers= and
KillExcludeUsers= below.
Note that setting KillUserProcesses=yes will break tools
like screen(1) and tmux(1), unless they are moved out of the
session scope.
KillOnlyUsers=, KillExcludeUsers=
These settings take space-separated lists of usernames
that override the KillUserProcesses= setting. A user name may be added
to KillExcludeUsers= to exclude the processes in the session scopes of
that user from being killed even if KillUserProcesses=yes is set. If
KillExcludeUsers= is not set, the "root" user is excluded by
default. KillExcludeUsers= may be set to an empty value to override
this default. If a user is not excluded, KillOnlyUsers= is checked
next. If this setting is specified, only the processes in the session scopes
of those users will be killed. Otherwise, users are subject to the
KillUserProcesses=yes setting.
IdleAction=
Configures the action to take when the system is idle.
Takes one of "ignore", "poweroff", "reboot",
"halt", "kexec", "suspend",
"hibernate", "hybrid-sleep",
"suspend-then-hibernate", and "lock". Defaults to
"ignore".
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 IdleActionSec= (see below) has
expired.
Added in version 198.
IdleActionSec=
Configures the delay after which the action configured in
IdleAction= (see above) is taken after the system is idle.
Added in version 198.
InhibitDelayMaxSec=
Specifies the maximum time a system shutdown or sleep
request is delayed due to an inhibitor lock of type "delay" being
active before the inhibitor is ignored and the operation executes anyway.
Defaults to 5.
UserStopDelaySec=, HandlePowerKey=,
HandlePowerKeyLongPress=, HandleRebootKey=,
HandleRebootKeyLongPress=, HandleSuspendKey=,
HandleSuspendKeyLongPress=, HandleHibernateKey=,
HandleHibernateKeyLongPress=, HandleLidSwitch=,
HandleLidSwitchExternalPower=, HandleLidSwitchDocked=
Specifies how long to keep the user record around for a
user after they logged out fully. If set to zero, the user is terminated
immediately when the last session of the user has ended. Defaults to 10s.
Controls how logind shall handle the system power, reboot and sleep keys and
the lid switch to trigger actions such as system power-off, reboot or suspend.
Can be one of "ignore", "poweroff", "reboot",
"halt", "kexec", "suspend",
"hibernate", "hybrid-sleep",
"suspend-then-hibernate", "lock", and
"factory-reset". If "ignore",
elogind will never
handle these keys. If "lock", all running sessions will be
screen-locked; otherwise, the specified action will be taken in the respective
event. Only input devices with the "power-switch" udev tag will be
watched for key/lid switch events.
HandlePowerKey= defaults to "poweroff",
HandleRebootKey= defaults to "reboot",
HandleSuspendKey= defaults to "suspend",
HandleHibernateKey= defaults to "hibernate",
HandlePowerKeyLongPress= defaults to "ignore",
HandleRebootKeyLongPress= defaults to "poweroff",
HandleSuspendKeyLongPress= defaults to "hibernate",
HandleHibernateKeyLongPress= defaults to "ignore".
HandleLidSwitch= defaults to "suspend".
HandleLidSwitchExternalPower= is completely ignored by default (for
backwards compatibility) — an explicit value must be set before it
will be used to determine behaviour. HandleLidSwitchDocked= defaults
to "ignore". If the system is inserted in a docking station, or if
more than one display is connected, the action specified by
HandleLidSwitchDocked= occurs; if the system is on external power the
action (if any) specified by HandleLidSwitchExternalPower= occurs;
otherwise the HandleLidSwitch= action occurs.
A different application may disable logind's handling of system
power and sleep keys and the lid switch by taking a low-level inhibitor lock
("handle-power-key", "handle-suspend-key",
"handle-hibernate-key", "handle-lid-switch",
"handle-reboot-key"). This is most commonly used by graphical
desktop environments to take over suspend and hibernation handling, and to
use their own configuration mechanisms. If a low-level inhibitor lock is
taken, logind will not take any action when that key or switch is triggered
and the Handle*= settings are irrelevant.
Added in version 184.
PowerKeyIgnoreInhibited=,
SuspendKeyIgnoreInhibited=, HibernateKeyIgnoreInhibited=,
LidSwitchIgnoreInhibited=, RebootKeyIgnoreInhibited=
Controls whether actions that
elogind takes when
the power, reboot and sleep keys and the lid switch are triggered are subject
to high-level inhibitor locks ("shutdown", "reboot",
"sleep", "idle"). Low level inhibitor locks
("handle-power-key", "handle-suspend-key",
"handle-hibernate-key", "handle-lid-switch",
"handle-reboot-key"), are always honored, irrespective of this
setting.
These settings take boolean arguments. If "no", the
inhibitor locks taken by applications are respected. If "yes",
"shutdown", "reboot" "sleep", and
"idle" inhibitor locks are ignored.
PowerKeyIgnoreInhibited=, SuspendKeyIgnoreInhibited=,
HibernateKeyIgnoreInhibited= and RebootKeyIgnoreInhibited=
default to "no". LidSwitchIgnoreInhibited= defaults to
"yes". This means that when elogind is handling events by
itself (no low level inhibitor locks are taken by another application), the
lid switch does not respect suspend blockers by default, but the power and
sleep keys do.
Added in version 190.
HoldoffTimeoutSec=
Specifies a period of time after system startup or system
resume in which elogind will hold off on reacting to lid events. This is
required for the system to properly detect any hotplugged devices so lid
events can be ignored if external monitors or docks are connected. If set to
0, elogind will always react immediately, possibly before the kernel fully
probed all hotplugged devices. This is safe, as long as you do not care for
devices that have been plugged or unplugged while the system was off. Defaults
to 30s.
Added in version 220.
RuntimeDirectorySize=
Sets the size limit on the
$XDG_RUNTIME_DIR
runtime directory for each user who logs in. Takes a size in bytes, optionally
suffixed with the usual K, G, M, and T suffixes, to the base 1024 (IEC).
Alternatively, a numerical percentage suffixed by "%" may be
specified, which sets the size limit relative to the amount of physical RAM.
Defaults to 10%. Note that this size is a safety limit only. As each runtime
directory is a tmpfs file system, it will only consume as much memory as is
needed.
Added in version 211.
RuntimeDirectoryInodesMax=
Sets the limit on number of inodes for the
$XDG_RUNTIME_DIR runtime directory for each user who logs in. Takes a
number, optionally suffixed with the usual K, G, M, and T suffixes, to the
base 1024 (IEC). Defaults to
RuntimeDirectorySize= divided by 4096.
Note that this size is a safety limit only. As each runtime directory is a
tmpfs file system, it will only consume as much memory as is needed.
Added in version 246.
InhibitorsMax=
Controls the maximum number of concurrent inhibitors to
permit. Defaults to 8192 (8K).
Added in version 230.
SessionsMax=
Controls the maximum number of concurrent user sessions
to manage. Defaults to 8192 (8K). Depending on how the pam_elogind.so module
is included in the PAM stack configuration, further login sessions will either
be refused, or permitted but not tracked by
elogind.
RemoveIPC=
Controls whether System V and POSIX IPC objects belonging
to the user shall be removed when the user fully logs out. Takes a boolean
argument. If enabled, the user may not consume IPC resources after the last of
the user's sessions terminated. This covers System V semaphores, shared memory
and message queues, as well as POSIX shared memory and message queues. Note
that IPC objects of the root user and other system users are excluded from the
effect of this setting. Defaults to "yes".
Added in version 212.
StopIdleSessionSec=
Specifies a timeout in seconds, or a time span value
after which elogind checks the idle state of all sessions. Every session that
is idle for longer then the timeout will be stopped. Defaults to
"infinity" (elogind is not checking the idle state of sessions). For
details about the syntax of time spans, see
elogind.time(7).
Added in version 252.