diff options
author | Thorsten Kukuk <kukuk@thkukuk.de> | 2006-06-02 15:37:38 +0000 |
---|---|---|
committer | Thorsten Kukuk <kukuk@thkukuk.de> | 2006-06-02 15:37:38 +0000 |
commit | bad0ed8d159cb77466ed81a624355b1e80ead0dc (patch) | |
tree | c1115143eded6faa7e8fe0abc42fc50d4e28fe17 /doc/man/pam_get_user.3 | |
parent | 29a98911d9cb5e9187c1afe4e161c6861fac4f2b (diff) |
Relevant BUGIDs: 1427738
Purpose of commit: new feature/bugfix
Commit summary:
---------------
2006-06-02 Thorsten Kukuk <kukuk@thkukuk.de>
* doc/man/PAM.8: Regenerate with DocBook XSL Stylesheets v1.70.1.
* doc/man/pam.3: Likewise.
* doc/man/pam.conf.5: Likewise.
* doc/man/pam_acct_mgmt.3: Likewise.
* doc/man/pam_authenticate.3: Likewise.
* doc/man/pam_chauthtok.3: Likewise.
* doc/man/pam_close_session.3: Likewise.
* doc/man/pam_conv.3: Likewise.
* doc/man/pam_end.3: Likewise.
* doc/man/pam_error.3: Likewise.
* doc/man/pam_fail_delay.3: Likewise.
* doc/man/pam_get_data.3: Likewise.
* doc/man/pam_get_item.3: Likewise.
* doc/man/pam_get_user.3: Likewise.
* doc/man/pam_getenv.3: Likewise.
* doc/man/pam_getenvlist.3: Likewise.
* doc/man/pam_info.3: Likewise.
* doc/man/pam_open_session.3: Likewise.
* doc/man/pam_prompt.3: Likewise.
* doc/man/pam_putenv.3: Likewise.
* doc/man/pam_set_data.3: Likewise.
* doc/man/pam_set_item.3: Likewise.
* doc/man/pam_setcred.3: Likewise.
* doc/man/pam_sm_acct_mgmt.3: Likewise.
* doc/man/pam_start.3: Likewise.
* doc/man/pam_strerror.3: Likewise.
* doc/man/pam_syslog.3: Likewise.
* modules/pam_access/access.conf.5: Likewise.
* modules/pam_access/pam_access.8: Likewise.
* modules/pam_cracklib/pam_cracklib.8: Likewise.
* modules/pam_deny/pam_deny.8: Likewise.
* modules/pam_echo/pam_echo.8: Likewise.
* modules/pam_env/pam_env.8: Likewise.
* modules/pam_env/pam_env.conf.5: Likewise.
* modules/pam_exec/pam_exec.8: Likewise.
* modules/pam_filter/pam_filter.8: Likewise.
* modules/pam_ftp/pam_ftp.8: Likewise.
* modules/pam_group/group.conf.5: Likewise.
* modules/pam_group/pam_group.8: Likewise.
* modules/pam_issue/pam_issue.8: Likewise.
* modules/pam_lastlog/pam_lastlog.8: Likewise.
* modules/pam_mkhomedir/pam_mkhomedir.8: Likewise.
* modules/pam_succeed_if/pam_succeed_if.8: Likewise.
* modules/pam_umask/pam_umask.8: Likewise.
* modules/pam_unix/pam_unix_acct.c (pam_sm_acct_mgmt): Use
dngettext if available [#1427738].
* configure.in: Check for dngettext [#1427738].
* po/*.po: Update to dngettext usage.
* modules/pam_listfile/Makefile.am: Include Make.xml.rules.
* modules/pam_listfile/pam_listfile.8.xml: New.
* modules/pam_listfile/pam_listfile.8: New, generated from xml file.
* modules/pam_listfile/README.xml: New.
* modules/pam_listfile/README: Regenerated from xml file.
Diffstat (limited to 'doc/man/pam_get_user.3')
-rw-r--r-- | doc/man/pam_get_user.3 | 40 |
1 files changed, 25 insertions, 15 deletions
diff --git a/doc/man/pam_get_user.3 b/doc/man/pam_get_user.3 index c09108da..20d1017d 100644 --- a/doc/man/pam_get_user.3 +++ b/doc/man/pam_get_user.3 @@ -1,8 +1,11 @@ -.\" ** You probably do not want to edit this file directly ** -.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). -.\" Instead of manually editing it, you probably should edit the DocBook XML -.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "PAM_GET_USER" "3" "05/04/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" Title: pam_get_user +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 06/02/2006 +.\" Manual: Linux\-PAM Manual +.\" Source: Linux\-PAM Manual +.\" +.TH "PAM_GET_USER" "3" "06/02/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,10 +13,14 @@ .SH "NAME" pam_get_user \- get user name .SH "SYNOPSIS" -.PP -\fB#include <security/pam_modules.h>\fR +.sp +.ft B +.nf +#include <security/pam_modules.h> +.fi +.ft .HP 17 -\fBint\ \fBpam_get_user\fR\fR\fB(\fR\fBconst\ pam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBconst\ char\ **\fR\fB\fIuser\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIprompt\fR\fR\fB);\fR +.BI "int pam_get_user(const\ pam_handle_t\ *" "pamh" ", const\ char\ **" "user" ", const\ char\ *" "prompt" ");" .SH "DESCRIPTION" .PP The @@ -24,21 +31,23 @@ function returns the name of the user specified by 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 3 +.TP 3n \(bu The \fIprompt\fR argument passed to the function. -.TP +.TP 3n \(bu What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... ); -.TP +.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 -\fInot\fR +\fBnot\fR be \fIfree()\fR'd or \fImodified\fR @@ -52,17 +61,18 @@ and \fBpam_get_item\fR(3) functions. .SH "RETURN VALUES" -.TP +.TP 3n PAM_SUCCESS User name was successful retrieved. -.TP +.TP 3n PAM_SYSTEM_ERR A NULL pointer was submitted. -.TP +.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), |