summaryrefslogtreecommitdiff
path: root/doc/man/pam_authenticate.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_authenticate.3')
-rw-r--r--doc/man/pam_authenticate.342
1 files changed, 25 insertions, 17 deletions
diff --git a/doc/man/pam_authenticate.3 b/doc/man/pam_authenticate.3
index 3bc95d88..e6eb6d94 100644
--- a/doc/man/pam_authenticate.3
+++ b/doc/man/pam_authenticate.3
@@ -1,8 +1,11 @@
-.\" ** You probably do not want to edit this file directly **
-.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
-.\" Instead of manually editing it, you probably should edit the DocBook XML
-.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "PAM_AUTHENTICATE" "3" "05/04/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" Title: pam_authenticate
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\" Date: 06/02/2006
+.\" Manual: Linux\-PAM Manual
+.\" Source: Linux\-PAM Manual
+.\"
+.TH "PAM_AUTHENTICATE" "3" "06/02/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -10,10 +13,14 @@
.SH "NAME"
pam_authenticate \- account authentication
.SH "SYNOPSIS"
-.PP
-\fB#include <security/pam_appl.h>\fR
+.sp
+.ft B
+.nf
+#include <security/pam_appl.h>
+.fi
+.ft
.HP 21
-\fBint\ \fBpam_authenticate\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIflags\fR\fR\fB);\fR
+.BI "int pam_authenticate(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
.SH "DESCRIPTION"
.PP
The
@@ -29,38 +36,39 @@ and
The
\fIpamh\fR
argument is an authentication handle obtained by a prior call to pam_start(). The flags argument is the binary or of zero or more of the following values:
-.TP
+.TP 3n
PAM_SILENT
Do not emit any messages.
-.TP
+.TP 3n
PAM_DISALLOW_NULL_AUTHTOK
The PAM module service should return PAM_AUTH_ERR if the user does not have a registered authentication token.
.SH "RETURN VALUES"
-.TP
+.TP 3n
PAM_ABORT
The application should exit immediately after calling
\fBpam_end\fR(3)
first.
-.TP
+.TP 3n
PAM_AUTH_ERR
The user was not authenticated.
-.TP
+.TP 3n
PAM_CRED_INSUFFICIENT
For some reason the application does not have sufficient credentials to authenticate the user.
-.TP
+.TP 3n
PAM_AUTHINFO_UNVAIL
The modules were not able to access the authentication information. This might be due to a network or hardware failure etc.
-.TP
+.TP 3n
PAM_MAXTRIES
One or more of the authentication modules has reached its limit of tries authenticating the user. Do not try again.
-.TP
+.TP 3n
PAM_SUCCESS
The user was successfully authenticated.
-.TP
+.TP 3n
PAM_USER_UNKNOWN
User unknown to authentication service.
.SH "SEE ALSO"
.PP
+
\fBpam_start\fR(3),
\fBpam_setcred\fR(3),
\fBpam_chauthtok\fR(3),