xref: /freebsd/contrib/openpam/doc/man/openpam_set_feature.3 (revision 4928135658a9d0eaee37003df6137ab363fcb0b4)
1.\" Generated from openpam_set_feature.c by gendoc.pl
2.\" $OpenPAM: openpam_set_feature.c 938 2017-04-30 21:34:42Z des $
3.Dd April 30, 2017
4.Dt OPENPAM_SET_FEATURE 3
5.Os
6.Sh NAME
7.Nm openpam_set_feature
8.Nd enable or disable an optional feature
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.In security/openpam.h
13.Ft "int"
14.Fn openpam_set_feature "int feature" "int onoff"
15.Sh DESCRIPTION
16.Bf Sy
17This function is experimental and may be modified or removed in a future release without prior warning.
18.Ef
19.Pp
20The
21.Fn openpam_set_feature
22function sets the state of the specified
23feature to the value specified by the
24.Fa onoff
25argument.
26See
27.Xr openpam_get_feature 3
28for a list of recognized features.
29.Pp
30.Sh RETURN VALUES
31The
32.Fn openpam_set_feature
33function returns one of the following values:
34.Bl -tag -width 18n
35.It Bq Er PAM_SUCCESS
36Success.
37.It Bq Er PAM_BAD_FEATURE
38Unrecognized or restricted feature.
39.El
40.Sh SEE ALSO
41.Xr openpam_get_feature 3 ,
42.Xr pam 3 ,
43.Xr pam_strerror 3
44.Sh STANDARDS
45The
46.Fn openpam_set_feature
47function is an OpenPAM extension.
48.Sh AUTHORS
49The
50.Fn openpam_set_feature
51function and this manual page were
52developed by
53.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
54