freebsd-dev/contrib/openpam/doc/man/openpam_set_option.3
2019-02-25 18:41:16 +00:00

55 lines
1.3 KiB
Groff

.\" Generated from openpam_set_option.c by gendoc.pl
.\" $OpenPAM: openpam_set_option.c 938 2017-04-30 21:34:42Z des $
.Dd February 24, 2019
.Dt OPENPAM_SET_OPTION 3
.Os
.Sh NAME
.Nm openpam_set_option
.Nd sets the value of a module option
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.In security/openpam.h
.Ft "int"
.Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value"
.Sh DESCRIPTION
The
.Fn openpam_set_option
function sets the specified option in the
context of the currently executing service module.
.Pp
.Sh RETURN VALUES
The
.Fn openpam_set_option
function returns one of the following values:
.Bl -tag -width 18n
.It Bq Er PAM_SUCCESS
Success.
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_SYSTEM_ERR
System error.
.El
.Sh SEE ALSO
.Xr openpam_get_option 3 ,
.Xr pam 3 ,
.Xr pam_strerror 3
.Sh STANDARDS
The
.Fn openpam_set_option
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn openpam_set_option
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
.Pp
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .