X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Flogind.conf.xml;h=8ab6d729a98cb157f561ba41967d3fbf7c62a595;hp=33ddf621e057deaa0bf64403d97951e8e7ae3ea0;hb=431c72dc3d482732a01d3ab929aa9b2c36422d46;hpb=01cf0ca850dd1c21e1c405a4493fe61d0c28d721 diff --git a/man/logind.conf.xml b/man/logind.conf.xml index 33ddf621e..8ab6d729a 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 files 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,30 +70,66 @@ 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, + for the respective VT TTY name, e.g. autovt@tty4.service. By - default + 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 + 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 + 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. Configures the number of 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= @@ -105,15 +141,53 @@ no. + + IdleAction= + + Configures the action + to take when the system is idle. Takes + one of ignore, + poweroff, + reboot, + halt, + kexec, + suspend, + hibernate, + hybrid-sleep, + 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. + + KillOnlyUsers= 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 be killed when they log out @@ -123,7 +197,7 @@ killed. KillExcludeUsers= defaults to root and takes precedence over - KillOnlyUsers= + KillOnlyUsers=, which defaults to the empty list. @@ -133,18 +207,34 @@ These settings control the default control group hierarchies - users logging are added to. When - logging in users will get private - control groups in all hierarchies - listed in + users logging in are added to, in + addition to the + name=systemd named + hierarchy. These settings take + space-separated lists of controller + names. Pass the empty string to ensure + that logind does not touch any + hierarchies but systemd's own. When + logging in, user sessions 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=. + Controllers= + defaults to the empty list. ResetControllers= defaults to - cpu. + cpu. Note that for + all controllers that are not listed in + either Controllers= + or + ResetControllers=, + newly created sessions will be part of + the control groups of the system + service that created the + session. @@ -154,63 +244,82 @@ 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. 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 warnig 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 + hibernate. + + + + 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 - off. + yes. This means + that the lid switch does not respect + suspend blockers by default, but the + power and sleep keys do. + @@ -222,7 +331,7 @@ Note that KillUserProcesses=1 is a weaker version of - kill-session-processes=1 which may + kill-session-processes=1, which may be configured per-service for pam_systemd8. The latter kills processes of a session as soon as it @@ -236,7 +345,7 @@ systemd1, systemd-logind.service8, loginctl1, - systemd.conf5 + systemd-system.conf5