Diffstat (limited to 'doc/man/pam_putenv.3')
1 files changed, 47 insertions, 25 deletions
diff --git a/doc/man/pam_putenv.3 b/doc/man/pam_putenv.3
index 60b49651..b0edc103 100644
@@ -1,22 +1,22 @@
.\" Title: pam_putenv
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 09/28/2007
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
-.TH "PAM_PUTENV" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_PUTENV" "3" "09/28/2007" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.\" disable justification (adjust text to left margin only)
-pam_putenv \- set or change PAM environment variable
+pam_putenv - set or change PAM environment variable
@@ -27,43 +27,65 @@ The
function is used to add or change the value of PAM environment variables as associated with the
-argument is an authentication handle obtained by a prior call to pam_start(). The
+argument is an authentication handle obtained by a prior call to pam_start()\. The
argument is a single NUL terminated string of one of the following forms:
NAME=value of variable
In this case the environment variable of the given NAME is set to the indicated value:
-\fIvalue of variable\fR. If this variable is already known, it is overwritten. Otherwise it is added to the PAM environment.
+\fIvalue of variable\fR\. If this variable is already known, it is overwritten\. Otherwise it is added to the PAM environment\.
-This function sets the variable to an empty value. It is listed separately to indicate that this is the correct way to achieve such a setting.
+This function sets the variable to an empty value\. It is listed separately to indicate that this is the correct way to achieve such a setting\.
-Without an '=' the pam_putenv() function will delete the corresponding variable from the PAM environment.
+Without an \'=\' the
+\fBpam_putenv\fR() function will delete the corresponding variable from the PAM environment\.
+\fBpam_putenv\fR() operates on a copy of
+\fIname_value\fR, which means in contrast to
+\fBputenv\fR(3), the application is responsible to free the data\.
.SH "RETURN VALUES"
-given is a NULL pointer.
+given is a NULL pointer\.
-Variable requested (for deletion) is not currently set.
+Variable requested (for deletion) is not currently set\.
-handle is corrupt.
+handle is corrupt\.
-Memory buffer error.
+Memory buffer error\.
-The environment variable was successfully updated.
+The environment variable was successfully updated\.
.SH "SEE ALSO"