diff options
author | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 16:18:43 -0800 |
---|---|---|
committer | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 17:01:52 -0800 |
commit | 26ee21df2a5fe63f08cfae8c7d35c24bd3dd4f04 (patch) | |
tree | e6e25c1da5974a60660c8b2108d609fae00af126 /Linux-PAM/doc/man/pam_get_user.3 | |
parent | a3ee6f5fc767b1b01568bce6dd31fc9ca932a8d2 (diff) | |
parent | 9727ff2a3fa0e94a42b34a579027bacf4146d571 (diff) | |
download | pam-26ee21df2a5fe63f08cfae8c7d35c24bd3dd4f04.tar.gz pam-26ee21df2a5fe63f08cfae8c7d35c24bd3dd4f04.tar.bz2 pam-26ee21df2a5fe63f08cfae8c7d35c24bd3dd4f04.zip |
merge upstream version 0.99.10.0
Diffstat (limited to 'Linux-PAM/doc/man/pam_get_user.3')
-rw-r--r-- | Linux-PAM/doc/man/pam_get_user.3 | 67 |
1 files changed, 37 insertions, 30 deletions
diff --git a/Linux-PAM/doc/man/pam_get_user.3 b/Linux-PAM/doc/man/pam_get_user.3 index f4ab776b..e4817865 100644 --- a/Linux-PAM/doc/man/pam_get_user.3 +++ b/Linux-PAM/doc/man/pam_get_user.3 @@ -1,22 +1,22 @@ .\" 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 +.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> +.\" Date: 02/04/2008 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual .\" -.TH "PAM_GET_USER" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_GET_USER" "3" "02/04/2008" "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 +pam_get_user - get user name .SH "SYNOPSIS" .sp .ft B .nf -#include <security/pam_modules.h> +#include <security/pam_modules\.h> .fi .ft .HP 17 @@ -26,32 +26,33 @@ pam_get_user \- get user name 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_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 +.sp +.RS 4 +\h'-04'\(bu\h'+03'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: " +argument passed to the function\. +.RE .sp +.RS 4 +\h'-04'\(bu\h'+03'What is returned by pam_get_item (pamh, PAM_USER_PROMPT, \.\.\. ); +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'The default prompt: "login: " .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 +\fI*user\fR\. Note, this memory should \fBnot\fR be -\fIfree()\fR'd or +\fIfree()\fR\'d or \fImodified\fR -by the module. +by the module\. .PP This function sets the \fIPAM_USER\fR @@ -59,17 +60,23 @@ item associated with the \fBpam_set_item\fR(3) and \fBpam_get_item\fR(3) -functions. +functions\. .SH "RETURN VALUES" -.TP 3n +.PP PAM_SUCCESS -User name was successful retrieved. -.TP 3n +.RS 4 +User name was successful retrieved\. +.RE +.PP PAM_SYSTEM_ERR -A NULL pointer was submitted. -.TP 3n +.RS 4 +A NULL pointer was submitted\. +.RE +.PP PAM_CONV_ERR -The conversation method supplied by the application failed to obtain the username. +.RS 4 +The conversation method supplied by the application failed to obtain the username\. +.RE .SH "SEE ALSO" .PP |