freebsd-nq/contrib/openpam/doc/man/pam_setenv.3

89 lines
2.9 KiB
Groff
Raw Normal View History

2002-02-23 01:22:51 +00:00
.\"-
2003-06-01 12:54:03 +00:00
.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
2002-02-23 01:22:51 +00:00
.\" All rights reserved.
.\"
.\" This software was developed for the FreeBSD Project by ThinkSec AS and
2002-06-30 21:30:05 +00:00
.\" Network Associates Laboratories, the Security Research Division of
.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
.\" ("CBOSS"), as part of the DARPA CHATS research program.
2002-02-23 01:22:51 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
2002-06-30 21:30:05 +00:00
.\" $P4$
2002-02-23 01:22:51 +00:00
.\"
2005-06-17 08:11:43 +00:00
.Dd June 16, 2005
2002-02-23 01:22:51 +00:00
.Dt PAM_SETENV 3
.Os
.Sh NAME
.Nm pam_setenv
.Nd mirrors setenv(3)
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
2003-01-06 16:07:51 +00:00
.In sys/types.h
2002-02-23 01:22:51 +00:00
.In security/pam_appl.h
2003-07-15 07:18:26 +00:00
.Ft "int"
2002-02-23 01:22:51 +00:00
.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
.Sh DESCRIPTION
The
.Nm
2002-02-23 01:24:02 +00:00
function sets a environment variable.
Its semantics are similar to those of
.Xr setenv 3 ,
but it modifies the PAM
context's environment list instead of the application's.
.Pp
2002-02-23 01:22:51 +00:00
.Sh RETURN VALUES
The
2002-02-23 01:24:02 +00:00
.Nm
2002-02-23 01:22:51 +00:00
function returns one of the following values:
2002-02-23 01:24:02 +00:00
.Bl -tag -width 18n
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_SYSTEM_ERR
System error.
2002-02-23 01:22:51 +00:00
.El
.Sh SEE ALSO
2002-02-23 01:24:02 +00:00
.Xr pam 3 ,
.Xr pam_getenv 3 ,
.Xr pam_getenvlist 3 ,
.Xr pam_putenv 3 ,
2002-02-23 01:22:51 +00:00
.Xr pam_strerror 3 ,
2002-02-23 01:24:02 +00:00
.Xr setenv 3
2002-02-23 01:22:51 +00:00
.Sh STANDARDS
2002-02-23 01:24:02 +00:00
The
.Nm
function is an OpenPAM extension.
2002-02-23 01:22:51 +00:00
.Sh AUTHORS
The
.Nm
2003-07-15 07:18:26 +00:00
function and this manual page were developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
2005-02-01 10:16:17 +00:00
Security Research Division of Network Associates, Inc.& under
2003-07-15 07:18:26 +00:00
DARPA/SPAWAR contract N66001-01-C-8035
2002-02-23 01:22:51 +00:00
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.