diff options
Diffstat (limited to 'contrib/libpam/doc/modules/pam_env.sgml')
| -rw-r--r-- | contrib/libpam/doc/modules/pam_env.sgml | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/contrib/libpam/doc/modules/pam_env.sgml b/contrib/libpam/doc/modules/pam_env.sgml index a62f4576f132..a6361cacc76a 100644 --- a/contrib/libpam/doc/modules/pam_env.sgml +++ b/contrib/libpam/doc/modules/pam_env.sgml @@ -1,5 +1,5 @@ <!-- - $Id: pam_env.sgml,v 1.1 1997/04/05 06:50:42 morgan Exp $ + $Id: pam_env.sgml,v 1.2 2001/03/19 01:46:41 agmorgan Exp $ This file was written by Dave Kinchlea <kinch@kinch.ark.com> Ed. AGM @@ -50,7 +50,8 @@ is the use of previously set environment variables as well as <descrip> <tag><bf>Recognized arguments:</bf></tag> -<tt/debug/; <tt/conffile=/<em/configuration-file-name/ +<tt/debug/; <tt/conffile=/<em/configuration-file-name/; +<tt/envfile/=<em/env-file-name/; <tt/readenv/=<em/0|1/ <tag><bf>Description:</bf></tag> This module allows you to (un)set arbitrary environment variables @@ -60,9 +61,9 @@ and/or <em/PAM_ITEM/s. <p> All is controlled via a configuration file (by default, <tt>/etc/security/pam_env.conf</tt> but can be overriden with -<tt>connfile</tt> argument). Each line starts with the variable name, +<tt>conffile</tt> argument). Each line starts with the variable name, there are then two possible options for each variable <bf>DEFAULT</bf> -and <bf>OVERRIDE</bf>. <bf>DEFAULT</bf> allows and administrator to +and <bf>OVERRIDE</bf>. <bf>DEFAULT</bf> allows an administrator to set the value of the variable to some default value, if none is supplied then the empty string is assumed. The <bf>OVERRIDE</bf> option tells pam_env that it should enter in its value (overriding the @@ -88,6 +89,12 @@ space is needed <bf>the full value must be delimited by the quotes and embedded or escaped quotes are not supported</bf>. <p> +This module can also parse a file with simple <tt>KEY=VAL</tt> pairs +on seperate lines (<tt>/etc/environment</tt> by default). You can +change the default file to parse, with the <em/envfile/ flag and turn +it on or off by setting the <em/readenv/ flag to 1 or 0 respectively. + +<p> The behavior of this module can be modified with one of the following flags: @@ -102,6 +109,15 @@ flags: the configuration file. This option overrides the default. You must supply a complete path + file name. +<item><tt/envfile=/<em/filename/ +- by default the file <tt>/etc/environment</tt> is used to load KEY=VAL +pairs directly into the env. This option overrides the default. You must +supply a complete path + file name. + +<item><tt/readenv=/<em/0|1/ +- turns on or off the reading of the file specified by envfile (0 is off, +1 is on). By default this option is on. + </itemize> <tag><bf>Examples/suggested usage:</bf></tag> |