diff options
Diffstat (limited to 'contrib/openpam/doc/man/pam_vprompt.3')
-rw-r--r-- | contrib/openpam/doc/man/pam_vprompt.3 | 68 |
1 files changed, 59 insertions, 9 deletions
diff --git a/contrib/openpam/doc/man/pam_vprompt.3 b/contrib/openpam/doc/man/pam_vprompt.3 index e6e29a3..1f6e59a 100644 --- a/contrib/openpam/doc/man/pam_vprompt.3 +++ b/contrib/openpam/doc/man/pam_vprompt.3 @@ -33,7 +33,7 @@ .\" .\" $Id$ .\" -.Dd February 9, 2002 +.Dd February 22, 2002 .Dt PAM_VPROMPT 3 .Os .Sh NAME @@ -48,21 +48,71 @@ .Sh DESCRIPTION The .Nm -function is not yet documented. +function constructs a string from the +.Va fmt +and +.Va ap +arguments using +.Xr vsnprintf 3 , +and passes it to the given PAM context's +conversation function. +.Pp +The +.Va style +argument specifies the type of interaction requested, and +must be one of the following: +.Bl -tag -width 18n +.It Dv PAM_PROMPT_ECHO_OFF +Display the message and obtain the user's response without +displaying it. +.It Dv PAM_PROMPT_ECHO_ON +Display the message and obtain the user's response. +.It Dv PAM_ERROR_MSG +Display the message as an error message, and do not wait +for a response. +.It Dv PAM_TEXT_INFO +Display the message as an informational message, and do +not wait for a response. +.El +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 +The message and response should not exceed +.Dv PAM_MAX_MSG_SIZE +or +.Dv PAM_MAX_RESP_SIZE , +respectively. +If they do, they may be truncated. +.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_prompt 3 , .Xr pam_strerror 3 , -.Xr pam 3 +.Xr pam_verror 3 , +.Xr pam_vinfo 3 , +.Xr vsnprintf 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 |