From 343af1294ca2f648272ae5428bf8fe04ec051308 Mon Sep 17 00:00:00 2001 From: des Date: Mon, 8 Apr 2002 12:30:31 +0000 Subject: Vendor import of OpenPAM Cinchona. --- contrib/openpam/doc/man/pam_get_user.3 | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) (limited to 'contrib/openpam/doc/man/pam_get_user.3') diff --git a/contrib/openpam/doc/man/pam_get_user.3 b/contrib/openpam/doc/man/pam_get_user.3 index 15c967a..e6aba14 100644 --- a/contrib/openpam/doc/man/pam_get_user.3 +++ b/contrib/openpam/doc/man/pam_get_user.3 @@ -31,9 +31,9 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $P4: //depot/projects/openpam/doc/man/pam_get_user.3#10 $ +.\" $P4: //depot/projects/openpam/doc/man/pam_get_user.3#11 $ .\" -.Dd March 7, 2002 +.Dd April 8, 2002 .Dt PAM_GET_USER 3 .Os .Sh NAME @@ -46,7 +46,31 @@ .Ft int .Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" .Sh DESCRIPTION -No description available. +The +.Nm +function returns the name of the target user, as +specified to +.Xr pam_start 3 . +If no user was specified, nor set using +.Xr pam_set_item 3 , +.Nm +will prompt for a user name. Either way, +a pointer to the user name is stored in the location pointed to by the +.Va user +argument. +.Pp +The +.Va prompt +argument specifies a prompt to use if no user name is +cached. If it is +.Dv NULL , +the +.Dv PAM_USER_PROMPT +will be used. If that +item is also +.Dv NULL , +a hardcoded default prompt will be used. +.Pp .Sh RETURN VALUES The .Nm @@ -61,6 +85,10 @@ System error. .El .Sh SEE ALSO .Xr pam 3 , +.Xr pam_get_authtok 3 , +.Xr pam_get_item 3 , +.Xr pam_set_item 3 , +.Xr pam_start 3 , .Xr pam_strerror 3 .Sh STANDARDS .Rs -- cgit v1.1