Relevant BUGIDs:

Purpose of commit: new feature

Commit summary:
---------------

2006-03-13  Thorsten Kukuk  <kukuk@thkukuk.de>

        * 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.

4 files changed, 183 insertions, 3 deletions

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 <security/pam_ext.h>\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 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+
+<refentry id="pam_error">
+
+  <refmeta>
+    <refentrytitle>pam_error</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_error-name">
+    <refname>pam_error</refname>
+    <refname>pam_verror</refname>
+    <refpurpose>display error messages to the user</refpurpose>
+  </refnamediv>
+
+<!-- body begins here -->
+
+  <refsynopsisdiv id="pam_error-synopsis">
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;security/pam_ext.h&gt;</funcsynopsisinfo>
+      <funcprototype>
+        <funcdef>int <function>pam_error</function></funcdef>
+        <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
+        <paramdef>const char *<parameter>fmt</parameter></paramdef>
+        <paramdef><parameter>...</parameter></paramdef>
+      </funcprototype>
+      <funcprototype>
+        <funcdef>int <function>pam_verror</function></funcdef>
+        <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
+        <paramdef>const char *<parameter>fmt</parameter></paramdef>
+        <paramdef>va_list <parameter>args</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='pam_error-description'>
+    <title>DESCRIPTION</title>
+    <para>
+      The <function>pam_error</function> function prints error messages
+      through the conversation function to the user.
+    </para>
+    <para>
+      The <function>pam_verror</function> function performs the same
+      task as <function>pam_error()</function> with the difference
+      that it takes a set of arguments which have been obtained using
+      the <citerefentry>
+        <refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry> variable argument list macros.
+    </para>
+  </refsect1>
+  <refsect1 id="pam_error-return_values">
+    <title>RETURN VALUES</title>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_BUF_ERR</term>
+        <listitem>
+           <para>
+              Memory buffer error.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_CONV_ERR</term>
+        <listitem>
+           <para>
+              Conversation failure.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SUCCESS</term>
+        <listitem>
+           <para>
+             Error message was displayed.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SYSTEM_ERR</term>
+        <listitem>
+           <para>
+              System error.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='pam_error-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>pam_info</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_vinfo</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_prompt</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_vprompt</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_error-standards'>
+    <title>STANDARDS</title>
+    <para>
+      The <function>pam_error</function> and <function>pam_verror</function>
+      functions are Linux-PAM extensions.
+    </para>
+  </refsect1>
+
+</refentry>
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