X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fpam_systemd.xml;h=52dfe9df43e7a561ebf8cacc9c0c437357ad2ff4;hp=1d924bc319b382398d3d9a993c986730086a129c;hb=080edb3484dc3ecf8d914526fdd3090b40fdf5b6;hpb=3e2f69b779aa0f3466ebb45837e8507baa0832f7 diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 1d924bc31..52dfe9df4 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. @@ -82,11 +82,11 @@ 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 + user@.service which runs the systemd user manager instance. @@ -94,15 +94,15 @@ On logout, this module ensures the following: - If this is enabled all + If this is enabled, all processes of the session are terminated. If - the last concurrent session of a user ends his + the last concurrent session of a user ends, his user 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 +127,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. @@ -200,6 +223,72 @@ operating system provides. + + + + 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. + + + + $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 +312,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