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=66d40fca451d6088f92ebe9ae00df3292c81b69d;hb=dd5ae4c36c89da5dbe8d1628939b26c00db98753;hpb=a4cd87e9dce6d38846f23d44df9e21f322f946df

diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index 66d40fca4..3e106ea69 100644
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -72,11 +72,11 @@
                         <varname>$XDG_SESSION_ID</varname> environment
                         variable is initialized. If auditing is
                         available and
-                        <command>pam_loginuid.so</command> run before
+                        <command>pam_loginuid.so</command> was run before
                         this module (which is highly recommended), the
                         variable is initialized from the auditing
                         session id
-                        (<filename>/proc/self/sessionid</filename>). Otherwise
+                        (<filename>/proc/self/sessionid</filename>). Otherwise,
                         an independent session counter is
                         used.</para></listitem>
 
@@ -84,21 +84,23 @@
                         created for the session. If this is the first
                         concurrent session of the user, an implicit
                         slice below <filename>user.slice</filename> is
-                        automatically created and the scope placed in
-                        it. In instance of the system service
-                        <filename>user@.service</filename> which runs
-                        the systemd user manager
-                        instance.</para></listitem>
+                        automatically created and the scope placed into
+                        it. An instance of the system service
+                        <filename>user@.service</filename>, which runs
+                        the systemd user manager instance, is started.
+                        </para></listitem>
                 </orderedlist>
 
                 <para>On logout, this module ensures the following:</para>
 
                 <orderedlist>
-                        <listitem><para>If this is enabled, all
+                        <listitem><para>If enabled in
+                        <citerefentry><refentrytitle>logind.conf</refentrytitle>
+                        <manvolnum>5</manvolnum></citerefentry>, 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.</para></listitem>
 
                         <listitem><para>If the last concurrent session
@@ -145,8 +147,9 @@
                                 variable takes precedence. One of
                                 <literal>unspecified</literal>,
                                 <literal>tty</literal>,
-                                <literal>x11</literal> or
-                                <literal>wayland</literal>. See
+                                <literal>x11</literal>,
+                                <literal>wayland</literal> or
+                                <literal>mir</literal>. See
                                 <citerefentry><refentrytitle>sd_session_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                 for details about the session type.</para></listitem>
                         </varlistentry>
@@ -199,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
                                 <varname>$XDG_RUNTIME_DIR</varname>
                                 and the same contents. If a user logs
                                 in once, then logs out again, and logs
@@ -210,24 +213,28 @@
                                 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 <varname>$XDG_SESSION_ID</varname>
-                                in the filename. This directory shall
-                                be used for runtime file system
-                                objects such as <constant>AF_UNIX</constant> 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.</para></listitem>
+                                data in this directory, the user
+                                should include the value of
+                                <varname>$XDG_SESSION_ID</varname> in
+                                the filename. This directory shall be
+                                used for runtime file system objects
+                                such as <constant>AF_UNIX</constant>
+                                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 <ulink
+                                url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
+                                Base Directory
+                                Specification</ulink>.</para></listitem>
                         </varlistentry>
 
                 </variablelist>
 
                 <para>The following environment variables are read by
                 the module and may be used by the PAM service to pass
-                meta data to the module:</para>
+                metadata to the module:</para>
 
                 <variablelist class='environment-variables'>
                         <varlistentry>
@@ -253,15 +260,28 @@
                         <varlistentry>
                                 <term><varname>$XDG_SESSION_DESKTOP</varname></term>
 
-                                <listitem><para>The session
-                                deskop. This may be used to indicate
-                                the session desktop used, where this
-                                applies. This should be a short,
-                                lowercase string identifying the
-                                desktop environment used if this
+                                <listitem><para>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:
-                                <literal>gnome</literal>, or
-                                <literal>kde</literal>.</para></listitem>
+                                <literal>GNOME</literal>, or
+                                <literal>KDE</literal>. It is
+                                recommended to use the same
+                                identifiers and capitalization as for
+                                <varname>$XDG_CURRENT_DESKTOP</varname>,
+                                as defined by the <ulink
+                                url="http://standards.freedesktop.org/desktop-entry-spec/latest/">Desktop
+                                Entry Specification</ulink>. (However,
+                                note that
+                                <varname>$XDG_SESSION_DESKTOP</varname>
+                                only takes a single item, and not a
+                                colon-separated list like
+                                <varname>$XDG_CURRENT_DESKTOP</varname>.)
+                                See
+                                <citerefentry><refentrytitle>sd_session_get_desktop</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                for more details.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -305,10 +325,10 @@ session    required     pam_systemd.so</programlisting>
                         <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>