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