Relevant BUGIDs:

Purpose of commit: cleanup

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

Merge manual pages and sgml docu as xml, update them.

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

        * configure.in: Add doc/man/Makefile.
        * Make.xml.rules: Enable xincludes for manual pages.
        * doc/Makefile.am (EXRA_DIST): Remove manual pages.
        (SUBDIR): Add man subdirectory.
        * doc/man/Makefile.am: New.
        * doc/man/pam_acct_mgmt.3: New.
        * doc/man/pam_acct_mgmt.3.xml: New.
        * doc/man/pam_get_data.3: New.
        * doc/man/pam_get_data.3.xml: New.
        * doc/man/pam_set_data.3: New.
        * doc/man/pam_set_data.3.xml: New.
        * doc/man/pam.8.xml: New.
        * doc/man/pam.8: Regenerated from xml file.
        * doc/man/pam_authenticate.3.xml: New.
        * doc/man/pam_authenticate.3: Regenerated from xml file.
        * doc/man/pam_chauthtok.3.xml: New.
        * doc/man/pam_chauthtok.3: Regenerated from xml file.
        * doc/man/pam_close_session.3.xml: New.
        * doc/man/pam_close_session.3: Regenerated from xml file.
        * doc/man/pam_end.3.xml: New.
        * doc/man/pam_end.3: Regenerated from xml file.
        * doc/man/pam_fail_delay.3.xml: New.
        * doc/man/pam_fail_delay.3: Regenerated from xml file.
        * doc/man/pam_get_item.3.xml: New.
        * doc/man/pam_get_item.3: Regenerated from xml file.
        * doc/man/pam_item_types.inc.xml: New.
        * doc/man/pam_open_session.3.xml: New.
        * doc/man/pam_open_session.3: Regenerated from xml file.
        * doc/man/pam_set_item.3.xml: New.
        * doc/man/pam_set_item.3: Regenerated from xml file.
        * doc/man/pam_setcred.3.xml: New.
        * doc/man/pam_setcred.3: Regenerated from xml file.
        * doc/man/pam_start.3.xml: New.
        * doc/man/pam_start.3: Regenerated from xml file.
        * doc/man/pam_strerror.3.xml: New.
        * doc/man/pam_strerror.3: Regenerated from xml file.
        * doc/man/template-man: Removed.

1 files changed, 115 insertions, 0 deletions

diff --git a/doc/man/pam_open_session.3.xml b/doc/man/pam_open_session.3.xml
new file mode 100644
index 00000000..3ae05877
--- /dev/null
+++ b/doc/man/pam_open_session.3.xml
@@ -0,0 +1,115 @@
+<?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_send'>
+
+  <refmeta>
+    <refentrytitle>pam_open_session</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_open_session-name">
+    <refname>pam_open_session</refname>
+    <refpurpose>start PAM session management</refpurpose>
+  </refnamediv>
+
+<!-- body begins here -->
+
+  <refsynopsisdiv id="pam_open_session-synopsis">
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
+      <funcprototype>
+        <funcdef>int <function>pam_open_session</function></funcdef>
+        <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
+        <paramdef>int <parameter>flags</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+
+  <refsect1 id="pam_open_session-description">
+    <title>DESCRIPTION</title>
+    <para>
+      The <function>pam_open_session</function> function sets up a
+      user session for a previously successful authenticated user.
+      The session should later be terminated with a call to
+      <citerefentry>
+        <refentrytitle>pam_close_session</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>.
+    </para>
+    <para>
+      It should be noted that the effective uid,
+      <citerefentry>
+        <refentrytitle>geteuid</refentrytitle><manvolnum>2</manvolnum>
+      </citerefentry>. of the application should be of sufficient
+      privilege to perform such tasks as creating or mounting the
+      user's home directory for example.
+    </para>
+    <para>
+      The flags argument is the binary or of zero or more of the
+      following values:
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_SILENT</term>
+        <listitem>
+           <para>
+             Do not emit any messages.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_open_session-return_values">
+    <title>RETURN VALUES</title>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_ABORT</term>
+        <listitem>
+           <para>
+              General failure.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_BUF_ERR</term>
+        <listitem>
+           <para>
+              Memory buffer error.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SESSION_ERR</term>
+        <listitem>
+           <para>
+             Session failure.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_SUCCESS</term>
+        <listitem>
+           <para>
+             Session was successful created.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_open_session-see_also">
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>pam_close_session</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+</refentry>