Merge from vendor branch LIBSTDC++:
[dragonfly.git] / contrib / libpam / doc / modules / pam_mkhomedir.sgml
1 <!--
2
3 Ben Collins <bcollins@debian.org>
4
5 -->
6
7 <sect1>Create home directories on initial login
8
9 <sect2>Synopsis
10
11 <p>
12 <descrip>
13
14 <tag><bf>Module Name:</bf></tag>
15 <tt/pam_mkhomedir/
16
17 <tag><bf>Author:</bf></tag>
18 Jason Gunthorpe &lt;jgg@ualberta.ca&gt;
19
20 <tag><bf>Maintainer:</bf></tag>
21 Ben Collins &lt;bcollins@debian.org&gt;
22
23 <tag><bf>Management groups provided:</bf></tag>
24 Session
25
26 <tag><bf>Cryptographically sensitive:</bf></tag>
27         
28 <tag><bf>Security rating:</bf></tag>
29
30 <tag><bf>Clean code base:</bf></tag>
31
32 <tag><bf>System dependencies:</bf></tag>
33
34 <tag><bf>Network aware:</bf></tag>
35
36 </descrip>
37
38 <sect2>Overview of module
39
40 <p>
41 Creates home directories on the fly for authenticated users.
42
43 <sect2>Session component
44
45 <p>
46 <descrip>
47
48 <tag><bf>Recognized arguments:</bf></tag>
49 <tt/debug/; <tt/skel=skeleton-dir/; <tt/umask=octal-umask/;
50
51 <tag><bf>Description:</bf></tag>
52 This module is useful for distributed systems where the user account is
53 managed in a central database (such as NIS, NIS+, or LDAP) and accessed
54 through miltiple systems. It frees the administrator from having to create
55 a default home directory on each of the systems by creating it upon the
56 first succesfully authenticated login of that user. The skeleton directory
57 (usually /etc/skel/) is used to copy default files and also set's a umask
58 for the creation.
59
60 <p>
61 The behavior of this module can be modified with one of the following
62 flags:
63
64 <p>
65 <itemize>
66
67 <item><tt/skel/
68 - The skeleton directory for default files to copy to the new home directory.
69
70 <item><tt/umask/
71 - An octal for of the same format as you would pass to the shells umask command.
72
73 </itemize>
74
75 <tag><bf>Examples/suggested usage:</bf></tag>
76
77 session    required   pam_mkhomedir.so skel=/etc/skel/ umask=0022
78
79 </descrip>
80
81 <!--
82 End of sgml insert for this module.
83 -->