xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_set_feature.3 (revision 4391d5e9d4f291db41e3b3ba26a01b5e51364aae)
1.\"	$NetBSD: openpam_set_feature.3,v 1.2 2013/07/20 21:40:04 wiz Exp $
2.\"
3.\"-
4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
6.\" All rights reserved.
7.\"
8.\" This software was developed for the FreeBSD Project by ThinkSec AS and
9.\" Network Associates Laboratories, the Security Research Division of
10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
11.\" ("CBOSS"), as part of the DARPA CHATS research program.
12.\"
13.\" Redistribution and use in source and binary forms, with or without
14.\" modification, are permitted provided that the following conditions
15.\" are met:
16.\" 1. Redistributions of source code must retain the above copyright
17.\"    notice, this list of conditions and the following disclaimer.
18.\" 2. Redistributions in binary form must reproduce the above copyright
19.\"    notice, this list of conditions and the following disclaimer in the
20.\"    documentation and/or other materials provided with the distribution.
21.\" 3. The name of the author may not be used to endorse or promote
22.\"    products derived from this software without specific prior written
23.\"    permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\" Id
38.\"
39.Dd May 26, 2012
40.Dt OPENPAM_SET_FEATURE 3
41.Os
42.Sh NAME
43.Nm openpam_set_feature
44.Nd enable or disable an optional feature
45.Sh LIBRARY
46.Lb libpam
47.Sh SYNOPSIS
48.In sys/types.h
49.In security/pam_appl.h
50.In security/openpam.h
51.Ft "int"
52.Fn openpam_set_feature "int feature" "int onoff"
53.Sh DESCRIPTION
54.Bf Sy
55This function is experimental and may be modified or removed in a future release without further warning.
56.Ef
57.Pp
58The
59.Fn openpam_set_feature
60function sets the state of the specified
61feature to the value specified by the
62.Fa onoff
63argument.
64See
65.Xr openpam_get_feature 3
66for a list of recognized features.
67.Pp
68.Sh RETURN VALUES
69The
70.Fn openpam_set_feature
71function returns one of the following values:
72.Bl -tag -width 18n
73.It Bq Er PAM_SYMBOL_ERR
74Invalid symbol.
75.El
76.Sh SEE ALSO
77.Xr openpam_get_feature 3 ,
78.Xr pam 3 ,
79.Xr pam_strerror 3
80.Sh STANDARDS
81The
82.Fn openpam_set_feature
83function is an OpenPAM extension.
84.Sh AUTHORS
85The
86.Fn openpam_set_feature
87function and this manual page were
88developed by
89.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
90