contrib/openpam/doc/man/openpam_set_feature.3

   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 September 7, 2013
   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 LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .In security/openpam.h
  15 .Ft "int"
  16 .Fn openpam_set_feature "int feature" "int onoff"
  17 .Sh DESCRIPTION
  18 .Bf Sy
  19 This function is experimental and may be modified or removed in a future release without prior warning.
  20 .Ef
  21 .Pp
  22 The
  23 .Fn openpam_set_feature
  24 function sets the state of the specified
  25 feature to the value specified by the
  26 .Fa onoff
  27 argument.
  28 See
  29 .Xr openpam_get_feature 3
  30 for a list of recognized features.
  31 .Pp
  32 .Sh RETURN VALUES
  33 The
  34 .Fn openpam_set_feature
  35 function returns one of the following values:
  36 .Bl -tag -width 18n
  37 .It Bq Er PAM_SYMBOL_ERR
  38 Invalid symbol.
  39 .El
  40 .Sh SEE ALSO
  41 .Xr openpam_get_feature 3 ,
  42 .Xr pam 3 ,
  43 .Xr pam_strerror 3
  44 .Sh STANDARDS
  45 The
  46 .Fn openpam_set_feature
  47 function is an OpenPAM extension.
  48 .Sh AUTHORS
  49 The
  50 .Fn openpam_set_feature
  51 function and this manual page were
  52 developed by
  53 .An Dag-Erling Sm\(/orgrav Aq des@des.no .