summaryrefslogtreecommitdiff
path: root/doc/man/pam_get_user.3
diff options
context:
space:
mode:
authorThorsten Kukuk <kukuk@thkukuk.de>2008-01-08 12:44:15 +0000
committerThorsten Kukuk <kukuk@thkukuk.de>2008-01-08 12:44:15 +0000
commitd48c90b14254794fcad9ccc37873a8c663cce02d (patch)
tree62e42b3fd242091e7fab171d1b816586c09e743c /doc/man/pam_get_user.3
parent1f802e15b36f0ca69dc4127a9332983acfd70117 (diff)
Relevant BUGIDs:
Purpose of commit: cleanup Commit summary: --------------- Remove autogenerated documentation from CVS
Diffstat (limited to 'doc/man/pam_get_user.3')
-rw-r--r--doc/man/pam_get_user.379
1 files changed, 0 insertions, 79 deletions
diff --git a/doc/man/pam_get_user.3 b/doc/man/pam_get_user.3
deleted file mode 100644
index f4ab776b..00000000
--- a/doc/man/pam_get_user.3
+++ /dev/null
@@ -1,79 +0,0 @@
-.\" Title: pam_get_user
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
-.\"
-.TH "PAM_GET_USER" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH "NAME"
-pam_get_user \- get user name
-.SH "SYNOPSIS"
-.sp
-.ft B
-.nf
-#include <security/pam_modules.h>
-.fi
-.ft
-.HP 17
-.BI "int pam_get_user(const\ pam_handle_t\ *" "pamh" ", const\ char\ **" "user" ", const\ char\ *" "prompt" ");"
-.SH "DESCRIPTION"
-.PP
-The
-\fBpam_get_user\fR
-function returns the name of the user specified by
-\fBpam_start\fR(3). If no user was specified it what
-\fBpam_get_item (pamh, PAM_USER, ... );\fR
-would have returned. If this is NULL it obtains the username via the
-\fBpam_conv\fR(3)
-mechanism, it prompts the user with the first non\-NULL string in the following list:
-.TP 3n
-\(bu
-The
-\fIprompt\fR
-argument passed to the function.
-.TP 3n
-\(bu
-What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... );
-.TP 3n
-\(bu
-The default prompt: "login: "
-.sp
-.RE
-.PP
-By whatever means the username is obtained, a pointer to it is returned as the contents of
-\fI*user\fR. Note, this memory should
-\fBnot\fR
-be
-\fIfree()\fR'd or
-\fImodified\fR
-by the module.
-.PP
-This function sets the
-\fIPAM_USER\fR
-item associated with the
-\fBpam_set_item\fR(3)
-and
-\fBpam_get_item\fR(3)
-functions.
-.SH "RETURN VALUES"
-.TP 3n
-PAM_SUCCESS
-User name was successful retrieved.
-.TP 3n
-PAM_SYSTEM_ERR
-A NULL pointer was submitted.
-.TP 3n
-PAM_CONV_ERR
-The conversation method supplied by the application failed to obtain the username.
-.SH "SEE ALSO"
-.PP
-
-\fBpam_end\fR(3),
-\fBpam_get_item\fR(3),
-\fBpam_set_item\fR(3),
-\fBpam_strerror\fR(3)