xref: /freebsd/contrib/openpam/doc/man/pam_setenv.3 (revision b52b9d56d4e96089873a75f9e29062eec19fabba)
1.\"-
2.\" Copyright (c) 2002 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4$
35.\"
36.Dd June 30, 2002
37.Dt PAM_SETENV 3
38.Os
39.Sh NAME
40.Nm pam_setenv
41.Nd mirrors setenv(3)
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.Ft int
47.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
48.Sh DESCRIPTION
49The
50.Nm
51function sets a environment variable.
52Its semantics are similar to those of
53.Xr setenv 3 ,
54but it modifies the PAM
55context's environment list instead of the application's.
56.Pp
57.Sh RETURN VALUES
58The
59.Nm
60function returns one of the following values:
61.Bl -tag -width 18n
62.It Bq Er PAM_BUF_ERR
63Memory buffer error.
64.It Bq Er PAM_SYSTEM_ERR
65System error.
66.El
67.Sh SEE ALSO
68.Xr pam 3 ,
69.Xr pam_getenv 3 ,
70.Xr pam_getenvlist 3 ,
71.Xr pam_putenv 3 ,
72.Xr pam_strerror 3 ,
73.Xr setenv 3
74.Sh STANDARDS
75The
76.Nm
77function is an OpenPAM extension.
78.Sh AUTHORS
79The
80.Nm
81function and this manual page were developed for the FreeBSD Project
82by ThinkSec AS and Network Associates Laboratories, the Security
83Research Division of Network Associates, Inc.  under DARPA/SPAWAR
84contract N66001-01-C-8035
85.Pq Dq CBOSS ,
86as part of the DARPA CHATS research program.
87