1PAM_ENV(8)                     Linux-PAM Manual                     PAM_ENV(8)
2
3
4

NAME

6       pam_env - PAM module to set/unset environment variables
7

SYNOPSIS

9       pam_env.so [debug] [conffile=conf-file] [envfile=env-file]
10                  [readenv=0|1]
11

DESCRIPTION

13       The pam_env PAM module allows the (un)setting of environment variables.
14       Supported is the use of previously set environment variables as well as
15       PAM_ITEMs such as PAM_RHOST.
16
17       By default rules for (un)setting of variables is taken from the config
18       file /etc/security/pam_env.conf if no other file is specified.
19
20       This module can also parse a file with simple KEY=VAL pairs on seperate
21       lines (/etc/environment by default). You can change the default file to
22       parse, with the envfile flag and turn it on or off by setting the
23       readenv flag to 1 or 0 respectively.
24

OPTIONS

26       conffile=/path/to/pam_env.conf
27          Indicate an alternative pam_env.conf style configuration file to
28          override the default. This can be useful when different services
29          need different environments.
30
31       debug
32          A lot of debug informations are printed with syslog(3).
33
34       envfile=/path/to/environment
35          Indicate an alternative environment file to override the default.
36          This can be useful when different services need different
37          environments.
38
39       readenv=0|1
40          Turns on or off the reading of the file specified by envfile (0 is
41          off, 1 is on). By default this option is on.
42

MODULE SERVICES PROVIDED

44       The auth and session services are supported.
45

RETURN VALUES

47       PAM_ABORT
48          Not all relevant data or options could be gotten.
49
50       PAM_BUF_ERR
51          Memory buffer error.
52
53       PAM_IGNORE
54          No pam_env.conf and environment file was found.
55
56       PAM_SUCCESS
57          Environment variables were set.
58

FILES

60       /etc/security/pam_env.conf
61          Default configuration file
62
63       /etc/environment
64          Default environment file
65

SEE ALSO

67       pam_env.conf(5), pam.d(8), pam(8).
68

AUTHOR

70       pam_env was written by Dave Kinchlea <kinch@kinch.ark.com>.
71
72
73
74Linux-PAM Manual                  06/21/2006                        PAM_ENV(8)
Impressum