diff options
Diffstat (limited to 'modules/pam_mkhomedir/pam_mkhomedir.8')
| -rw-r--r-- | modules/pam_mkhomedir/pam_mkhomedir.8 | 254 |
1 files changed, 215 insertions, 39 deletions
diff --git a/modules/pam_mkhomedir/pam_mkhomedir.8 b/modules/pam_mkhomedir/pam_mkhomedir.8 index cab1fda1..719ff90f 100644 --- a/modules/pam_mkhomedir/pam_mkhomedir.8 +++ b/modules/pam_mkhomedir/pam_mkhomedir.8 @@ -1,109 +1,285 @@ .\" Title: pam_mkhomedir -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> -.\" Date: 04/16/2008 +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 06/16/2009 .\" Manual: Linux-PAM Manual .\" Source: Linux-PAM Manual +.\" Language: English .\" -.TH "PAM_MKHOMEDIR" "8" "04/16/2008" "Linux-PAM Manual" "Linux-PAM Manual" +.TH "PAM_MKHOMEDIR" "8" "06/16/2009" "Linux-PAM Manual" "Linux-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l -.SH "NAME" -pam_mkhomedir - PAM module to create users home directory -.SH "SYNOPSIS" -.HP 17 -\fBpam_mkhomedir\.so\fR [silent] [umask=\fImode\fR] [skel=\fIskeldir\fR] +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +pam_mkhomedir \- PAM module to create users home directory +.SH "Synopsis" +.fam C +.HP \w'\fBpam_mkhomedir\&.so\fR\ 'u +\fBpam_mkhomedir\&.so\fR [silent] [umask=\fImode\fR] [skel=\fIskeldir\fR] +.fam .SH "DESCRIPTION" .PP -The pam_mkhomedir PAM module will create a users home directory if it does not exist when the session begins\. This allows users to be present in central database (such as NIS, kerberos or LDAP) without using a distributed file system or pre\-creating a large number of directories\. The skeleton directory (usually -\fI/etc/skel/\fR) is used to copy default files and also set\'s a umask for the creation\. +The pam_mkhomedir PAM module will create a users home directory if it does not exist when the session begins\&. This allows users to be present in central database (such as NIS, kerberos or LDAP) without using a distributed file system or pre\-creating a large number of directories\&. The skeleton directory (usually +\FC/etc/skel/\F[]) is used to copy default files and also sets a umask for the creation\&. .PP -The new users home directory will not be removed after logout of the user\. +The new users home directory will not be removed after logout of the user\&. .SH "OPTIONS" .PP \fBsilent\fR .RS 4 -Don\'t print informative messages\. +Don\'t print informative messages\&. .RE .PP \fBumask=\fR\fB\fImask\fR\fR .RS 4 The user file\-creation mask is set to -\fImask\fR\. The default value of mask is 0022\. +\fImask\fR\&. The default value of mask is 0022\&. .RE .PP \fBskel=\fR\fB\fI/path/to/skel/directory\fR\fR .RS 4 Indicate an alternative -\fIskel\fR +\FCskel\F[] directory to override the default -\fI/etc/skel\fR\. +\FC/etc/skel\F[]\&. .RE -.SH "MODULE SERVICES PROVIDED" +.SH "MODULE TYPES PROVIDED" .PP Only the \fBsession\fR -service is supported\. +module type is provided\&. .SH "RETURN VALUES" .PP PAM_BUF_ERR .RS 4 -Memory buffer error\. +Memory buffer error\&. .RE .PP PAM_CRED_INSUFFICIENT .RS 4 -Insufficient credentials to access authentication data\. +Insufficient credentials to access authentication data\&. .RE .PP PAM_PERM_DENIED .RS 4 -Not enough permissions to create the new directory or read the skel directory\. +Not enough permissions to create the new directory or read the skel directory\&. .RE .PP PAM_USER_UNKNOWN .RS 4 -User not known to the underlying authentication module\. +User not known to the underlying authentication module\&. .RE .PP PAM_SUCCESS .RS 4 -Environment variables were set\. +Environment variables were set\&. .RE .SH "FILES" .PP -\fI/etc/skel\fR +\FC/etc/skel\F[] .RS 4 Default skel directory .RE .SH "EXAMPLES" .PP -A sample /etc/pam\.d/login file: +A sample /etc/pam\&.d/login file: .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf - auth requisite pam_securetty\.so - auth sufficient pam_ldap\.so - auth required pam_unix\.so - auth required pam_nologin\.so - account sufficient pam_ldap\.so - account required pam_unix\.so - password required pam_unix\.so - session required pam_mkhomedir\.so skel=/etc/skel/ umask=0022 - session required pam_unix\.so - session optional pam_lastlog\.so - session optional pam_mail\.so standard +.if t \{\ +.sp -1 +.\} +.BB lightgray adjust-for-leading-newline +.sp -1 + + auth requisite pam_securetty\&.so + auth sufficient pam_ldap\&.so + auth required pam_unix\&.so + auth required pam_nologin\&.so + account sufficient pam_ldap\&.so + account required pam_unix\&.so + password required pam_unix\&.so + session required pam_mkhomedir\&.so skel=/etc/skel/ umask=0022 + session required pam_unix\&.so + session optional pam_lastlog\&.so + session optional pam_mail\&.so standard +.EB lightgray adjust-for-leading-newline +.if t \{\ +.sp 1 +.\} .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .sp .SH "SEE ALSO" .PP -\fBpam.d\fR(8), -\fBpam\fR(8)\. +\fBpam.d\fR(5), +\fBpam\fR(8)\&. .SH "AUTHOR" .PP -pam_mkhomedir was written by Jason Gunthorpe <jgg@debian\.org>\. +pam_mkhomedir was written by Jason Gunthorpe <jgg@debian\&.org>\&. |