contrib/openpam/doc/man/openpam_set_feature.3

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