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