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>
<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>
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>
<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>
<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
<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
<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>
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
<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
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
<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>
~ianmdlvl / elogind.git / blobdiff