diff options
Diffstat (limited to 'modules/pam_env/pam_env.8')
| -rw-r--r-- | modules/pam_env/pam_env.8 | 209 |
1 files changed, 40 insertions, 169 deletions
diff --git a/modules/pam_env/pam_env.8 b/modules/pam_env/pam_env.8 index a30f9ad..7192457 100644 --- a/modules/pam_env/pam_env.8 +++ b/modules/pam_env/pam_env.8 @@ -1,161 +1,22 @@ +'\" t .\" Title: pam_env .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> -.\" Date: 08/17/2012 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/22/2015 .\" Manual: Linux-PAM Manual .\" Source: Linux-PAM Manual .\" Language: English .\" -.TH "PAM_ENV" "8" "08/17/2012" "Linux-PAM Manual" "Linux-PAM Manual" +.TH "PAM_ENV" "8" "06/22/2015" "Linux-PAM Manual" "Linux-PAM Manual" .\" ----------------------------------------------------------------- -.\" * (re)Define some macros +.\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,31 +27,37 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" pam_env \- PAM module to set/unset environment variables -.SH "Synopsis" -.fam C +.SH "SYNOPSIS" .HP \w'\fBpam_env\&.so\fR\ 'u \fBpam_env\&.so\fR [debug] [conffile=\fIconf\-file\fR] [envfile=\fIenv\-file\fR] [readenv=\fI0|1\fR] [user_envfile=\fIenv\-file\fR] [user_readenv=\fI0|1\fR] -.fam .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 \fIPAM_ITEM\fRs such as \fIPAM_RHOST\fR\&. .PP -By default rules for (un)setting of variables is taken from the config file -\FC/etc/security/pam_env\&.conf\F[] -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 +\fIconffile\fR +option\&. .PP -This module can also parse a file with simple +Second a file (/etc/environment +by default) with simple \fIKEY=VAL\fR -pairs on separate lines (\FC/etc/environment\F[] -by default)\&. You can change the default file to parse, with the +pairs on separate lines will be read\&. With the \fIenvfile\fR -flag and turn it on or off by setting the +option an alternate file can be specified\&. And with the \fIreadenv\fR -flag to 1 or 0 respectively\&. +option this can be completly disabled\&. +.PP +Third it will read a user configuration file ($HOME/\&.pam_environment +by default)\&. The default file file can be changed with the +\fIuser_envfile\fR +option and it can be turned on and off with the +\fIuser_readenv\fR +option\&. .PP Since setting of PAM environment variables can have side effects to other modules, this module should be the last one on the stack\&. .SH "OPTIONS" @@ -198,7 +65,7 @@ Since setting of PAM environment variables can have side effects to other module \fBconffile=\fR\fB\fI/path/to/pam_env\&.conf\fR\fR .RS 4 Indicate an alternative -\FCpam_env\&.conf\F[] +pam_env\&.conf style configuration file to override the default\&. This can be useful when different services need different environments\&. .RE .PP @@ -211,8 +78,12 @@ A lot of debug information is printed with \fBenvfile=\fR\fB\fI/path/to/environment\fR\fR .RS 4 Indicate an alternative -\FCenvironment\F[] -file to override the default\&. This can be useful when different services need different environments\&. +environment +file to override the default\&. The syntax are simple +\fIKEY=VAL\fR +pairs on separate lines\&. The +\fIexport\fR +instruction can be specified for bash compatibility, but will be ignored\&. This can be useful when different services need different environments\&. .RE .PP \fBreadenv=\fR\fB\fI0|1\fR\fR @@ -223,8 +94,9 @@ Turns on or off the reading of the file specified by envfile (0 is off, 1 is on) \fBuser_envfile=\fR\fB\fIfilename\fR\fR .RS 4 Indicate an alternative -\FC\&.pam_environment\F[] -file to override the default\&. This can be useful when different services need different environments\&. The filename is relative to the user home directory\&. +\&.pam_environment +file to override the default\&.The syntax is the same as for +\fI/etc/environment\fR\&. The filename is relative to the user home directory\&. This can be useful when different services need different environments\&. .RE .PP \fBuser_readenv=\fR\fB\fI0|1\fR\fR @@ -261,23 +133,22 @@ Environment variables were set\&. .RE .SH "FILES" .PP -\FC/etc/security/pam_env\&.conf\F[] +/etc/security/pam_env\&.conf .RS 4 Default configuration file .RE .PP -\FC/etc/environment\F[] +/etc/environment .RS 4 Default environment file .RE .PP -\FC$HOME/\&.pam_environment\F[] +$HOME/\&.pam_environment .RS 4 User specific environment file .RE .SH "SEE ALSO" .PP - \fBpam_env.conf\fR(5), \fBpam.d\fR(5), \fBpam\fR(8)\&. |