From: Lennart Poettering Date: Fri, 20 Jul 2018 09:53:34 +0000 (+0200) Subject: man: update pam_systemd to reflect recent changes X-Git-Tag: v240~895^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9667%2Fhead;p=thirdparty%2Fsystemd.git man: update pam_systemd to reflect recent changes 1. Document the new desktop= parameter 2. Clarify that we set XDG_SESSION_DESKTOP, XDG_SESSION_CLASS, XDG_SESSION_TYPE if we have the data, and don't just read it. --- diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index ae500809bc5..3ce3b282bd9 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -84,40 +84,43 @@ - Takes a string argument which sets the session - class. The XDG_SESSION_CLASS environmental variable takes - precedence. One of - user, - greeter, - lock-screen or - background. See - sd_session_get_class3 - for details about the session class. + Takes a string argument which sets the session class. The XDG_SESSION_CLASS + environment variable (see below) takes precedence. One of user, greeter, + lock-screen or background. See + sd_session_get_class3 for + details about the session class. - 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 a string argument which sets the session type. The XDG_SESSION_TYPE + environment variable (see below) takes precedence. One of unspecified, + tty, x11, wayland or mir. See + sd_session_get_type3 for + details about the session type. + + + + + + Takes a single, short identifier string for the desktop environment. The + XDG_SESSION_DESKTOP environment variable (see below) takes precedence. 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 the option only takes a single item, and not a colon-separated list + like $XDG_CURRENT_DESKTOP.) See + sd_session_get_desktop3 for + further details. - Takes an optional - boolean argument. If yes or without - the argument, the module will log - debugging information as it - operates. + Takes an optional boolean argument. If yes or without the argument, the module will log + debugging information as it operates. @@ -131,20 +134,20 @@ Environment - The following environment variables are set for the - processes of the user's session: + The following environment variables are initialized by the module and available to the processes of the + user's session: $XDG_SESSION_ID - A session identifier, suitable to be used in - filenames. The string itself should be considered opaque, - although often it is just the audit session ID as reported by - /proc/self/sessionid. Each ID will be - assigned only once during machine uptime. It may hence be used - to uniquely label files or other resources of this - session. + A short session identifier, suitable to be used in filenames. The string itself should be + considered opaque, although often it is just the audit session ID as reported by + /proc/self/sessionid. Each ID will be assigned only once during machine uptime. It may + hence be used to uniquely label files or other resources of this session. Combine this ID with the boot + identifier, as returned by + sd_id128_get_boot3, for a + globally unique identifier for the current session. @@ -174,45 +177,31 @@ - The following environment variables are read by the module - and may be used by the PAM service to pass metadata to the - module: + The following environment variables are read by the module and may be used by the PAM service to pass + metadata to the module. If these variables are not set when the PAM module is invoked but can be determined + otherwise they are set by the module, so that these variables are initialized for the session and applications if + known at all. $XDG_SESSION_TYPE - The session type. This may be used instead of - on the module parameter line, and is - usually preferred. + 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. + 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. + The desktop identifier. This may be used instead of on the module + parameter line, and is usually preferred.