From 7eab0d473305400533dc6536c346b71c514eedfc Mon Sep 17 00:00:00 2001 From: Thorsten Kukuk Date: Mon, 13 Mar 2006 19:34:17 +0000 Subject: Relevant BUGIDs: Purpose of commit: new feature Commit summary: --------------- 2006-03-13 Thorsten Kukuk * doc/man/pam_error.3.xml: New. * doc/man/pam_error.3: New, generated from XML file. * doc/man/pam_verror.3: New, generated from XML file. * doc/man/Makefile.am: Add pam_error.3 and pam_verror.3. --- ChangeLog | 5 ++ doc/man/Makefile.am | 6 +-- doc/man/pam_error.3 | 58 +++++++++++++++++++++++ doc/man/pam_error.3.xml | 121 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/man/pam_verror.3 | 1 + 5 files changed, 188 insertions(+), 3 deletions(-) create mode 100644 doc/man/pam_error.3 create mode 100644 doc/man/pam_error.3.xml create mode 100644 doc/man/pam_verror.3 diff --git a/ChangeLog b/ChangeLog index 586b88fa..d06a7845 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2006-03-13 Thorsten Kukuk + * doc/man/pam_error.3.xml: New. + * doc/man/pam_error.3: New, generated from XML file. + * doc/man/pam_verror.3: New, generated from XML file. + * doc/man/Makefile.am: Add pam_error.3 and pam_verror.3. + * modules/pam_lastlog/Makefile.am: Fix typo. * modules/pam_lastlog/pam_lastlog.c: Move comment for diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 6676d8a3..37be6cd9 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -9,7 +9,7 @@ EXTRA_DIST = $(MANS) $(XMLS) man_MANS = PAM.8 pam.8 pam.conf.5 pam.d.5 \ pam_acct_mgmt.3 pam_authenticate.3 \ pam_chauthtok.3 pam_close_session.3 pam_conv.3 \ - pam_end.3 \ + pam_end.3 pam_error.3 \ pam_fail_delay.3 \ pam_get_data.3 pam_get_item.3 pam_get_user.3 pam_getenv.3 \ pam_getenvlist.3 \ @@ -18,11 +18,11 @@ man_MANS = PAM.8 pam.8 pam.conf.5 pam.d.5 \ pam_prompt.3 pam_putenv.3 \ pam_set_data.3 pam_set_item.3 pam_syslog.3 \ pam_setcred.3 pam_start.3 pam_strerror.3 \ - pam_vinfo.3 pam_vprompt.3 pam_vsyslog.3 + pam_verror.3 pam_vinfo.3 pam_vprompt.3 pam_vsyslog.3 XMLS = pam.8.xml \ pam_acct_mgmt.3.xml pam_authenticate.3.xml \ pam_chauthtok.3.xml pam_close_session.3.xml pam_conv.3.xml \ - pam_end.3.xml \ + pam_end.3.xml pam_error.3.xml \ pam_fail_delay.3.xml \ pam_get_data.3.xml pam_get_item.3.xml pam_get_user.3.xml \ pam_getenv.3.xml pam_getenvlist.3.xml \ diff --git a/doc/man/pam_error.3 b/doc/man/pam_error.3 new file mode 100644 index 00000000..5579fcdc --- /dev/null +++ b/doc/man/pam_error.3 @@ -0,0 +1,58 @@ +.\" ** 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_ERROR" "3" "03/13/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_error, pam_verror \- display error messages to the user +.SH "SYNOPSIS" +.PP +\fB#include \fR +.HP 14 +\fBint\ \fBpam_error\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fB\fI...\fR\fR\fB);\fR +.HP 15 +\fBint\ \fBpam_verror\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fBva_list\ \fR\fB\fIargs\fR\fR\fB);\fR +.SH "DESCRIPTION" +.PP +The +\fBpam_error\fR +function prints error messages through the conversation function to the user. +.PP +The +\fBpam_verror\fR +function performs the same task as +\fBpam_error()\fR +with the difference that it takes a set of arguments which have been obtained using the +\fBstdarg\fR(3) +variable argument list macros. +.SH "RETURN VALUES" +.TP +PAM_BUF_ERR +Memory buffer error. +.TP +PAM_CONV_ERR +Conversation failure. +.TP +PAM_SUCCESS +Error message was displayed. +.TP +PAM_SYSTEM_ERR +System error. +.SH "SEE ALSO" +.PP +\fBpam_info\fR(3), +\fBpam_vinfo\fR(3), +\fBpam_prompt\fR(3), +\fBpam_vprompt\fR(3), +\fBpam\fR(8) +.SH "STANDARDS" +.PP +The +\fBpam_error\fR +and +\fBpam_verror\fR +functions are Linux\-PAM extensions. diff --git a/doc/man/pam_error.3.xml b/doc/man/pam_error.3.xml new file mode 100644 index 00000000..e44f285a --- /dev/null +++ b/doc/man/pam_error.3.xml @@ -0,0 +1,121 @@ + + + + + + + pam_error + 3 + Linux-PAM Manual + + + + pam_error + pam_verror + display error messages to the user + + + + + + + #include <security/pam_ext.h> + + int pam_error + pam_handle_t *pamh + const char *fmt + ... + + + int pam_verror + pam_handle_t *pamh + const char *fmt + va_list args + + + + + + DESCRIPTION + + The pam_error function prints error messages + through the conversation function to the user. + + + The pam_verror function performs the same + task as pam_error() with the difference + that it takes a set of arguments which have been obtained using + the + stdarg3 + variable argument list macros. + + + + RETURN VALUES + + + PAM_BUF_ERR + + + Memory buffer error. + + + + + PAM_CONV_ERR + + + Conversation failure. + + + + + PAM_SUCCESS + + + Error message was displayed. + + + + + PAM_SYSTEM_ERR + + + System error. + + + + + + + + SEE ALSO + + + pam_info3 + , + + pam_vinfo3 + , + + pam_prompt3 + , + + pam_vprompt3 + , + + pam8 + + + + + + STANDARDS + + The pam_error and pam_verror + functions are Linux-PAM extensions. + + + + diff --git a/doc/man/pam_verror.3 b/doc/man/pam_verror.3 new file mode 100644 index 00000000..6e052ef6 --- /dev/null +++ b/doc/man/pam_verror.3 @@ -0,0 +1 @@ +.so man3/pam_error.3 -- cgit v1.2.3