1PAM_ENV.CONF(5)                Linux-PAM Manual                PAM_ENV.CONF(5)
2
3
4

NAME

6       pam_env.conf - the environment variables config file
7

DESCRIPTION

9       The /etc/security/pam_env.conf file specifies the environment variables
10       to be set, unset or modified by pam_env(8). When someone logs in, this
11       file is read and the environment variables are set according.
12
13       Each line starts with the variable name, there are then two possible
14       options for each variable DEFAULT and OVERRIDE. DEFAULT allows and
15       administrator to set the value of the variable to some default value,
16       if none is supplied then the empty string is assumed. The OVERRIDE
17       option tells pam_env that it should enter in its value (overriding the
18       default value) if there is one to use. OVERRIDE is not used, "" is
19       assumed and no override will be done.
20
21       VARIABLE [DEFAULT=[value]] [OVERRIDE=[value]]
22
23       (Possibly non-existent) environment variables may be used in values
24       using the ${string} syntax and (possibly non-existent) PAM_ITEMs may be
25       used in values using the @{string} syntax. Both the $ and @ characters
26       can be backslash escaped to be used as literal values values can be
27       delimited with "", escaped " not supported. Note that many environment
28       variables that you would like to use may not be set by the time the
29       module is called. For example, HOME is used below several times, but
30       many PAM applications don´t make it available by the time you need it.
31
32       The "#" character at start of line (no space at front) can be used to
33       mark this line as a comment line.
34

EXAMPLES

36       These are some example lines which might be specified in
37       /etc/security/pam_env.conf.
38
39       Set the REMOTEHOST variable for any hosts that are remote, default to
40       "localhost" rather than not being set at all
41
42                 REMOTEHOST     DEFAULT=localhost OVERRIDE=@{PAM_RHOST}
43
44
45       Set the DISPLAY variable if it seems reasonable
46
47                 DISPLAY        DEFAULT=${REMOTEHOST}:0.0 OVERRIDE=${DISPLAY}
48
49
50       Now some simple variables
51
52                 PAGER          DEFAULT=less
53                 MANPAGER       DEFAULT=less
54                 LESS           DEFAULT="M q e h15 z23 b80"
55                 NNTPSERVER     DEFAULT=localhost
56                 PATH           DEFAULT=${HOME}/bin:/usr/local/bin:/bin\
57                 :/usr/bin:/usr/local/bin/X11:/usr/bin/X11
58
59
60       Silly examples of escaped variables, just to show how they work.
61
62                 DOLLAR         DEFAULT=\$
63                 DOLLARDOLLAR   DEFAULT=        OVERRIDE=\$${DOLLAR}
64                 DOLLARPLUS     DEFAULT=\${REMOTEHOST}${REMOTEHOST}
65                 ATSIGN         DEFAULT=""      OVERRIDE=\@
66
67

SEE ALSO

69       pam_env(8), pam.d(5), pam(8)
70

AUTHOR

72       pam_env was written by Dave Kinchlea <kinch@kinch.ark.com>.
73
74
75
76Linux-PAM Manual                  03/02/2009                   PAM_ENV.CONF(5)
Impressum