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