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_strerror.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_strerror.3.xml')
-rw-r--r-- | doc/man/pam_strerror.3.xml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/man/pam_strerror.3.xml b/doc/man/pam_strerror.3.xml new file mode 100644 index 00000000..bc488a21 --- /dev/null +++ b/doc/man/pam_strerror.3.xml @@ -0,0 +1,58 @@ +<?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_strerror'> + + <refmeta> + <refentrytitle>pam_strerror</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_strerror-name"> + <refname>pam_strerror</refname> + <refpurpose>return string describing PAM error code</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv id="pam_strerror-synopsis"> + <funcsynopsis> + <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo> + <funcprototype> + <funcdef>const char *<function>pam_strerror</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>int <parameter>errnum</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + + <refsect1 id="pam_strerror-description"> + <title>DESCRIPTION</title> + <para> + The <function>pam_strerror</function> function returns a pointer to + a string describing the error code passed in the argument + <emphasis>errnum</emphasis>, possibly using the LC_MESSAGES part of + the current locale to select the appropriate language. This string + must not be modified by the application. No library function will + modify this string. + </para> + </refsect1> + <refsect1 id="pam_strerror-return_values"> + <title>RETURN VALUES</title> + <para> + This function returns always a pointer to a string. + </para> + </refsect1> + + <refsect1 id="pam_strerror-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> |