summaryrefslogtreecommitdiff
path: root/modules/pam_mkhomedir/mkhomedir_helper.8.xml
blob: c834edddb6330ae2d8e7e080e81c4a56ce672ef5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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>