summaryrefslogtreecommitdiff
path: root/modules/pam_env/README
diff options
context:
space:
mode:
Diffstat (limited to 'modules/pam_env/README')
-rw-r--r--modules/pam_env/README32
1 files changed, 20 insertions, 12 deletions
diff --git a/modules/pam_env/README b/modules/pam_env/README
index 8b362d2..65a35ce 100644
--- a/modules/pam_env/README
+++ b/modules/pam_env/README
@@ -5,16 +5,20 @@ pam_env — PAM module to set/unset environment variables
DESCRIPTION
The pam_env PAM module allows the (un)setting of environment variables.
-Supported is the use of previously set environment variables as well as
+Supported is the use of previously set environment variables as well as
PAM_ITEMs such as PAM_RHOST.
-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 conffile
+option.
-This module can also parse a file with simple KEY=VAL pairs on separate lines
-(/etc/environment by default). You can change the default file to parse, with
-the envfile flag and turn it on or off by setting the readenv flag to 1 or 0
-respectively.
+Second a file (/etc/environment by default) with simple KEY=VAL pairs on
+separate lines will be read. With the envfile option an alternate file can be
+specified. And with the readenv option this can be completly disabled.
+
+Third it will read a user configuration file ($HOME/.pam_environment by
+default). The default file file can be changed with the user_envfile option and
+it can be turned on and off with the user_readenv option.
Since setting of PAM environment variables can have side effects to other
modules, this module should be the last one on the stack.
@@ -33,8 +37,10 @@ debug
envfile=/path/to/environment
- Indicate an alternative environment file to override the default. This can
- be useful when different services need different environments.
+ Indicate an alternative environment file to override the default. The
+ syntax are simple KEY=VAL pairs on separate lines. The export instruction
+ can be specified for bash compatibility, but will be ignored. This can be
+ useful when different services need different environments.
readenv=0|1
@@ -43,9 +49,10 @@ readenv=0|1
user_envfile=filename
- 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.
+ Indicate an alternative .pam_environment file to override the default.The
+ syntax is the same as for /etc/environment. The filename is relative to the
+ user home directory. This can be useful when different services need
+ different environments.
user_readenv=0|1
@@ -76,6 +83,7 @@ Now some simple variables
NNTPSERVER DEFAULT=localhost
PATH DEFAULT=${HOME}/bin:/usr/local/bin:/bin\
:/usr/bin:/usr/local/bin/X11:/usr/bin/X11
+ XDG_DATA_HOME @{HOME}/share/
Silly examples of escaped variables, just to show how they work.