contrib/openpam/doc/man/openpam_set_feature.3

   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 February 24, 2019
   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
  17 This function is experimental and may be modified or removed in a future release without prior warning.
  18 .Ef
  19 .Pp
  20 The
  21 .Fn openpam_set_feature
  22 function sets the state of the specified
  23 feature to the value specified by the
  24 .Fa onoff
  25 argument.
  26 See
  27 .Xr openpam_get_feature 3
  28 for a list of recognized features.
  29 .Pp
  30 .Sh RETURN VALUES
  31 The
  32 .Fn openpam_set_feature
  33 function returns one of the following values:
  34 .Bl -tag -width 18n
  35 .It Bq Er PAM_SUCCESS
  36 Success.
  37 .It Bq Er PAM_BAD_FEATURE
  38 Unrecognized 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
  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 Mt des@des.no .