summaryrefslogtreecommitdiff
path: root/Linux-PAM/doc/man/pam_putenv.3
diff options
context:
space:
mode:
Diffstat (limited to 'Linux-PAM/doc/man/pam_putenv.3')
-rw-r--r--Linux-PAM/doc/man/pam_putenv.396
1 files changed, 0 insertions, 96 deletions
diff --git a/Linux-PAM/doc/man/pam_putenv.3 b/Linux-PAM/doc/man/pam_putenv.3
deleted file mode 100644
index 00b1678e..00000000
--- a/Linux-PAM/doc/man/pam_putenv.3
+++ /dev/null
@@ -1,96 +0,0 @@
-.\" Title: pam_putenv
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
-.\" Date: 02/04/2008
-.\" Manual: Linux-PAM Manual
-.\" Source: Linux-PAM Manual
-.\"
-.TH "PAM_PUTENV" "3" "02/04/2008" "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:
-.PP
-NAME=value of variable
-.RS 4
-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\.
-.RE
-.PP
-NAME=
-.RS 4
-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\.
-.RE
-.PP
-NAME
-.RS 4
-Without an \'=\' the
-\fBpam_putenv\fR() function will delete the corresponding variable from the PAM environment\.
-.RE
-.PP
-
-\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"
-.PP
-PAM_PERM_DENIED
-.RS 4
-Argument
-\fIname_value\fR
-given is a NULL pointer\.
-.RE
-.PP
-PAM_BAD_ITEM
-.RS 4
-Variable requested (for deletion) is not currently set\.
-.RE
-.PP
-PAM_ABORT
-.RS 4
-The
-\fIpamh\fR
-handle is corrupt\.
-.RE
-.PP
-PAM_BUF_ERR
-.RS 4
-Memory buffer error\.
-.RE
-.PP
-PAM_SUCCESS
-.RS 4
-The environment variable was successfully updated\.
-.RE
-.SH "SEE ALSO"
-.PP
-
-\fBpam_start\fR(3),
-\fBpam_getenv\fR(3),
-\fBpam_getenvlist\fR(3),
-\fBpam_strerror\fR(3),
-\fBpam\fR(8)