diff options
Diffstat (limited to 'Linux-PAM/modules/pam_env')
| -rw-r--r-- | Linux-PAM/modules/pam_env/pam_env.8 | 94 | ||||
| -rw-r--r-- | Linux-PAM/modules/pam_env/pam_env.conf.5 | 48 |
2 files changed, 81 insertions, 61 deletions
diff --git a/Linux-PAM/modules/pam_env/pam_env.8 b/Linux-PAM/modules/pam_env/pam_env.8 index e7746de3..9d3a9d59 100644 --- a/Linux-PAM/modules/pam_env/pam_env.8 +++ b/Linux-PAM/modules/pam_env/pam_env.8 @@ -1,89 +1,109 @@ .\" Title: pam_env .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> -.\" Date: 06/21/2006 -.\" Manual: Linux\-PAM Manual -.\" Source: Linux\-PAM Manual +.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> +.\" Date: 01/08/2008 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual .\" -.TH "PAM_ENV" "8" "06/21/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_ENV" "8" "01/08/2008" "Linux-PAM Manual" "Linux-PAM Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .SH "NAME" -pam_env \- PAM module to set/unset environment variables +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] +\fBpam_env\.so\fR [debug] [conffile=\fIconf\-file\fR] [envfile=\fIenv\-file\fR] [readenv=\fI0|1\fR] .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. +\fI/etc/security/pam_env\.conf\fR +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 +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" -.TP 3n -\fBconffile=\fR\fB\fI/path/to/pam_env.conf\fR\fR +.PP +\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. -.TP 3n +\fIpam_env\.conf\fR +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). -.TP 3n +\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. -.TP 3n +file to override the default\. This can be useful when different services need different environments\. +.RE +.PP \fBreadenv=\fR\fB\fI0|1\fR\fR -Turns on or off the reading of the file specified by envfile (0 is off, 1 is on). By default this option is on. +.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\. +.RE .SH "MODULE SERVICES PROVIDED" .PP The \fBauth\fR and \fBsession\fR -services are supported. +services are supported\. .SH "RETURN VALUES" -.TP 3n +.PP PAM_ABORT -Not all relevant data or options could be gotten. -.TP 3n +.RS 4 +Not all relevant data or options could be gotten\. +.RE +.PP PAM_BUF_ERR -Memory buffer error. -.TP 3n +.RS 4 +Memory buffer error\. +.RE +.PP PAM_IGNORE -No pam_env.conf and environment file was found. -.TP 3n +.RS 4 +No pam_env\.conf and environment file was found\. +.RE +.PP PAM_SUCCESS -Environment variables were set. +.RS 4 +Environment variables were set\. +.RE .SH "FILES" -.TP 3n -\fI/etc/security/pam_env.conf\fR +.PP +\fI/etc/security/pam_env\.conf\fR +.RS 4 Default configuration file -.TP 3n +.RE +.PP \fI/etc/environment\fR +.RS 4 Default environment file +.RE .SH "SEE ALSO" .PP \fBpam_env.conf\fR(5), \fBpam.d\fR(8), -\fBpam\fR(8). +\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>\. diff --git a/Linux-PAM/modules/pam_env/pam_env.conf.5 b/Linux-PAM/modules/pam_env/pam_env.conf.5 index 17c1a19d..3840407f 100644 --- a/Linux-PAM/modules/pam_env/pam_env.conf.5 +++ b/Linux-PAM/modules/pam_env/pam_env.conf.5 @@ -1,41 +1,41 @@ .\" Title: pam_env.conf .\" Author: -.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> -.\" Date: 06/21/2006 -.\" Manual: Linux\-PAM Manual -.\" Source: Linux\-PAM Manual +.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> +.\" Date: 01/08/2008 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual .\" -.TH "PAM_ENV.CONF" "5" "06/21/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_ENV\.CONF" "5" "01/08/2008" "Linux-PAM Manual" "Linux\-PAM Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .SH "NAME" -pam_env.conf \- the environment variables config file +pam_env.conf - the environment variables config file .SH "DESCRIPTION" .PP The -\fI/etc/security/pam_env.conf\fR +\fI/etc/security/pam_env\.conf\fR file specifies the environment variables to be set, unset or modified by -\fBpam_env\fR(8). When someone logs in, this file is read and the environment variables are set according. +\fBpam_env\fR(8)\. When someone logs in, this file is read and the environment variables are set according\. .PP -Each line starts with the variable name, there are then two possible options for each variable DEFAULT and OVERRIDE. DEFAULT allows and administrator to set the value of the variable to some default value, if none is supplied then the empty string is assumed. The OVERRIDE option tells pam_env that it should enter in its value (overriding the default value) if there is one to use. OVERRIDE is not used, "" is assumed and no override will be done. +Each line starts with the variable name, there are then two possible options for each variable DEFAULT and OVERRIDE\. DEFAULT allows and administrator to set the value of the variable to some default value, if none is supplied then the empty string is assumed\. The OVERRIDE option tells pam_env that it should enter in its value (overriding the default value) if there is one to use\. OVERRIDE is not used, "" is assumed and no override will be done\. .PP \fIVARIABLE\fR [\fIDEFAULT=[value]\fR] [\fIOVERRIDE=[value]\fR] .PP -(Possibly non\-existent) environment variables may be used in values using the ${string} syntax and (possibly non\-existent) PAM_ITEMs may be used in values using the @{string} syntax. Both the $ and @ characters can be backslash escaped to be used as literal values values can be delimited with "", escaped " not supported. Note that many environment variables that you would like to use may not be set by the time the module is called. For example, HOME is used below several times, but many PAM applications don't make it available by the time you need it. +(Possibly non\-existent) environment variables may be used in values using the ${string} syntax and (possibly non\-existent) PAM_ITEMs may be used in values using the @{string} syntax\. Both the $ and @ characters can be backslash escaped to be used as literal values values can be delimited with "", escaped " not supported\. Note that many environment variables that you would like to use may not be set by the time the module is called\. For example, HOME is used below several times, but many PAM applications don\'t make it available by the time you need it\. .PP -The "\fI#\fR" character at start of line (no space at front) can be used to mark this line as a comment line. +The "\fI#\fR" character at start of line (no space at front) can be used to mark this line as a comment line\. .SH "EXAMPLES" .PP These are some example lines which might be specified in -\fI/etc/security/pam_env.conf\fR. +\fI/etc/security/pam_env\.conf\fR\. .PP Set the REMOTEHOST variable for any hosts that are remote, default to "localhost" rather than not being set at all .sp -.RS 3n +.RS 4 .nf REMOTEHOST DEFAULT=localhost OVERRIDE=@{PAM_RHOST} @@ -44,35 +44,35 @@ Set the REMOTEHOST variable for any hosts that are remote, default to "localhost .PP Set the DISPLAY variable if it seems reasonable .sp -.RS 3n +.RS 4 .nf - DISPLAY DEFAULT=${REMOTEHOST}:0.0 OVERRIDE=${DISPLAY} + DISPLAY DEFAULT=${REMOTEHOST}:0\.0 OVERRIDE=${DISPLAY} .fi .RE .PP Now some simple variables .sp -.RS 3n +.RS 4 .nf PAGER DEFAULT=less MANPAGER DEFAULT=less LESS DEFAULT="M q e h15 z23 b80" NNTPSERVER DEFAULT=localhost - PATH DEFAULT=${HOME}/bin:/usr/local/bin:/bin\\ + PATH DEFAULT=${HOME}/bin:/usr/local/bin:/bin\e :/usr/bin:/usr/local/bin/X11:/usr/bin/X11 .fi .RE .PP -Silly examples of escaped variables, just to show how they work. +Silly examples of escaped variables, just to show how they work\. .sp -.RS 3n +.RS 4 .nf - DOLLAR DEFAULT=\\$ - DOLLARDOLLAR DEFAULT= OVERRIDE=\\$${DOLLAR} - DOLLARPLUS DEFAULT=\\${REMOTEHOST}${REMOTEHOST} - ATSIGN DEFAULT="" OVERRIDE=\\@ + DOLLAR DEFAULT=\e$ + DOLLARDOLLAR DEFAULT= OVERRIDE=\e$${DOLLAR} + DOLLARPLUS DEFAULT=\e${REMOTEHOST}${REMOTEHOST} + ATSIGN DEFAULT="" OVERRIDE=\e@ .fi .RE @@ -84,4 +84,4 @@ Silly examples of escaped variables, just to show how they work. \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>\. |