1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-03 01:17:45 +03:00

man: lift pam_systemd_homed description to Summary

Also change the title to describe the module more comprehensively.
Follow-up for 90bc309aa2. Suggested
in https://bugzilla.redhat.com/show_bug.cgi?id=2085485#c5.

(cherry picked from commit 9e6df03412)
(cherry picked from commit a4af8592c6)
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2022-07-13 10:19:19 +02:00
parent bbcc9f2e5b
commit ca6ee4241a

View File

@ -17,8 +17,8 @@
<refnamediv> <refnamediv>
<refname>pam_systemd_home</refname> <refname>pam_systemd_home</refname>
<refpurpose>Automatically mount home directories managed by <filename>systemd-homed.service</filename> on <refpurpose>Authenticate users and mount home directories via <filename>systemd-homed.service</filename>
login, and unmount them on logout</refpurpose> </refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
@ -31,7 +31,11 @@
<para><command>pam_systemd_home</command> ensures that home directories managed by <para><command>pam_systemd_home</command> ensures that home directories managed by
<citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
are automatically activated (mounted) on user login, and are deactivated (unmounted) when the last are automatically activated (mounted) on user login, and are deactivated (unmounted) when the last
session of the user ends.</para> session of the user ends. For such users, it also provides authentication (when per-user disk encryption
is used, the disk encryption key is derived from the authentication credential supplied at login time),
account management (the <ulink url="https://systemd.io/USER_RECORD/">JSON user record</ulink> embedded in
the home store contains account details), and implements the updating of the encryption password (which
is also used for user authentication).</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -93,13 +97,13 @@
<refsect1> <refsect1>
<title>Module Types Provided</title> <title>Module Types Provided</title>
<para>The module implements all four PAM operations: <option>auth</option> (reason: when per-user <para>The module implements all four PAM operations: <option>auth</option> (reason: to allow
disk encryption is used, the disk encryption key is derived from the authentication credential supplied authentication using the encrypted data), <option>account</option> (reason: users with
at login time), <option>account</option> (reason: <filename>systemd-homed.service</filename> account <filename>systemd-homed.service</filename> user accounts are described in a <ulink
validity may be configured in more detail than in the traditional Linux user database, and thus needs to url="https://systemd.io/USER_RECORD/">JSON user record</ulink> and may be configured in more detail than
be verified separately), <option>session</option> (user sessions must be tracked, in order to implement in the traditional Linux user database), <option>session</option> (user sessions must be tracked in order
automatic release when the last session of a managed user is gone), <option>password</option> (user to implement automatic release when the last session of the user is gone), <option>password</option> (to
passwords may be changed through PAM).</para> change the encryption password — also used for user authentication — through PAM).</para>
</refsect1> </refsect1>
<refsect1> <refsect1>