core: if we cannot JOB_ISOLATE the default target JOB_REPLACE it instead

[elogind.git] / man / pam_systemd.xml

diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index 883b50b640a859470e6626428a0fdb618d9d4f68..2dc6651885728e20ec91d1fb0bc34ff59e78d10b 100644 (file)
--- 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
   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
   (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/>.
 -->
 
   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>
 
         <refentryinfo>
                 <title>pam_systemd</title>


@@ -44,21 +44,20 @@
 
         <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>

-                <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
         </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>
 
 
                 <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>
 
                         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


@@ -117,7 +116,7 @@
 
                 <para>The following options are understood:</para>
 
 
                 <para>The following options are understood:</para>
 

-                <variablelist>
+                <variablelist class='pam-directives'>

                         <varlistentry>
                                 <term><option>kill-session-processes=</option></term>
 
                         <varlistentry>
                                 <term><option>kill-session-processes=</option></term>
 


@@ -156,7 +155,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 +191,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>
 


@@ -212,7 +220,7 @@
                 stricter version of
                 <varname>KillUserProcesses=1</varname> which may be
                 configured system-wide in
                 stricter version of
                 <varname>KillUserProcesses=1</varname> which may be
                 configured system-wide in

-                <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
+                <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
                 session of the user ends.</para>
                 former kills processes of a session as soon as it
                 ends, the latter kills processes as soon as the last
                 session of the user ends.</para>


@@ -237,7 +245,7 @@
 
                 <para>The following environment variables are set for the processes of the user's session:</para>
 
 
                 <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>
 
                         <varlistentry>
                                 <term><varname>$XDG_SESSION_ID</varname></term>
 


@@ -271,7 +279,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 +312,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>systemd-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>