pam_prompt.3 revision 1.5 
1<<<<<<< pam_prompt.3
2.\"	$NetBSD: pam_prompt.3,v 1.5 2014/10/24 18:17:56 christos Exp $
3.\"
4=======
5>>>>>>> 1.1.1.4
6.\" Generated from pam_prompt.c by gendoc.pl
7.\" Id: pam_prompt.c 648 2013-03-05 17:54:27Z des 
8.Dd September 12, 2014
9.Dt PAM_PROMPT 3
10.Os
11.Sh NAME
12.Nm pam_prompt
13.Nd call the conversation function
14.Sh LIBRARY
15.Lb libpam
16.Sh SYNOPSIS
17.In sys/types.h
18.In security/pam_appl.h
19.Ft "int"
20.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
21.Sh DESCRIPTION
22The
23.Fn pam_prompt
24function constructs a message from the specified format
25string and arguments and passes it to the given PAM context's
26conversation function.
27.Pp
28A pointer to the response, or
29.Dv NULL
30if the conversation function did
31not return one, is stored in the location pointed to by the
32.Fa resp
33argument.
34.Pp
35See
36.Xr pam_vprompt 3
37for further details.
38.Sh RETURN VALUES
39The
40.Fn pam_prompt
41function returns one of the following values:
42.Bl -tag -width 18n
43.It Bq Er PAM_BUF_ERR
44Memory buffer error.
45.It Bq Er PAM_CONV_ERR
46Conversation failure.
47.It Bq Er PAM_SYSTEM_ERR
48System error.
49.El
50.Sh SEE ALSO
51.Xr pam 3 ,
52.Xr pam_error 3 ,
53.Xr pam_info 3 ,
54.Xr pam_strerror 3 ,
55.Xr pam_vprompt 3
56.Sh STANDARDS
57The
58.Fn pam_prompt
59function is an OpenPAM extension.
60.Sh AUTHORS
61The
62.Fn pam_prompt
63function and this manual page were
64developed for the
65.Fx
66Project by ThinkSec AS and Network Associates Laboratories, the
67Security Research Division of Network Associates, Inc.\& under
68DARPA/SPAWAR contract N66001-01-C-8035
69.Pq Dq CBOSS ,
70as part of the DARPA CHATS research program.
71.Pp
72The OpenPAM library is maintained by
73.An Dag-Erling Sm\(/orgrav Aq des@des.no .
74