diff options
author | Thorsten Kukuk <kukuk@thkukuk.de> | 2006-02-12 22:24:34 +0000 |
---|---|---|
committer | Thorsten Kukuk <kukuk@thkukuk.de> | 2006-02-12 22:24:34 +0000 |
commit | f7827ccfd255e23f285eb8aec7ddf71af94dd6ff (patch) | |
tree | 171eea4e7e13be3c8e5d2c4748db91b4244782bf /doc/man/pam_get_data.3.xml | |
parent | 2c388144eb7c68aa31c20c00f6c054c219bf72a2 (diff) |
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.
Diffstat (limited to 'doc/man/pam_get_data.3.xml')
-rw-r--r-- | doc/man/pam_get_data.3.xml | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/man/pam_get_data.3.xml b/doc/man/pam_get_data.3.xml new file mode 100644 index 00000000..d0c77321 --- /dev/null +++ b/doc/man/pam_get_data.3.xml @@ -0,0 +1,108 @@ +<?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_get_data'> + + <refmeta> + <refentrytitle>pam_get_data</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id='pam_get_data-name'> + <refname>pam_get_data</refname> + <refpurpose> + get module internal data + </refpurpose> + </refnamediv> + + +<!-- body begins here --> + + <refsynopsisdiv> + + <funcsynopsis id="pam_get_data-synopsis"> + <funcsynopsisinfo>#include <security/pam_modules.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>pam_get_data</function></funcdef> + <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char *<parameter>module_data_name</parameter></paramdef> + <paramdef>const void **<parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + + </refsynopsisdiv> + + + <refsect1 id="pam_get_data-description"> + <title>DESCRIPTION</title> + <para> + This function together with the + <citerefentry> + <refentrytitle>pam_set_data</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function + is useful to manage module-specific data meaningful only to + the calling PAM module. + </para> + <para> + The <function>pam_get_data</function> function looks up the + object associated with the (hopefully) unique string + <emphasis>module_data_name</emphasis> in the PAM context + specified by the <emphasis>pamh</emphasis> argument. + A successful call to + <function>pam_get_data</function> will result in + <emphasis>data</emphasis> pointing to the object. Note, + this data is <emphasis>not</emphasis> a copy and should be + treated as <emphasis>constant</emphasis> by the module. + </para> + </refsect1> + + <refsect1 id="pam_get_data-return_values"> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + Data was successful retrieved. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_SYSTEM_ERR</term> + <listitem> + <para> + A NULL pointer was submitted as PAM handle or the + function was called by an application. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_NO_MODULE_DATA</term> + <listitem> + <para> + Module data not found or there is an entry, but it has + the value NULL. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="pam_get_data-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_set_data</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> + </para> + </refsect1> + +</refentry> |