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