X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fpam_systemd.xml;h=4e5cdf248b2e0823c0d6c128e79e4e558cf78541;hp=c07b46bab24a386a31ba36899bf15b2ddb6c89e8;hb=1fda0ab5fc9cf7454c8da32941e433dc38ba9991;hpb=18b754d345ecb0b15e369978aaffa72e9814b86a

diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index c07b46bab..4e5cdf248 100644
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -8,20 +8,20 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="pam_systemd">
+<refentry id="pam_systemd" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>pam_systemd</title>
@@ -44,21 +44,20 @@
 
         <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
@@ -117,7 +116,7 @@
 
                 <para>The following options are understood:</para>
 
-                <variablelist>
+                <variablelist class='pam-directives'>
                         <varlistentry>
                                 <term><option>kill-session-processes=</option></term>
 
@@ -132,13 +131,13 @@
                         <varlistentry>
                                 <term><option>kill-only-users=</option></term>
 
-                                <listitem><para>Takes a comma
-                                separated list of user names or
-                                numeric user ids as argument. If this
-                                option is used the effect of the
+                                <listitem><para>Takes a comma-separated
+                                list of usernames or
+                                numeric user IDs as argument. If this
+                                option is used, the effect of the
                                 <option>kill-session-processes=</option> options
                                 will apply only to the listed
-                                users. If this option is not used the
+                                users. If this option is not used, the
                                 option applies to all local
                                 users. Note that
                                 <option>kill-exclude-users=</option>
@@ -150,13 +149,13 @@
                         <varlistentry>
                                 <term><option>kill-exclude-users=</option></term>
 
-                                <listitem><para>Takes a comma
-                                separated list of user names or
-                                numeric user ids as argument. Users
+                                <listitem><para>Takes a comma-separated
+                                list of usernames or
+                                numeric user IDs as argument. Users
                                 listed in this argument will not be
                                 subject to the effect of
-                                <option>kill-session-processes=</option>.  Note
-                                that that this option takes precedence
+                                <option>kill-session-processes=</option>.
+                                Note that this option takes precedence
                                 over
                                 <option>kill-only-users=</option>, and
                                 hence whatever is listed for
@@ -170,8 +169,8 @@
                         <varlistentry>
                                 <term><option>controllers=</option></term>
 
-                                <listitem><para>Takes a comma
-                                separated list of control group
+                                <listitem><para>Takes a comma-separated
+                                list of control group
                                 controllers in which hierarchies a
                                 user/session control group will be
                                 created by default for each user
@@ -184,14 +183,23 @@
                         <varlistentry>
                                 <term><option>reset-controllers=</option></term>
 
-                                <listitem><para>Takes a comma
-                                separated list of control group
+                                <listitem><para>Takes a comma-separated
+                                list of control group
                                 controllers in which hierarchies the
                                 logged in processes will be reset to
                                 the root control
                                 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>
 
@@ -214,7 +222,7 @@
                 configured system-wide in
                 <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
                 former kills processes of a session as soon as it
-                ends, the latter kills processes as soon as the last
+                ends; the latter kills processes as soon as the last
                 session of the user ends.</para>
 
                 <para>If the options are omitted they default to
@@ -237,12 +245,12 @@
 
                 <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>
 
                                 <listitem><para>A session identifier,
-                                suitable to be used in file names. The
+                                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
@@ -271,13 +279,13 @@
                                 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
+                                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 AF_UNIX sockets,
+                                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
@@ -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>