Merge remote-tracking branch 'origin/vendor/GCC80'
[dragonfly.git] / contrib / openpam / doc / man / pam_putenv.3
1 .\" Generated from pam_putenv.c by gendoc.pl
2 .\" $OpenPAM: pam_putenv.c 938 2017-04-30 21:34:42Z des $
3 .Dd April 30, 2017
4 .Dt PAM_PUTENV 3
5 .Os
6 .Sh NAME
7 .Nm pam_putenv
8 .Nd set the value of an environment variable
9 .Sh SYNOPSIS
10 .In sys/types.h
11 .In security/pam_appl.h
12 .Ft "int"
13 .Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue"
14 .Sh DESCRIPTION
15 The
16 .Fn pam_putenv
17 function sets an environment variable.
18 Its semantics are similar to those of
19 .Xr putenv 3 ,
20 but it modifies the PAM
21 context's environment list instead of the application's.
22 .Pp
23 .Sh RETURN VALUES
24 The
25 .Fn pam_putenv
26 function returns one of the following values:
27 .Bl -tag -width 18n
28 .It Bq Er PAM_SUCCESS
29 Success.
30 .It Bq Er PAM_BUF_ERR
31 Memory buffer error.
32 .It Bq Er PAM_SYSTEM_ERR
33 System error.
34 .El
35 .Sh SEE ALSO
36 .Xr pam 3 ,
37 .Xr pam_getenv 3 ,
38 .Xr pam_getenvlist 3 ,
39 .Xr pam_setenv 3 ,
40 .Xr pam_strerror 3 ,
41 .Xr putenv 3
42 .Sh STANDARDS
43 .Rs
44 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
45 .%D "June 1997"
46 .Re
47 .Sh AUTHORS
48 The
49 .Fn pam_putenv
50 function and this manual page were
51 developed for the
52 .Fx
53 Project by ThinkSec AS and Network Associates Laboratories, the
54 Security Research Division of Network Associates, Inc.\& under
55 DARPA/SPAWAR contract N66001-01-C-8035
56 .Pq Dq CBOSS ,
57 as part of the DARPA CHATS research program.
58 .Pp
59 The OpenPAM library is maintained by
60 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .