aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2020-03-04 12:50:44 +0100
committerAndreas Schneider <asn@samba.org>2020-03-19 12:43:28 +0100
commitead5fb506cd229ac592bbb3fc3339a3bba20b739 (patch)
tree4f11d1eba3adf2f2c66beee32904a186acc2b49e
parent00c1573119ca5eb909b800f4d85f939518e1e3a0 (diff)
downloadpam_wrapper-ead5fb506cd229ac592bbb3fc3339a3bba20b739.tar.gz
pam_wrapper-ead5fb506cd229ac592bbb3fc3339a3bba20b739.tar.xz
pam_wrapper-ead5fb506cd229ac592bbb3fc3339a3bba20b739.zip
doc: Add generated pam_chatty.8 man page
And install it. Signed-off-by: Bastien Nocera <hadess@hadess.net> Reviewed-by: Andreas Schneider <asn@samba.org> Reviewed-by: Ralph Boehme <slow@samba.org>
-rw-r--r--doc/CMakeLists.txt5
-rw-r--r--doc/pam_chatty.893
2 files changed, 98 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 21850a5..8a8e60a 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -9,6 +9,11 @@ install(FILES
${MAN_INSTALL_DIR}/man8)
install(FILES
+ pam_chatty.8
+ DESTINATION
+ ${MAN_INSTALL_DIR}/man8)
+
+install(FILES
pam_get_items.8
DESTINATION
${MAN_INSTALL_DIR}/man8)
diff --git a/doc/pam_chatty.8 b/doc/pam_chatty.8
new file mode 100644
index 0000000..89618cb
--- /dev/null
+++ b/doc/pam_chatty.8
@@ -0,0 +1,93 @@
+'\" t
+.\" Title: pam_chatty
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2020-03-05
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "PAM_CHATTY" "8" "2020\-03\-05" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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_chatty \- A PAM test module that generates PAM info and error messages\&.
+.SH "SYNOPSIS"
+.sp
+pam_chatty\&.so [\&...]
+.SH "DESCRIPTION"
+.sp
+The \fBpam_chatty\fR module makes it easy to replicate the behaviour of PAM modules that generate a lot of output, in order to ensure that PAM clients react as expected\&.
+.SH "IMPORTANT"
+.sp
+pam_chatty is a \fBtest tool\fR\&. It should be considered completely insecure and never used outside test environments! As you\(cqll see when reading description of the options, many of them don\(cqt make any sense in the real world and were added just to make tests possible\&.
+.sp
+The pam_chatty module generates a lot of PAM info and error output, when its authentication method is called, and then returns success\&.
+.SH "OPTIONS"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBnum_lines=NUMBER\fR
+\- the number of lines of messages to output, for each one of the enabled types of messages selected\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBerror\fR
+\- whether to output error level messages\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBinfo\fR
+\- whether to output info level messages\&.
+.RE
+.SH "MODULE TYPES PROVIDED"
+.sp
+Only the \fBauth\fR module type is supported\&.
+.SH "EXAMPLE"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+auth required pam_chatty\&.so num_lines=16 info error
+.fi
+.if n \{\
+.RE
+.\}