X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Flogind.conf.xml;h=4641bbb833cb2c82ee3e939e5252b38543c980c7;hp=beb52115bebb5b8126a2db3d1934f4c27984c073;hb=47f94046d2208b0ca48928df3ac3bce803361f23;hpb=08307930b297fd1c6335afc746e4404dece6ef21 diff --git a/man/logind.conf.xml b/man/logind.conf.xml index beb52115b..4641bbb83 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -1,243 +1,344 @@ - + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - - - logind.conf - systemd - - - - Developer - Lennart - Poettering - lennart@poettering.net - - - - - - logind.conf - 5 - - - - logind.conf - Login manager configuration file - - - - /etc/systemd/logind.conf - - - - Description - - This file configures various parameters of the systemd login manager systemd-logind.service8. - - - - - Options - - All options are configured in the - [Login] section: - - - - - 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 - autovt@.service - with the virtual terminal TTY name, - e.g. autovt@tty4.service. By - default - autovt@.service - is linked to - getty@.service, - 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 - autovt services 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. - - - - KillOnlyUsers= - KillExcludeUsers= - - These settings take - space separated lists of user names - 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. - - - - 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. - - - - InhibitDelayMaxSec= - - Specifies the maximum - 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 - anyway. Defaults to - 5s. - - - - HandlePowerKey= - HandleSleepKey= - 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 - 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 - power-switch udev - tag will be watched for key - events. HandlePowerKey= - defaults to - no-session. - HandleSleepKey= - defaults to - tty-session, - HandleLidSwitch= - defaults to - off. - - - - - 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. - - - - See Also - - systemd1, - systemd-logind.service8, - loginctl1, - systemd.conf5 - - + + + logind.conf + elogind + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + logind.conf + 5 + + + + logind.conf + Login manager configuration files + + + + /etc/elogind/logind.conf + + + + Description + + These files configure various parameters of the elogind + login manager. + + + + + + Options + + 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. + + + + 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 + + elogind8, + loginctl1, + +