X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Flogind.conf.xml;h=8ba95230bee63a3af4dad1e168574dbd603424a2;hp=d223514e0edd535009ca08beb69c6e74c86da83b;hb=3c56cab44150ad47323970cfadfb0257c6305a74;hpb=56ba3c78ae35065064c4289a0c8e22a81256af20 diff --git a/man/logind.conf.xml b/man/logind.conf.xml index d223514e0..8ba95230b 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. @@ -72,58 +72,58 @@ Takes a positive integer. Configures how many virtual terminals (VTs) to allocate by default - that -- when switched to and - previously unused -- + 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, - e.g. autovt@tty4.service. By - default + 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. 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 + (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 - VTs configured with the + the VTs configured with the NAutoVTs= directive. Defaults to 6. When set to 0, automatic spawning of autovt services is - disabled. + disabled. ReserveVT= Takes a positive - integer. Configures the number of one + 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 + marked busy unconditionally, so that no other subsystem will allocate it. This - functionality is useful to ensure that - regardless how many VTs are allocated - by other subsystems one login + 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 (with other - words: there'll always be a + available. Defaults to 6 (in other + words, there will always be a getty available on Alt-F6.). When set to 0, VT reservation is @@ -136,9 +136,36 @@ 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. + + + + 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. @@ -153,7 +180,7 @@ kexec, suspend, hibernate, - hybrid-sleep, + hybrid-sleep, and lock. Defaults to ignore. @@ -161,11 +188,11 @@ user sessions correctly report the idle status to the system. The system will execute the action after all - sessions reported that they are idle, - and no idle inhibitor lock is active, - and subsquently the time configured + sessions report that they are idle, + no idle inhibitor lock is active, + and subsequently, the time configured with IdleActionSec= - (see below) has passed. + (see below) has expired. @@ -179,48 +206,6 @@ idle. - - 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= @@ -228,10 +213,10 @@ time a system shutdown or sleep request is delayed due to an inhibitor lock of type delay - being active -- before it is ignored - and the operation executed + being active before the inhibitor is + ignored and the operation executes anyway. Defaults to - 5s. + 5. @@ -239,6 +224,7 @@ HandleSuspendKey= HandleHibernateKey= HandleLidSwitch= + HandleLidSwitchDocked= Controls whether logind shall handle the system power @@ -252,15 +238,15 @@ kexec, suspend, hibernate, - hybrid-sleep and + hybrid-sleep, and lock. If - ignore logind will + 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 + 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= @@ -270,9 +256,18 @@ and HandleLidSwitch= default to suspend. + HandleLidSwitchDocked= + defaults to ignore. HandleHibernateKey= defaults to - hibernate. + 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. @@ -286,17 +281,17 @@ sleep keys and the lid switch are subject to inhibitor locks. These settings take boolean arguments. If - off the inhibitor + off, the inhibitor locks taken by applications in order to block the requested operation are - respected, if on + respected. If on, the requested operation is executed in any case. PowerKeyIgnoreInhibited=, SuspendKeyIgnoreInhibited= and HibernateKeyIgnoreInhibited= - defaults to off, + default to off. LidSwitchIgnoreInhibited= defaults to yes. This means @@ -306,21 +301,49 @@ - + + 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. + + - 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. + + 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 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. + + + @@ -329,7 +352,7 @@ systemd1, systemd-logind.service8, loginctl1, - systemd.conf5 + systemd-system.conf5