summaryrefslogtreecommitdiff
path: root/contrib/openpam/doc/man/pam_prompt.3
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/openpam/doc/man/pam_prompt.3')
-rw-r--r--contrib/openpam/doc/man/pam_prompt.340
1 files changed, 31 insertions, 9 deletions
diff --git a/contrib/openpam/doc/man/pam_prompt.3 b/contrib/openpam/doc/man/pam_prompt.3
index e3ebef896722..177af78f1e70 100644
--- a/contrib/openpam/doc/man/pam_prompt.3
+++ b/contrib/openpam/doc/man/pam_prompt.3
@@ -33,7 +33,7 @@
.\"
.\" $Id$
.\"
-.Dd February 9, 2002
+.Dd February 22, 2002
.Dt PAM_PROMPT 3
.Os
.Sh NAME
@@ -48,21 +48,43 @@
.Sh DESCRIPTION
The
.Nm
-function is not yet documented.
+function constructs a message from the specified format
+string and arguments and passes it to the given PAM context's
+conversation function.
+.Pp
+A pointer to the response, or
+.Dv NULL
+if the conversation function did
+not return one, is stored in the location pointed to by the
+.Va resp
+argument.
+.Pp
+See
+.Xr pam_vprompt 3
+for further details.
+.Pp
.Sh RETURN VALUES
The
-.Fn
+.Nm
function returns one of the following values:
-.Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
+.Bl -tag -width 18n
+.It Bq Er PAM_BUF_ERR
+Memory buffer error.
+.It Bq Er PAM_CONV_ERR
+Conversation failure.
+.It Bq Er PAM_SYSTEM_ERR
+System error.
.El
.Sh SEE ALSO
+.Xr pam 3 ,
+.Xr pam_error 3 ,
+.Xr pam_info 3 ,
.Xr pam_strerror 3 ,
-.Xr pam 3
+.Xr pam_vprompt 3
.Sh STANDARDS
-.Rs
-.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
-.%D "June 1997"
-.Re
+The
+.Nm
+function is an OpenPAM extension.
.Sh AUTHORS
The
.Nm