contrib/libpam/doc/man/pam_strerror.3

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\" ripped off from Rick Faith's getgroups man page
   3 .\" $Id: pam_strerror.3,v 1.2 1997/02/15 18:53:04 morgan Exp $
   4 .\" $FreeBSD: src/contrib/libpam/doc/man/pam_strerror.3,v 1.2.6.2 2001/06/11 15:28:11 markm Exp $
   5 .\" Copyright (c) Andrew G. Morgan 1996-7 <morgan@parc.power.net>
   6 .TH PAM_STRERROR 3 "1997 Feb 15" "PAM 0.56" "Programmers' Manual"
   7 .SH NAME
   8
   9 pam_strerror \- return a textual description of a PAM error
  10
  11 .SH SYNOPSIS
  12 .B #include <security/pam_appl.h>
  13 .br
  14 or,
  15 .br
  16 .B #include <security/pam_modules.h>
  17 .sp
  18 .BI "const char *pam_strerror(" int " pam_error);
  19 .sp 2
  20 .SH DESCRIPTION
  21 .B pam_strerror
  22
  23 This function returns a pointer to a line of text describing the
  24 .BR PAM
  25 error passed as its sole argument.
  26
  27 .SH "RETURN VALUE"
  28
  29 On success this function returns a description of the indicated
  30 error.  Should the function not recognize the error, ``Unknown
  31 PAM error'' is returned.
  32
  33 .SH "CONFORMING TO"
  34 DCE-RFC 86.0, October 1995.
  35
  36 .SH BUGS
  37 .sp 2
  38 This function should be internationalized.
  39
  40 .SH "SEE ALSO"
  41
  42 .BR pam "(8). "
  43
  44 Also, see the three
  45 .BR Linux-PAM
  46 Guides, for
  47 .BR "System administrators" ", "
  48 .BR "module developers" ", "
  49 and
  50 .BR "application developers" ". "