From bd940ba3beea685e297144705bc3d7547e81b837 Mon Sep 17 00:00:00 2001 From: Thorsten Kukuk Date: Sat, 11 Mar 2006 10:00:46 +0000 Subject: Relevant BUGIDs: none Purpose of commit: new feature Commit summary: --------------- 2006-03-11 Thorsten Kukuk * doc/man/pam_fail_delay.3.xml: New. * doc/man/pam_fail_delay.3: New, generated from xml. * doc/man/pam_prompt.3.xml: New. * doc/man/pam_prompt.3: New, generated from xml. * doc/man/pam_syslog.3.xml: New. * doc/man/pam_syslog.3: New, generated from xml. * doc/man/pam_vprompt.3: New, generated from xml. * doc/man/pam_vsyslog.3: New, generated from xml. --- doc/man/Makefile.am | 9 ++-- doc/man/pam_fail_delay.3 | 20 +++++--- doc/man/pam_fail_delay.3.xml | 36 +++++++++++--- doc/man/pam_prompt.3 | 47 ++++++++++++++++++ doc/man/pam_prompt.3.xml | 110 +++++++++++++++++++++++++++++++++++++++++++ doc/man/pam_syslog.3 | 49 +++++++++++++++++++ doc/man/pam_syslog.3.xml | 82 ++++++++++++++++++++++++++++++++ doc/man/pam_vprompt.3 | 1 + doc/man/pam_vsyslog.3 | 1 + 9 files changed, 339 insertions(+), 16 deletions(-) create mode 100644 doc/man/pam_prompt.3 create mode 100644 doc/man/pam_prompt.3.xml create mode 100644 doc/man/pam_syslog.3 create mode 100644 doc/man/pam_syslog.3.xml create mode 100644 doc/man/pam_vprompt.3 create mode 100644 doc/man/pam_vsyslog.3 (limited to 'doc/man') diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 83d1eec5..84f93e62 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -13,8 +13,10 @@ man_MANS = pam.8 pam.conf.5 pam.d.5 \ pam_fail_delay.3 \ pam_get_data.3 pam_get_item.3 pam_get_user.3 \ pam_open_session.3 \ - pam_set_data.3 pam_set_item.3 \ - pam_setcred.3 pam_start.3 pam_strerror.3 + pam_prompt.3 \ + pam_set_data.3 pam_set_item.3 pam_syslog.3 \ + pam_setcred.3 pam_start.3 pam_strerror.3 \ + pam_vprompt.3 pam_vsyslog.3 XMLS = pam.8.xml \ pam_acct_mgmt.3.xml pam_authenticate.3.xml \ pam_chauthtok.3.xml pam_close_session.3.xml \ @@ -22,7 +24,8 @@ XMLS = pam.8.xml \ pam_fail_delay.3.xml \ pam_get_data.3.xml pam_get_item.3.xml pam_get_user.3.xml \ pam_open_session.3.xml \ - pam_set_data.3.xml pam_set_item.3.xml \ + pam_prompt.3.xml \ + pam_set_data.3.xml pam_set_item.3.xml pam_syslog.3.xml \ pam_setcred.3.xml pam_start.3.xml pam_strerror.3.xml \ pam_item_types.inc.xml diff --git a/doc/man/pam_fail_delay.3 b/doc/man/pam_fail_delay.3 index 8e1cd09d..793c60de 100644 --- a/doc/man/pam_fail_delay.3 +++ b/doc/man/pam_fail_delay.3 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "PAM_FAIL_DELAY" "3" "02/12/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_FAIL_DELAY" "3" "02/20/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -95,14 +95,20 @@ module #2: pam_fail_delay (pamh, 4000000); .fi .PP in this case, it is the largest requested value that is used to compute the actual failed delay: here between 3 and 5 seconds. -.SH "RETURN VALUE" -.PP -Following a successful call to -\fBpam_fail_delay\fR(3), -\fIPAM_SUCCESS\fR -is returned. All other returns should be considered serious failures. +.SH "RETURN VALUES" +.TP +PAM_SUCCESS +Delay was successful adjusted. +.TP +PAM_SYSTEM_ERR +A NULL pointer was submitted as PAM handle. .SH "SEE ALSO" .PP \fBpam_start\fR(3), \fBpam_get_item\fR(3), \fBpam_strerror\fR(3) +.SH "STANDARDS" +.PP +The +\fBpam_fail_delay\fR +function is an Linux\-PAM extension. diff --git a/doc/man/pam_fail_delay.3.xml b/doc/man/pam_fail_delay.3.xml index 86d1fff4..459fda83 100644 --- a/doc/man/pam_fail_delay.3.xml +++ b/doc/man/pam_fail_delay.3.xml @@ -151,12 +151,27 @@ module #2: pam_fail_delay (pamh, 4000000); -RETURN VALUE -Following a successful call to -pam_fail_delay3, PAM_SUCCESS -is returned. All other returns should be considered serious failures. - - + + RETURN VALUES + + + PAM_SUCCESS + + + Delay was successful adjusted. + + + + + PAM_SYSTEM_ERR + + + A NULL pointer was submitted as PAM handle. + + + + + SEE ALSO @@ -172,4 +187,13 @@ is returned. All other returns should be considered serious failures. + + + STANDARDS + + The pam_fail_delay function is an + Linux-PAM extension. + + + diff --git a/doc/man/pam_prompt.3 b/doc/man/pam_prompt.3 new file mode 100644 index 00000000..647c3450 --- /dev/null +++ b/doc/man/pam_prompt.3 @@ -0,0 +1,47 @@ +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "PAM_PROMPT" "3" "02/20/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_prompt, pam_vprompt \- interface to conversation function +.SH "SYNOPSIS" +.PP +\fB#include \fR +.HP 16 +\fBvoid\ \fBpam_prompt\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIstyle\fR\fR\fB, \fR\fBchar\ **\fR\fB\fIresponse\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fB\fI...\fR\fR\fB);\fR +.HP 17 +\fBvoid\ \fBpam_vprompt\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIstyle\fR\fR\fB, \fR\fBchar\ **\fR\fB\fIresponse\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fBva_list\ \fR\fB\fIargs\fR\fR\fB);\fR +.SH "DESCRIPTION" +.PP +The +\fBpam_prompt\fR +function constructs a message from the specified format string and arguments and passes it to +.SH "RETURN VALUES" +.TP +PAM_BUF_ERR +Memory buffer error. +.TP +PAM_CONV_ERR +Conversation failure. +.TP +PAM_SUCCESS +Transaction was successful created. +.TP +PAM_SYSTEM_ERR +System error. +.SH "SEE ALSO" +.PP +\fBpam\fR(8), +\fBpam_conv\fR(3) +.SH "STANDARDS" +.PP +The +\fBpam_prompt\fR +and +\fBpam_vprompt\fR +functions are Linux\-PAM extensions. diff --git a/doc/man/pam_prompt.3.xml b/doc/man/pam_prompt.3.xml new file mode 100644 index 00000000..2c436f19 --- /dev/null +++ b/doc/man/pam_prompt.3.xml @@ -0,0 +1,110 @@ + + + + + + + pam_prompt + 3 + Linux-PAM Manual + + + + pam_prompt + pam_vprompt + interface to conversation function + + + + + + + #include <security/pam_ext.h> + + void pam_prompt + pam_handle_t *pamh + int style + char **response + const char *fmt + ... + + + void pam_vprompt + pam_handle_t *pamh + int style + char **response + const char *fmt + va_list args + + + + + + DESCRIPTION + + The pam_prompt function constructs a message + from the specified format string and arguments and passes it to + + + + + RETURN VALUES + + + PAM_BUF_ERR + + + Memory buffer error. + + + + + PAM_CONV_ERR + + + Conversation failure. + + + + + PAM_SUCCESS + + + Transaction was successful created. + + + + + PAM_SYSTEM_ERR + + + System error. + + + + + + + + + SEE ALSO + + + pam8 + , + + pam_conv3 + + + + + + STANDARDS + + The pam_prompt and pam_vprompt + functions are Linux-PAM extensions. + + + + diff --git a/doc/man/pam_syslog.3 b/doc/man/pam_syslog.3 new file mode 100644 index 00000000..0319e6f5 --- /dev/null +++ b/doc/man/pam_syslog.3 @@ -0,0 +1,49 @@ +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "PAM_SYSLOG" "3" "02/20/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_syslog, pam_vsyslog \- send messages to the system logger +.SH "SYNOPSIS" +.PP +\fB#include \fR +.PP +\fB#include \fR +.HP 16 +\fBvoid\ \fBpam_syslog\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIpriority\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fB\fI...\fR\fR\fB);\fR +.HP 17 +\fBvoid\ \fBpam_vsyslog\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIpriority\fR\fR\fB, \fR\fBconst\ char\ *\fR\fB\fIfmt\fR\fR\fB, \fR\fBva_list\ \fR\fB\fIargs\fR\fR\fB);\fR +.SH "DESCRIPTION" +.PP +The +\fBpam_syslog\fR +function logs messages using +\fBsyslog\fR(3) +and is intended for internal use by Linux\-PAM and PAM service modules. The +\fIpriority\fR +argument is formed by ORing the facility and the level values as documented in the +\fBsyslog\fR(3) +manual page. +.PP +The +\fBpam_vsyslog\fR +function performs the same task as +\fBpam_syslog()\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 "SEE ALSO" +.PP +\fBpam\fR(8) +.SH "STANDARDS" +.PP +The +\fBpam_syslog\fR +and +\fBpam_vsyslog\fR +functions are Linux\-PAM extensions. diff --git a/doc/man/pam_syslog.3.xml b/doc/man/pam_syslog.3.xml new file mode 100644 index 00000000..5b2f949b --- /dev/null +++ b/doc/man/pam_syslog.3.xml @@ -0,0 +1,82 @@ + + + + + + + pam_syslog + 3 + Linux-PAM Manual + + + + pam_syslog + pam_vsyslog + send messages to the system logger + + + + + + + #include <syslog.h> + #include <security/pam_ext.h> + + void pam_syslog + pam_handle_t *pamh + int priority + const char *fmt + ... + + + void pam_vsyslog + pam_handle_t *pamh + int priority + const char *fmt + va_list args + + + + + + DESCRIPTION + + The pam_syslog function logs messages using + + syslog3 + and is intended for internal use by Linux-PAM and + PAM service modules. The priority argument is + formed by ORing the facility and the level values as documented + in the + syslog3 + manual page. + + + The pam_vsyslog function performs the same + task as pam_syslog() with the difference + that it takes a set of arguments which have been obtained using + the + stdarg3 + variable argument list macros. + + + + + SEE ALSO + + + pam8 + + + + + + STANDARDS + + The pam_syslog and pam_vsyslog + functions are Linux-PAM extensions. + + + + diff --git a/doc/man/pam_vprompt.3 b/doc/man/pam_vprompt.3 new file mode 100644 index 00000000..bba0b1d3 --- /dev/null +++ b/doc/man/pam_vprompt.3 @@ -0,0 +1 @@ +.so man3/pam_prompt.3 diff --git a/doc/man/pam_vsyslog.3 b/doc/man/pam_vsyslog.3 new file mode 100644 index 00000000..b987b067 --- /dev/null +++ b/doc/man/pam_vsyslog.3 @@ -0,0 +1 @@ +.so man3/pam_syslog.3 -- cgit v1.2.3