Debian Codegraph @

upstream/debian-unstable/man8/mkhomedir_helper.8

raw
1 '\" t
2 .\" Title: mkhomedir_helper
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "MKHOMEDIR_HELPER" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 mkhomedir_helper \- Helper binary that creates home directories
32 .SH "SYNOPSIS"
33 .HP \w'\fBmkhomedir_helper\fR\ 'u
34 \fBmkhomedir_helper\fR {\fIuser\fR} [\fIumask\fR\ [\ \fIpath\-to\-skel\fR\ [\ \fIhome_mode\fR\ ]\ ]]
35 .SH "DESCRIPTION"
36 .PP
37 \fImkhomedir_helper\fR
38 is a helper program for the
39 \fIpam_mkhomedir\fR
40 module that creates home directories and populates them with contents of the specified skel directory\&.
41 .PP
42 The default value of
43 \fIumask\fR
44 is 0022 and the default value of
45 \fIpath\-to\-skel\fR
46 is
47 \fI/etc/skel\fR\&. The default value of
48 \fIhome_mode\fR
49 is computed from the value of
50 \fIumask\fR\&.
51 .PP
52 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
53 \fImkhomedir_helper\fR\&.
54 .PP
55 The helper never touches home directories if they already exist\&.
56 .SH "SEE ALSO"
57 .PP
58 \fBpam_mkhomedir\fR(8)
59 .SH "AUTHOR"
60 .PP
61 Written by Tomas Mraz based on the code originally in
62 \fIpam_mkhomedir\fR
63 module\&.