granicus.if.org Git - linux-pam/blob - doc/man/pam_info.3.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="pam_info">
   6
   7   <refmeta>
   8     <refentrytitle>pam_info</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_info-name">
  14     <refname>pam_info</refname>
  15     <refname>pam_vinfo</refname>
  16     <refpurpose>display messages to the user</refpurpose>
  17   </refnamediv>
  18
  19 <!-- body begins here -->
  20
  21   <refsynopsisdiv id="pam_info-synopsis">
  22     <funcsynopsis>
  23       <funcsynopsisinfo>#include &lt;security/pam_ext.h&gt;</funcsynopsisinfo>
  24       <funcprototype>
  25         <funcdef>int <function>pam_info</function></funcdef>
  26         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  27         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  28         <paramdef><parameter>...</parameter></paramdef>
  29       </funcprototype>
  30       <funcprototype>
  31         <funcdef>int <function>pam_vinfo</function></funcdef>
  32         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  33         <paramdef>const char *<parameter>fmt</parameter></paramdef>
  34         <paramdef>va_list <parameter>args</parameter></paramdef>
  35       </funcprototype>
  36     </funcsynopsis>
  37   </refsynopsisdiv>
  38
  39   <refsect1 id='pam_info-description'>
  40     <title>DESCRIPTION</title>
  41     <para>
  42       The <function>pam_info</function> function prints messages
  43       through the conversation function to the user.
  44     </para>
  45     <para>
  46       The <function>pam_vinfo</function> function performs the same
  47       task as <function>pam_info()</function> with the difference
  48       that it takes a set of arguments which have been obtained using
  49       the <citerefentry>
  50         <refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum>
  51       </citerefentry> variable argument list macros.
  52     </para>
  53   </refsect1>
  54   <refsect1 id="pam_info-return_values">
  55     <title>RETURN VALUES</title>
  56     <variablelist>
  57       <varlistentry>
  58         <term>PAM_BUF_ERR</term>
  59         <listitem>
  60            <para>
  61               Memory buffer error.
  62           </para>
  63         </listitem>
  64       </varlistentry>
  65       <varlistentry>
  66         <term>PAM_CONV_ERR</term>
  67         <listitem>
  68            <para>
  69               Conversation failure.
  70           </para>
  71         </listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term>PAM_SUCCESS</term>
  75         <listitem>
  76            <para>
  77              Transaction was successful created.
  78           </para>
  79         </listitem>
  80       </varlistentry>
  81       <varlistentry>
  82         <term>PAM_SYSTEM_ERR</term>
  83         <listitem>
  84            <para>
  85               System error.
  86           </para>
  87         </listitem>
  88       </varlistentry>
  89     </variablelist>
  90   </refsect1>
  91
  92   <refsect1 id='pam_info-see_also'>
  93     <title>SEE ALSO</title>
  94     <para>
  95       <citerefentry>
  96         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  97       </citerefentry>
  98     </para>
  99   </refsect1>
 100
 101   <refsect1 id='pam_info-standards'>
 102     <title>STANDARDS</title>
 103     <para>
 104       The <function>pam_info</function> and <function>pam_vinfo</function>
 105       functions are Linux-PAM extensions.
 106     </para>
 107   </refsect1>
 108
 109 </refentry>