merge upstream version 1.1.0

1 files changed, 210 insertions, 35 deletions

diff --git a/modules/pam_env/pam_env.8 b/modules/pam_env/pam_env.8
index 3fce01cf..f40c249f 100644
--- a/modules/pam_env/pam_env.8
+++ b/modules/pam_env/pam_env.8
@@ -1,109 +1,284 @@
 .\"     Title: pam_env
-.\"    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_ENV" "8" "04/16/2008" "Linux-PAM Manual" "Linux-PAM Manual"
+.TH "PAM_ENV" "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_env - PAM module to set/unset environment variables
-.SH "SYNOPSIS"
-.HP 11
-\fBpam_env\.so\fR [debug] [conffile=\fIconf\-file\fR] [envfile=\fIenv\-file\fR] [readenv=\fI0|1\fR]
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+pam_env \- PAM module to set/unset environment variables
+.SH "Synopsis"
+.fam C
+.HP \w'\fBpam_env\&.so\fR\ 'u
+\fBpam_env\&.so\fR [debug] [conffile=\fIconf\-file\fR] [envfile=\fIenv\-file\fR] [readenv=\fI0|1\fR] [user_envfile=\fIenv\-file\fR] [user_readenv=\fI0|1\fR]
+.fam
 .SH "DESCRIPTION"
 .PP
-The pam_env PAM module allows the (un)setting of environment variables\. Supported is the use of previously set environment variables as well as
+The pam_env PAM module allows the (un)setting of environment variables\&. Supported is the use of previously set environment variables as well as
 \fIPAM_ITEM\fRs such as
-\fIPAM_RHOST\fR\.
+\fIPAM_RHOST\fR\&.
 .PP
 By default rules for (un)setting of variables is taken from the config file
-\fI/etc/security/pam_env\.conf\fR
-if no other file is specified\.
+\FC/etc/security/pam_env\&.conf\F[]
+if no other file is specified\&.
 .PP
 This module can also parse a file with simple
 \fIKEY=VAL\fR
-pairs on seperate lines (\fI/etc/environment\fR
-by default)\. You can change the default file to parse, with the
+pairs on separate lines (\FC/etc/environment\F[]
+by default)\&. You can change the default file to parse, with the
 \fIenvfile\fR
 flag and turn it on or off by setting the
 \fIreadenv\fR
-flag to 1 or 0 respectively\.
+flag to 1 or 0 respectively\&.
 .SH "OPTIONS"
 .PP
-\fBconffile=\fR\fB\fI/path/to/pam_env\.conf\fR\fR
+\fBconffile=\fR\fB\fI/path/to/pam_env\&.conf\fR\fR
 .RS 4
 Indicate an alternative
-\fIpam_env\.conf\fR
-style configuration file to override the default\. This can be useful when different services need different environments\.
+\FCpam_env\&.conf\F[]
+style configuration file to override the default\&. This can be useful when different services need different environments\&.
 .RE
 .PP
 \fBdebug\fR
 .RS 4
-A lot of debug informations are printed with
-\fBsyslog\fR(3)\.
+A lot of debug information is printed with
+\fBsyslog\fR(3)\&.
 .RE
 .PP
 \fBenvfile=\fR\fB\fI/path/to/environment\fR\fR
 .RS 4
 Indicate an alternative
-\fIenvironment\fR
-file to override the default\. This can be useful when different services need different environments\.
+\FCenvironment\F[]
+file to override the default\&. This can be useful when different services need different environments\&.
 .RE
 .PP
 \fBreadenv=\fR\fB\fI0|1\fR\fR
 .RS 4
-Turns on or off the reading of the file specified by envfile (0 is off, 1 is on)\. By default this option is on\.
+Turns on or off the reading of the file specified by envfile (0 is off, 1 is on)\&. By default this option is on\&.
 .RE
-.SH "MODULE SERVICES PROVIDED"
+.PP
+\fBuser_envfile=\fR\fB\fIfilename\fR\fR
+.RS 4
+Indicate an alternative
+\FC\&.pam_environment\F[]
+file to override the default\&. This can be useful when different services need different environments\&. The filename is relative to the user home directory\&.
+.RE
+.PP
+\fBuser_readenv=\fR\fB\fI0|1\fR\fR
+.RS 4
+Turns on or off the reading of the user specific environment file\&. 0 is off, 1 is on\&. By default this option is on\&.
+.RE
+.SH "MODULE TYPES PROVIDED"
 .PP
 The
 \fBauth\fR
 and
 \fBsession\fR
-services are supported\.
+module types are provided\&.
 .SH "RETURN VALUES"
 .PP
 PAM_ABORT
 .RS 4
-Not all relevant data or options could be gotten\.
+Not all relevant data or options could be gotten\&.
 .RE
 .PP
 PAM_BUF_ERR
 .RS 4
-Memory buffer error\.
+Memory buffer error\&.
 .RE
 .PP
 PAM_IGNORE
 .RS 4
-No pam_env\.conf and environment file was found\.
+No pam_env\&.conf and environment file was found\&.
 .RE
 .PP
 PAM_SUCCESS
 .RS 4
-Environment variables were set\.
+Environment variables were set\&.
 .RE
 .SH "FILES"
 .PP
-\fI/etc/security/pam_env\.conf\fR
+\FC/etc/security/pam_env\&.conf\F[]
 .RS 4
 Default configuration file
 .RE
 .PP
-\fI/etc/environment\fR
+\FC/etc/environment\F[]
 .RS 4
 Default environment file
 .RE
+.PP
+\FC$HOME/\&.pam_environment\F[]
+.RS 4
+User specific environment file
+.RE
 .SH "SEE ALSO"
 .PP
 
 \fBpam_env.conf\fR(5),
-\fBpam.d\fR(8),
-\fBpam\fR(8)\.
+\fBpam.d\fR(5),
+\fBpam\fR(8)\&.
 .SH "AUTHOR"
 .PP
-pam_env was written by Dave Kinchlea <kinch@kinch\.ark\.com>\.
+pam_env was written by Dave Kinchlea <kinch@kinch\&.ark\&.com>\&.