diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/pam_info.3 | 86 | ||||
| -rw-r--r-- | doc/man/pam_info.3.xml | 109 |
2 files changed, 195 insertions, 0 deletions
diff --git a/doc/man/pam_info.3 b/doc/man/pam_info.3 new file mode 100644 index 0000000..c6d175b --- /dev/null +++ b/doc/man/pam_info.3 @@ -0,0 +1,86 @@ +'\" t +.\" Title: pam_info +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 09/03/2021 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_INFO" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_info, pam_vinfo \- display messages to the user +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_ext\&.h> +.fi +.ft +.HP \w'int\ pam_info('u +.BI "int pam_info(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", " "\&.\&.\&." ");" +.HP \w'int\ pam_vinfo('u +.BI "int pam_vinfo(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", va_list\ " "args" ");" +.SH "DESCRIPTION" +.PP +The +\fBpam_info\fR +function prints messages through the conversation function to the user\&. +.PP +The +\fBpam_vinfo\fR +function performs the same task as +\fBpam_info()\fR +with the difference that it takes a set of arguments which have been obtained using the +\fBstdarg\fR(3) +variable argument list macros\&. +.SH "RETURN VALUES" +.PP +PAM_BUF_ERR +.RS 4 +Memory buffer error\&. +.RE +.PP +PAM_CONV_ERR +.RS 4 +Conversation failure\&. +.RE +.PP +PAM_SUCCESS +.RS 4 +Transaction was successful created\&. +.RE +.PP +PAM_SYSTEM_ERR +.RS 4 +System error\&. +.RE +.SH "SEE ALSO" +.PP +\fBpam\fR(8) +.SH "STANDARDS" +.PP +The +\fBpam_info\fR +and +\fBpam_vinfo\fR +functions are Linux\-PAM extensions\&. diff --git a/doc/man/pam_info.3.xml b/doc/man/pam_info.3.xml new file mode 100644 index 0000000..88e671c --- /dev/null +++ b/doc/man/pam_info.3.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!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_info"> + + <refmeta> + <refentrytitle>pam_info</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_info-name"> + <refname>pam_info</refname> + <refname>pam_vinfo</refname> + <refpurpose>display messages to the user</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv id="pam_info-synopsis"> + <funcsynopsis> + <funcsynopsisinfo>#include <security/pam_ext.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>pam_info</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char *<parameter>fmt</parameter></paramdef> + <paramdef><parameter>...</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>int <function>pam_vinfo</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char *<parameter>fmt</parameter></paramdef> + <paramdef>va_list <parameter>args</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1 id='pam_info-description'> + <title>DESCRIPTION</title> + <para> + The <function>pam_info</function> function prints messages + through the conversation function to the user. + </para> + <para> + The <function>pam_vinfo</function> function performs the same + task as <function>pam_info()</function> with the difference + that it takes a set of arguments which have been obtained using + the <citerefentry> + <refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> variable argument list macros. + </para> + </refsect1> + <refsect1 id="pam_info-return_values"> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_BUF_ERR</term> + <listitem> + <para> + Memory buffer error. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_CONV_ERR</term> + <listitem> + <para> + Conversation failure. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + Transaction was successful created. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_SYSTEM_ERR</term> + <listitem> + <para> + System error. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='pam_info-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> + + <refsect1 id='pam_info-standards'> + <title>STANDARDS</title> + <para> + The <function>pam_info</function> and <function>pam_vinfo</function> + functions are Linux-PAM extensions. + </para> + </refsect1> + +</refentry> |