chiark / gitweb /
udev: usb_id: parse only 'size' bytes of the 'descriptors' buffer
[elogind.git] / man / pam_systemd.xml
index d681276c401439bea724ef46613a1b4083cda2ee..d74a91878c6945b9a3413eca05fb36dbd97fe044 100644 (file)
 
         <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>
-                <cmdsynopsis>
-                        <command>pam_systemd.so</command>
-                </cmdsynopsis>
+                <para><filename>pam_systemd.so</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <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>
 
@@ -98,7 +97,7 @@
                         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
 
                 <para>The following options are understood:</para>
 
-                <variablelist>
+                <variablelist class='pam-directives'>
                         <varlistentry>
                                 <term><option>kill-session-processes=</option></term>
 
                                 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
                                 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>
 
 
                 <para>The following environment variables are set for the processes of the user's session:</para>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$XDG_SESSION_ID</varname></term>
 
                                 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>
@@ -304,12 +312,14 @@ session    required     pam_systemd.so kill-session-processes=1</programlisting>
         <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_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>