Relevant BUGIDs:

Purpose of commit: new feature

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

More manual pages

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

        * doc/man/Makefile.am: Add new manual pages.

        * doc/man/pam.conf.5.xml: Replace link with content
        of PAM admin guide.
        * doc/man/pam.conf.5: Regenerated from XML file.

        * doc/man/pam_info.3.xml: New.
        * doc/man/pam_info.3: New, generated from XML file.
        * doc/man/pam_vinfo.3: New, generated from XML file.

        * doc/man/pam_conv.3.xml: New.
        * doc/man/pam_conv.3: New, generated from XML file.

        * doc/man/pam_putenv.3.xml: New.
        * doc/man/pam_putenv.3: New, generated from XML file.

        * doc/man/pam_getenv.3.xml: New.
        * doc/man/pam_getenv.3: New, generated from XML file.

        * doc/man/pam_getenvlist.3.xml: New.
        * doc/man/pam_getenvlist.3: New, generated from XML file.

1 files changed, 66 insertions, 0 deletions

diff --git a/doc/man/pam_getenv.3.xml b/doc/man/pam_getenv.3.xml
new file mode 100644
index 00000000..746fad01
--- /dev/null
+++ b/doc/man/pam_getenv.3.xml
@@ -0,0 +1,66 @@
+<?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_getenv'>
+  <refmeta>
+    <refentrytitle>pam_getenv</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_getenv-name">
+    <refname>pam_getenv</refname>
+    <refpurpose>get a PAM environment variable</refpurpose>
+  </refnamediv>
+
+<!-- body begins here -->
+
+  <refsynopsisdiv id='pam_getenv-synopsis'>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
+      <funcprototype>
+        <funcdef>const char *<function>pam_getenv</function></funcdef>
+        <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
+        <paramdef>const char *<parameter>name</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+
+  <refsect1 id='pam_getenv-description'>
+    <title>DESCRIPTION</title>
+    <para>
+      The <function>pam_getenv</function> function searches the
+      PAM environment list as associated with the handle
+      <emphasis>pamh</emphasis> for a string that matches the string
+      pointed to by <emphasis>name</emphasis>. The return values are
+      of the form: "<emphasis>name=value</emphasis>".
+    </para>
+  </refsect1>
+
+  <refsect1 id="pam_getenv-return_values">
+    <title>RETURN VALUES</title>
+    <para>
+      The <function>pam_getenv</function> function returns NULL
+      on failure.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_getenv-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+</refentry>