make-directive-index: link to systemd options

[elogind.git] / man / pam_systemd.xml

diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index d681276c401439bea724ef46613a1b4083cda2ee..600bfd71b4966c9940f535715a967fcf6adb594c 100644 (file)
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>pam_systemd</refname>
 
         <refnamediv>
                 <refname>pam_systemd</refname>

-                <refpurpose>Register user sessions in the systemd control group hierarchy</refpurpose>
+                <refpurpose>Register user sessions in the systemd login manager</refpurpose>

         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>


@@ -57,8 +57,9 @@
                 <title>Description</title>
 
                 <para><command>pam_systemd</command> registers user
                 <title>Description</title>
 
                 <para><command>pam_systemd</command> registers user

-                sessions in the systemd control group
-                hierarchy.</para>
+                sessions in the systemd login manager
+                <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                and hence the systemd control group hierarchy.</para>

 
                 <para>On login, this module ensures the following:</para>
 
 
                 <para>On login, this module ensures the following:</para>
 


@@ -98,7 +99,7 @@
                         control group are killed and the control group
                         is removed.</para></listitem>
 
                         control group are killed and the control group
                         is removed.</para></listitem>
 

-                        <listitem><para>If last subgroup of the
+                        <listitem><para>If the last subgroup of the

                         <filename>/user/$USER</filename> control group
                         was removed the
                         <varname>$XDG_RUNTIME_DIR</varname> directory
                         <filename>/user/$USER</filename> control group
                         was removed the
                         <varname>$XDG_RUNTIME_DIR</varname> directory


@@ -156,7 +157,7 @@
                                 listed in this argument will not be
                                 subject to the effect of
                                 <option>kill-session-processes=</option>.  Note
                                 listed in this argument will not be
                                 subject to the effect of
                                 <option>kill-session-processes=</option>.  Note

-                                that that this option takes precedence
+                                that this option takes precedence

                                 over
                                 <option>kill-only-users=</option>, and
                                 hence whatever is listed for
                                 over
                                 <option>kill-only-users=</option>, and
                                 hence whatever is listed for


@@ -192,6 +193,15 @@
                                 group.</para></listitem>
                         </varlistentry>
 
                                 group.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>class=</option></term>
+
+                                <listitem><para>Takes a string
+                                argument which sets the session class.
+                                The XDG_SESSION_CLASS environmental variable
+                                takes precedence.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>debug=</option></term>
 
                         <varlistentry>
                                 <term><option>debug=</option></term>
 


@@ -271,7 +281,7 @@
                                 in again, the directory contents will
                                 have been lost in between, but
                                 applications should not rely on this
                                 in again, the directory contents will
                                 have been lost in between, but
                                 applications should not rely on this

-                                behaviour and must be able to deal with
+                                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>
                                 stale files. To store session-private
                                 data in this directory the user should
                                 include the value of <varname>$XDG_SESSION_ID</varname>


@@ -304,12 +314,14 @@ session    required     pam_systemd.so kill-session-processes=1</programlisting>
         <refsect1>
                 <title>See Also</title>
                 <para>
         <refsect1>
                 <title>See Also</title>
                 <para>

+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <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.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><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>

                 </para>
         </refsect1>
 
                 </para>
         </refsect1>