summaryrefslogtreecommitdiff
path: root/modules/pam_env/pam_env.8
diff options
context:
space:
mode:
Diffstat (limited to 'modules/pam_env/pam_env.8')
-rw-r--r--modules/pam_env/pam_env.840
1 files changed, 27 insertions, 13 deletions
diff --git a/modules/pam_env/pam_env.8 b/modules/pam_env/pam_env.8
index cb799791..2c9e11c7 100644
--- a/modules/pam_env/pam_env.8
+++ b/modules/pam_env/pam_env.8
@@ -2,12 +2,12 @@
.\" Title: pam_env
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 09/19/2013
+.\" Date: 04/01/2016
.\" Manual: Linux-PAM Manual
.\" Source: Linux-PAM Manual
.\" Language: English
.\"
-.TH "PAM_ENV" "8" "09/19/2013" "Linux-PAM Manual" "Linux-PAM Manual"
+.TH "PAM_ENV" "8" "04/01/2016" "Linux-PAM Manual" "Linux-PAM Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -38,18 +38,26 @@ The pam_env PAM module allows the (un)setting of environment variables\&. Suppor
\fIPAM_ITEM\fRs such as
\fIPAM_RHOST\fR\&.
.PP
-By default rules for (un)setting of variables is taken from the config file
-/etc/security/pam_env\&.conf
-if no other file is specified\&.
+By default rules for (un)setting of variables are taken from the config file
+/etc/security/pam_env\&.conf\&. An alternate file can be specified with the
+\fIconffile\fR
+option\&.
.PP
-This module can also parse a file with simple
+Second a file (/etc/environment
+by default) with simple
\fIKEY=VAL\fR
-pairs on separate lines (/etc/environment
-by default)\&. You can change the default file to parse, with the
+pairs on separate lines will be read\&. With the
\fIenvfile\fR
-flag and turn it on or off by setting the
+option an alternate file can be specified\&. And with the
\fIreadenv\fR
-flag to 1 or 0 respectively\&.
+option this can be completly disabled\&.
+.PP
+Third it will read a user configuration file ($HOME/\&.pam_environment
+by default)\&. The default file file can be changed with the
+\fIuser_envfile\fR
+option and it can be turned on and off with the
+\fIuser_readenv\fR
+option\&.
.PP
Since setting of PAM environment variables can have side effects to other modules, this module should be the last one on the stack\&.
.SH "OPTIONS"
@@ -71,7 +79,11 @@ A lot of debug information is printed with
.RS 4
Indicate an alternative
environment
-file to override the default\&. This can be useful when different services need different environments\&.
+file to override the default\&. The syntax are simple
+\fIKEY=VAL\fR
+pairs on separate lines\&. The
+\fIexport\fR
+instruction can be specified for bash compatibility, but will be ignored\&. This can be useful when different services need different environments\&.
.RE
.PP
\fBreadenv=\fR\fB\fI0|1\fR\fR
@@ -83,7 +95,8 @@ Turns on or off the reading of the file specified by envfile (0 is off, 1 is on)
.RS 4
Indicate an alternative
\&.pam_environment
-file to override the default\&. This can be useful when different services need different environments\&. The filename is relative to the user home directory\&.
+file to override the default\&.The syntax is the same as for
+\fI/etc/environment\fR\&. The filename is relative to the user home directory\&. This can be useful when different services need different environments\&.
.RE
.PP
\fBuser_readenv=\fR\fB\fI0|1\fR\fR
@@ -138,7 +151,8 @@ User specific environment file
.PP
\fBpam_env.conf\fR(5),
\fBpam.d\fR(5),
-\fBpam\fR(8)\&.
+\fBpam\fR(8),
+\fBenviron\fR(7)\&.
.SH "AUTHOR"
.PP
pam_env was written by Dave Kinchlea <kinch@kinch\&.ark\&.com>\&.