X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;ds=sidebyside;f=man%2Flogind.conf.xml;h=4641bbb833cb2c82ee3e939e5252b38543c980c7;hb=e4dd0722cae89f144f3a4cf163e706e7dc071728;hp=1f7cfc9964b30e92b63b6de39954560bb5e28d15;hpb=b514d6c9dcc7c0d7353f975ecfb94f2197c73cf1;p=elogind.git
diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index 1f7cfc996..4641bbb83 100644
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -54,9 +54,7 @@
Description
These files configure various parameters of the elogind
- login manager,
- logind.service8.
-
+ login manager.
@@ -64,241 +62,282 @@
Options
- All options are configured in the
- [Login] section:
-
-
-
-
- NAutoVTs=
-
- Takes a positive 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 for the respective VT TTY
- name, for example, autovt@tty4.service.
- By default, autovt@.service is linked to
- getty@.service. In other words, login
- prompts are started dynamically as the user switches 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.
+ All login options are configured in the
+ [Login] section, system sleep options are
+ configured in the [Sleep] section.
+
+ [Login] section:
+
+
+
+ KillUserProcesses=
+
+ Takes a boolean argument. Configures whether
+ the processes of a user should be killed 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.
+
+
+
+ KillOnlyUsers=
+ KillExcludeUsers=
+
+ These settings take space-separated lists of
+ usernames that influence the effect of
+ KillUserProcesses=. If not empty, only
+ processes of users listed in KillOnlyUsers=
+ will be killed when they log out entirely. Processes of users
+ listed in KillExcludeUsers= are excluded
+ from being killed. KillExcludeUsers=
+ defaults to root and takes precedence over
+ KillOnlyUsers=, which defaults to the empty
+ list.
+
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+ HandlePowerKey=
+ HandleSuspendKey=
+ HandleHibernateKey=
+ HandleLidSwitch=
+ HandleLidSwitchDocked=
+
+ Controls how 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
+ ignore,
+ poweroff,
+ reboot,
+ halt,
+ kexec,
+ suspend,
+ hibernate,
+ hybrid-sleep, and
+ lock.
+ If ignore, logind 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.
+ HandleSuspendKey= and
+ HandleLidSwitch= default to
+ suspend.
+ HandleLidSwitchDocked= defaults to
+ ignore.
+ HandleHibernateKey= defaults to
+ hibernate. If the system is inserted in a
+ docking station, or if more than one display is connected, the
+ action specified by HandleLidSwitchDocked=
+ 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"). 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.
-
- 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 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.
-
-
-
- KillOnlyUsers=
- KillExcludeUsers=
-
- These settings take space-separated lists of
- usernames that influence the effect of
- KillUserProcesses=. If not empty, only
- processes of users listed in KillOnlyUsers=
- will be killed when they log out entirely. Processes of users
- listed in KillExcludeUsers= are excluded
- from being killed. KillExcludeUsers=
- defaults to root and takes precedence over
- KillOnlyUsers=, which defaults to the empty
- list.
-
-
-
- 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.
-
-
-
- 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.
-
-
-
- HandlePowerKey=
- HandleSuspendKey=
- HandleHibernateKey=
- HandleLidSwitch=
- HandleLidSwitchDocked=
-
- 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
- ignore,
- poweroff,
- reboot,
- halt,
- kexec,
- suspend,
- hibernate,
- hybrid-sleep, and
- lock.
- If ignore, logind 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.
- HandleSuspendKey= and
- HandleLidSwitch= default to
- suspend.
- HandleLidSwitchDocked= defaults to
- ignore.
- HandleHibernateKey= defaults to
- hibernate. If the system is inserted in a
- docking station, or if more than one display is connected, the
- action specified by HandleLidSwitchDocked=
- occurs; otherwise the HandleLidSwitch=
- action occurs.
-
-
-
- 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
- no, the inhibitor locks taken by
- applications in order to block the requested operation are
- respected. If yes, the requested operation
- is executed in any case.
- PowerKeyIgnoreInhibited=,
- SuspendKeyIgnoreInhibited= and
- HibernateKeyIgnoreInhibited= default to
- no.
- LidSwitchIgnoreInhibited= defaults to
- yes. This means that the lid switch does
- not respect suspend blockers by default, but the power and
- sleep keys do.
-
-
-
- HoldoffTimeoutSec=
-
- Specifies the timeout 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 elogind can ignore LID events
- 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 elogind to account for devices
- that have been plugged or unplugged while the system was off.
- Defaults to 30s.
-
-
-
- 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=
-
- 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 are
- excluded from the effect of this setting. Defaults to
- yes.
-
-
-
+
+ PowerKeyIgnoreInhibited=
+ SuspendKeyIgnoreInhibited=
+ HibernateKeyIgnoreInhibited=
+ LidSwitchIgnoreInhibited=
+
+ Controls whether actions that systemd-logind
+ takes when the power and sleep keys and the lid switch are triggered are subject
+ to high-level inhibitor locks ("shutdown", "sleep", "idle"). Low level inhibitor
+ locks ("handle-*-key"), are always honoured, irrespective of this setting.
+
+ These settings take boolean arguments. If no, the
+ inhibitor locks taken by applications are respected. If yes,
+ "shutdown", "sleep", and "idle" inhibitor locks are ignored.
+ PowerKeyIgnoreInhibited=,
+ SuspendKeyIgnoreInhibited=, and
+ HibernateKeyIgnoreInhibited= default to no.
+ LidSwitchIgnoreInhibited= defaults to yes.
+ This means that when systemd-logind 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.
+
+
+
+ HoldoffTimeoutSec=
+
+ Specifies the timeout 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 elogind can ignore LID events
+ 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 elogind to account for devices
+ that have been plugged or unplugged while the system was off.
+ Defaults to 30s.
+
+
+
+ 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=
+
+ 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.
+
+
+
+
+
+ [Sleep] section:
+
+ elogind supports three general
+ power-saving modes:
+
+
+
+ suspend
+
+ a low-power state
+ where execution of the OS is paused,
+ and complete power loss might result
+ in lost data, and which is fast to
+ enter and exit. This corresponds to
+ suspend, standby, or freeze states as
+ understood by the kernel.
+
+
+
+
+ hibernate
+
+ a low-power state
+ where execution of the OS is paused,
+ and complete power loss does not
+ result in lost data, and which might
+ be slow to enter and exit. This
+ corresponds to the hibernation as
+ understood by the kernel.
+
+
+
+
+ hybrid-sleep
+
+ a low-power state
+ where execution of the OS is paused,
+ which might be slow to enter, and on
+ complete power loss does not result in
+ lost data but might be slower to exit
+ in that case. This mode is called
+ suspend-to-both by the kernel.
+
+
+
+
+ SuspendMode=
+ HibernateMode=
+ HybridSleepMode=
+
+ The string to be written to
+ /sys/power/disk by elogind.
+ More than one value can be specified by separating
+ multiple values with whitespace. They will be tried
+ in turn, until one is written without error. If
+ neither succeeds, the operation will be aborted.
+
+
+
+
+ SuspendState=
+ HibernateState=
+ HybridSleepState=
+
+ The string to be written to
+ /sys/power/state by elogind.
+ More than one value can be specified by separating
+ multiple values with whitespace. They will be tried
+ in turn, until one is written without error. If
+ neither succeeds, the operation will be aborted.
+
+
+
+
+
See Also
- elogind1,
- logind.service8,
+ elogind8,
loginctl1,
- elogind-system.conf5