diff options
Diffstat (limited to 'modules/pam_mkhomedir/mkhomedir_helper.8.xml')
-rw-r--r-- | modules/pam_mkhomedir/mkhomedir_helper.8.xml | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/modules/pam_mkhomedir/mkhomedir_helper.8.xml b/modules/pam_mkhomedir/mkhomedir_helper.8.xml new file mode 100644 index 0000000..c834edd --- /dev/null +++ b/modules/pam_mkhomedir/mkhomedir_helper.8.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding='UTF-8'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> + +<refentry id="mkhomedir_helper"> + + <refmeta> + <refentrytitle>mkhomedir_helper</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="mkhomedir_helper-name"> + <refname>mkhomedir_helper</refname> + <refpurpose>Helper binary that creates home directories</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="mkhomedir_helper-cmdsynopsis"> + <command>mkhomedir_helper</command> + <arg choice="req"> + <replaceable>user</replaceable> + </arg> + <arg choice="opt"> + <replaceable>umask</replaceable> + <arg choice="opt"> + <replaceable>path-to-skel</replaceable> + </arg> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id="mkhomedir_helper-description"> + + <title>DESCRIPTION</title> + + <para> + <emphasis>mkhomedir_helper</emphasis> is a helper program for the + <emphasis>pam_mkhomedir</emphasis> module that creates home directories + and populates them with contents of the specified skel directory. + </para> + + <para> + The default value of <replaceable>umask</replaceable> is 0022 and the + default value of <replaceable>path-to-skel</replaceable> is + <emphasis>/etc/skel</emphasis>. + </para> + + <para> + The helper is separated from the module to not require direct access from + login SELinux domains to the contents of user home directories. The + SELinux domain transition happens when the module is executing the + <emphasis>mkhomedir_helper</emphasis>. + </para> + + <para> + The helper never touches home directories if they already exist. + </para> + </refsect1> + + <refsect1 id='mkhomedir_helper-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_mkhomedir</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> + + <refsect1 id='mkhomedir_helper-author'> + <title>AUTHOR</title> + <para> + Written by Tomas Mraz based on the code originally in + <emphasis>pam_mkhomedir</emphasis> module. + </para> + </refsect1> + +</refentry> |