X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fpam_systemd.xml;h=3e106ea69b8dff7a577fcf96408de516cc875e02;hp=1d924bc319b382398d3d9a993c986730086a129c;hb=dd5ae4c36c89da5dbe8d1628939b26c00db98753;hpb=3e2f69b779aa0f3466ebb45837e8507baa0832f7 diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 1d924bc31..3e106ea69 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -55,7 +55,7 @@ Description pam_systemd registers user - sessions in the systemd login manager + sessions with the systemd login manager systemd-logind.service8, and hence the systemd control group hierarchy. @@ -72,37 +72,39 @@ $XDG_SESSION_ID environment variable is initialized. If auditing is available and - pam_loginuid.so run before + pam_loginuid.so was run before this module (which is highly recommended), the variable is initialized from the auditing session id - (/proc/self/sessionid). Otherwise + (/proc/self/sessionid). Otherwise, an independent session counter is used. A new systemd scope unit is created for the session. If this is the first - concurrent session of the user an implicit + concurrent session of the user, an implicit slice below user.slice is - automatically created and the scope placed in - it. In instance of the system service - user@.service which runt - the systemd user manager - instance. + automatically created and the scope placed into + it. An instance of the system service + user@.service, which runs + the systemd user manager instance, is started. + On logout, this module ensures the following: - If this is enabled all + If enabled in + logind.conf + 5, all processes of the session are terminated. If - the last concurrent session of a user ends his - user systemd instance will be terminated too, - and so will the user's slice + the last concurrent session of a user ends, + the user's systemd instance will be + terminated too, and so will the user's slice unit. - If the las concurrent session - of a user ends the + If the last concurrent session + of a user ends, the $XDG_RUNTIME_DIR directory and all its contents are removed, too. @@ -127,14 +129,37 @@ Takes a string argument which sets the session class. The XDG_SESSION_CLASS environmental variable - takes precedence. + takes precedence. One of + user, + greeter, + lock-screen or + background. See + sd_session_get_class3 + for details about the session class. - + - Takes a boolean - argument. If yes, the module will log + Takes a string + argument which sets the session type. + The XDG_SESSION_TYPE environmental + variable takes precedence. One of + unspecified, + tty, + x11, + wayland or + mir. See + sd_session_get_type3 + for details about the session type. + + + + + + Takes an optional + boolean argument. If yes or without + the argument, the module will log debugging information as it operates. @@ -177,9 +202,9 @@ to the user login time on the machine. It is automatically created the first time a user logs in and - removed on his final logout. If a user - logs in twice at the same time, both - sessions will see the same + removed on the user's final logout. If + a user logs in twice at the same time, + both sessions will see the same $XDG_RUNTIME_DIR and the same contents. If a user logs in once, then logs out again, and logs @@ -188,18 +213,95 @@ applications should not rely on this behavior and must be able to deal with stale files. To store session-private - data in this directory, the user should - include the value of $XDG_SESSION_ID - in the filename. This directory shall - be used for runtime file system - objects such as AF_UNIX sockets, - FIFOs, PID files and similar. It is - guaranteed that this directory is - local and offers the greatest possible - file system feature set the - operating system - provides. + data in this directory, the user + should include the value of + $XDG_SESSION_ID in + the filename. This directory shall be + used for runtime file system objects + such as AF_UNIX + sockets, FIFOs, PID files and + similar. It is guaranteed that this + directory is local and offers the + greatest possible file system feature + set the operating system provides. For + further details see the XDG + Base Directory + Specification. + + + + The following environment variables are read by + the module and may be used by the PAM service to pass + metadata to the module: + + + + $XDG_SESSION_TYPE + + The session type. This + may be used instead of + on the + module parameter line, and is usually + preferred. + + + + $XDG_SESSION_CLASS + + The session class. This + may be used instead of + on the + module parameter line, and is usually + preferred. + + + + $XDG_SESSION_DESKTOP + + A single, short + identifier string for the desktop + environment. This may be used to + indicate the session desktop used, + where this applies and if this + information is available. For example: + GNOME, or + KDE. It is + recommended to use the same + identifiers and capitalization as for + $XDG_CURRENT_DESKTOP, + as defined by the Desktop + Entry Specification. (However, + note that + $XDG_SESSION_DESKTOP + only takes a single item, and not a + colon-separated list like + $XDG_CURRENT_DESKTOP.) + See + sd_session_get_desktop3 + for more details. + + + + $XDG_SEAT + + The seat name the session + shall be registered for, if + any. + + + + $XDG_VTNR + + The VT number the + session shall be registered for, if + any. (Only applies to seats with a VT + available, such as + seat0) + + @@ -223,10 +325,10 @@ session required pam_systemd.so systemd-logind.service8, logind.conf5, loginctl1, - pam.conf5, - pam.d5, - pam8, - pam_loginuid8, + pam.conf5, + pam.d5, + pam8, + pam_loginuid8, systemd.scope5, systemd.slice5, systemd.service5