From: Clayton Craft Date: Sun, 24 May 2026 02:53:56 +0000 (-0700) Subject: pam_systemd: document inhibit= and inhibit-why= options X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=87fa1c28a5f084b5837e58baf5d6a7482c02f382;p=thirdparty%2Fsystemd.git pam_systemd: document inhibit= and inhibit-why= options --- diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 5482ced0677..bb464556954 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -238,6 +238,33 @@ + + inhibit= + + Takes a colon-separated list of inhibitor lock types to acquire for the duration of + the session. The XDG_SESSION_INHIBIT environment variable (see below) takes + precedence. Inhibitor locks prevent the system from performing certain actions, such as sleeping. + The supported lock types are the same as for the + systemd-inhibit1 + command, e.g. shutdown, sleep, idle. + If not set, no inhibitor lock is acquired. The lock is taken in block mode, the requested + actions are fully inhibited as long as the session is active. + + + + + + inhibit-why= + + Takes a short human-readable string describing the reason for the inhibitor lock + acquired via inhibit=. The XDG_SESSION_INHIBIT_WHY + environment variable (see below) takes precedence. Defaults to Active PAM session + if not set. Only has an effect if inhibit= or + XDG_SESSION_INHIBIT is set. + + + + default-capability-bounding-set= default-capability-ambient-set= @@ -414,6 +441,25 @@ + + + $XDG_SESSION_INHIBIT + + The inhibitor lock types to acquire for the duration of the session, as a + colon-separated list. This may be used instead of inhibit= on the module + parameter line. + + + + + + $XDG_SESSION_INHIBIT_WHY + + The reason string for the inhibitor lock. This may be used instead of + inhibit-why= on the module parameter line. + + + If not set, pam_systemd will initialize @@ -528,6 +574,7 @@ session required pam_unix.so logind.conf5 loginctl1 pam_systemd_home8 + systemd-inhibit1 pam.conf5 pam.d5 pam8