path: root/doc/man/pam_putenv.3
diff options
Diffstat (limited to 'doc/man/pam_putenv.3')
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/man/pam_putenv.3 b/doc/man/pam_putenv.3
new file mode 100644
index 00000000..a0a5c639
--- /dev/null
+++ b/doc/man/pam_putenv.3
@@ -0,0 +1,66 @@
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "PAM_PUTENV" "3" "03/12/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only) l
+pam_putenv \- set or change PAM environment variable
+\fB#include <security/pam_appl.h>\fR
+.HP 15
+\fBint\ \fBpam_putenv\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIname_value\fR\fR\fB);\fR
+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 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.
+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.
+given is a NULL pointer.
+Variable requested (for deletion) is not currently set.
+handle is corrupt.
+Memory buffer error.
+The environment variable was successfully updated.