aboutsummaryrefslogtreecommitdiff
path: root/doc/man/pam_putenv.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_putenv.3')
-rw-r--r--doc/man/pam_putenv.374
1 files changed, 0 insertions, 74 deletions
diff --git a/doc/man/pam_putenv.3 b/doc/man/pam_putenv.3
deleted file mode 100644
index 60b49651..00000000
--- a/doc/man/pam_putenv.3
+++ /dev/null
@@ -1,74 +0,0 @@
-.\" Title: pam_putenv
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
-.\"
-.TH "PAM_PUTENV" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH "NAME"
-pam_putenv \- set or change PAM environment variable
-.SH "SYNOPSIS"
-.sp
-.ft B
-.nf
-#include <security/pam_appl.h>
-.fi
-.ft
-.HP 15
-.BI "int pam_putenv(pam_handle_t\ *" "pamh" ", const\ char\ *" "name_value" ");"
-.SH "DESCRIPTION"
-.PP
-The
-\fBpam_putenv\fR
-function is used to add or change the value of PAM environment variables as associated with the
-\fIpamh\fR
-handle.
-.PP
-The
-\fIpamh\fR
-argument is an authentication handle obtained by a prior call to pam_start(). The
-\fIname_value\fR
-argument is a single NUL terminated string of one of the following forms:
-.TP 3n
-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.
-.TP 3n
-NAME=
-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.
-.TP 3n
-NAME
-Without an '=' the pam_putenv() function will delete the corresponding variable from the PAM environment.
-.SH "RETURN VALUES"
-.TP 3n
-PAM_PERM_DENIED
-Argument
-\fIname_value\fR
-given is a NULL pointer.
-.TP 3n
-PAM_BAD_ITEM
-Variable requested (for deletion) is not currently set.
-.TP 3n
-PAM_ABORT
-The
-\fIpamh\fR
-handle is corrupt.
-.TP 3n
-PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
-PAM_SUCCESS
-The environment variable was successfully updated.
-.SH "SEE ALSO"
-.PP
-
-\fBpam_start\fR(3),
-\fBpam_getenv\fR(3),
-\fBpam_getenvlist\fR(3),
-\fBpam_strerror\fR(3),
-\fBpam\fR(8)