diff options
| author | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 13:00:10 -0800 |
|---|---|---|
| committer | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 13:00:10 -0800 |
| commit | 9d69c7bbb05cc22edce56e751cef5828e652988a (patch) | |
| tree | b97c4aa6e6133fa3e319805c5190819020838c32 /Linux-PAM/doc/man/pam_putenv.3 | |
| parent | a6f4ab0bebc76acf85cc0244bd21c1036009c28c (diff) | |
| parent | d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c (diff) | |
| download | pam-9d69c7bbb05cc22edce56e751cef5828e652988a.tar.gz pam-9d69c7bbb05cc22edce56e751cef5828e652988a.tar.bz2 pam-9d69c7bbb05cc22edce56e751cef5828e652988a.zip | |
Merge tag 'upstream/0.99.7.1' into debian
Diffstat (limited to 'Linux-PAM/doc/man/pam_putenv.3')
| -rw-r--r-- | Linux-PAM/doc/man/pam_putenv.3 | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/Linux-PAM/doc/man/pam_putenv.3 b/Linux-PAM/doc/man/pam_putenv.3 new file mode 100644 index 00000000..60b49651 --- /dev/null +++ b/Linux-PAM/doc/man/pam_putenv.3 @@ -0,0 +1,74 @@ +.\" 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) |