xref: /freebsd/contrib/openpam/doc/man/openpam_set_feature.3 (revision 5944f899a2519c6321bac3c17cc076418643a088)
1.\" Generated from openpam_set_feature.c by gendoc.pl
2.\" $Id: openpam_set_feature.c 648 2013-03-05 17:54:27Z des $
3.Dd February 19, 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_SYMBOL_ERR
36Invalid symbol.
37.El
38.Sh SEE ALSO
39.Xr openpam_get_feature 3 ,
40.Xr pam 3 ,
41.Xr pam_strerror 3
42.Sh STANDARDS
43The
44.Fn openpam_set_feature
45function is an OpenPAM extension.
46.Sh AUTHORS
47The
48.Fn openpam_set_feature
49function and this manual page were
50developed by
51.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
52