X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Flogind.conf.xml;h=f037da259b1ab30ab54c1a1665d4efdff7bcfe0e;hb=d275b5296958446957e98ce61213f98519e11808;hp=beb52115bebb5b8126a2db3d1934f4c27984c073;hpb=08307930b297fd1c6335afc746e4404dece6ef21;p=elogind.git
diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index beb52115b..f037da259 100644
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -22,7 +22,7 @@
along with systemd; If not, see .
-->
-
+
logind.conf
systemd
@@ -54,7 +54,7 @@
Description
- This file configures various parameters of the systemd login manager systemd-logind.service8.
+ This file configures various parameters of the systemd login manager, systemd-logind.service8.
@@ -70,39 +70,80 @@
NAutoVTs=
Takes a positive
- integer. How many virtual terminals to
- allocate by default and when switched
- to autospawn autovt
- services on (if they are otherwise
- unused). These services are
- instantiated from a template of
+ integer. Configures how many virtual
+ terminals (VTs) to allocate by default
+ that, when switched to and are
+ previously unused,
+ autovt services are
+ automatically spawned on. These
+ services are instantiated from the
+ template unit
autovt@.service
- with the virtual terminal TTY name,
- e.g. autovt@tty4.service. By
- default
+ for the respective VT TTY name,
+ for example, autovt@tty4.service. By
+ default,
autovt@.service
is linked to
- getty@.service,
- i.e. login prompts are started
+ getty@.service.
+ In other words, 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
+ unused virtual terminals. Hence, this
+ parameter controls how many login
+ gettys 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 ReserveVT= is
+ always subject to this kind of
+ activation, even if it is not one of
+ the VTs configured with the
+ NAutoVTs=
+ directive. Defaults to 6. When set to
0, automatic spawning of
autovt services is
disabled.
+
+ ReserveVT=
+
+ Takes a positive
+ integer. Identifies one
+ virtual terminal that shall
+ unconditionally be reserved for
+ autovt@.service
+ 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
+ getty is always
+ available. Defaults to 6 (in other
+ words, there will always be a
+ getty available on
+ Alt-F6.). When set to 0, VT
+ reservation is
+ disabled.
+
+
KillUserProcesses=
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
- no.
+ when the user completely logs out (i.e. after
+ the user's last session ended). Defaults to
+ no.
+
+ Note that setting
+ KillUserProcesses=1
+ will break tools like
+ screen1.
@@ -110,12 +151,12 @@
KillExcludeUsers=
These settings take
- space separated lists of user names
+ space-separated lists of usernames
that influence the effect of
KillUserProcesses=. If
- not empty only processes of users
+ not empty, only processes of users
listed in
- KillOnlyUsers will
+ KillOnlyUsers= will
be killed when they log out
entirely. Processes of users listed in
KillExcludeUsers=
@@ -123,28 +164,46 @@
killed. KillExcludeUsers=
defaults to root
and takes precedence over
- KillOnlyUsers=
+ KillOnlyUsers=,
which defaults to the empty list.
- Controllers=
- ResetControllers=
-
- These settings control
- the default control group hierarchies
- users logging in are added to. When
- logging in users will get private
- control groups in all hierarchies
- listed in
- Controllers= and be
- reset to the root control group in all
- hierarchies listed in
- ResetControllers=. Controllers=
- defaults to the empty list,
- ResetControllers=
- defaults to
- cpu.
+ IdleAction=
+
+ Configures the action
+ to take when the system is idle. Takes
+ one of ignore,
+ poweroff,
+ reboot,
+ halt,
+ kexec,
+ suspend,
+ hibernate,
+ hybrid-sleep, 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.
+
+
+
+
+ IdleActionSec=
+
+ Configures the delay
+ after which the action configured in
+ IdleAction= (see
+ above) is taken after the system is
+ idle.
@@ -154,80 +213,131 @@
time a system shutdown or sleep
request is delayed due to an inhibitor
lock of type delay
- being taken before it is ignored and
- the operation executed
+ being active before the inhibitor is
+ ignored and the operation executes
anyway. Defaults to
- 5s.
+ 5.
HandlePowerKey=
- HandleSleepKey=
+ HandleSuspendKey=
+ HandleHibernateKey=
HandleLidSwitch=
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
- off,
- no-session,
- tty-session,
- any-session and
- always. If
- off logind will
+ trigger actions such as system
+ power-off or suspend. Can be one of
+ ignore,
+ poweroff,
+ reboot,
+ halt,
+ kexec,
+ suspend,
+ hibernate,
+ hybrid-sleep, and
+ lock. If
+ ignore, logind will
never handle these keys. If
- no-session logind
- will handle these keys when no user is
- logged in and no inhibitor lock is
- taken, and trigger a warning beep
- otherwise. If set to
- tty-session 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
- any-session 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
- always logind will
- 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
+ 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
+ tag will be watched for key/lid switch
events. HandlePowerKey=
defaults to
- no-session.
- HandleSleepKey=
- defaults to
- tty-session,
+ poweroff.
+ HandleSuspendKey=
+ and
HandleLidSwitch=
+ default to suspend.
+ HandleHibernateKey=
defaults to
- off.
+ hibernate. Note
+ that the lid switch is ignored if the
+ system is inserted in a docking
+ station, or if more than one display
+ is connected.
-
+
+ PowerKeyIgnoreInhibited=
+ SuspendKeyIgnoreInhibited=
+ HibernateKeyIgnoreInhibited=
+ LidSwitchIgnoreInhibited=
+
+ 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
+ off, the inhibitor
+ locks taken by applications in order
+ to block the requested operation are
+ respected. If on,
+ the requested operation is executed in
+ any
+ case. PowerKeyIgnoreInhibited=,
+ SuspendKeyIgnoreInhibited=
+ and
+ HibernateKeyIgnoreInhibited=
+ default to off.
+ LidSwitchIgnoreInhibited=
+ defaults to
+ yes. This means
+ that the lid switch does not respect
+ suspend blockers by default, but the
+ power and sleep keys do.
+
+
+
+
+ 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.
+
+
+
+
+ RemoveIPC=
- Note that setting
- KillUserProcesses=1 will break tools
- like
- screen1.
-
- Note that KillUserProcesses=1
- is a weaker version of
- kill-session-processes=1 which may
- be configured per-service for
- pam_systemd8. 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.
+ 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 his 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 are excluded
+ from the effect of this
+ setting. Defaults to
+ yes.
+
+
+
@@ -236,7 +346,7 @@
systemd1,
systemd-logind.service8,
loginctl1,
- systemd.conf5
+ systemd-system.conf5