Add manpages; remove invariant sections from pam-modules.texi

10 files changed, 1642 insertions, 12 deletions

diff --git a/doc/.gitignore b/doc/.gitignore
index 3cc99a1..8ae6011 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1,5 +1,9 @@
 Makefile
 Makefile.in
+config.so
+pam_fshadow.8
+pam_mysql.8
+pam_pgsql.8
 pam-modules.info*
 stamp-vti
 version.texi
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 99ac7d5..76df136 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -16,9 +16,51 @@
 
 info_TEXINFOS=pam-modules.texi
 pam_modules_TEXINFOS=fdl.texi macros.texi
+dist_man_MANS = pamck.1
+
+if PAM_COND_FSHADOW
+  dist_man_MANS += pam_fshadow.8
+endif
+if PAM_COND_REGEX
+  dist_man_MANS += pam_regex.8
+endif
+if PAM_COND_LOG
+  dist_man_MANS += pam_log.8
+endif
+#if PAM_COND_LDAPHOME
+#  dist_man_MANS += pam_ldaphome.8
+#endif
+if PAM_COND_UMOTD
+  dist_man_MANS += pam_umotd.8
+endif
+if PAM_COND_MYSQL
+  dist_man_MANS += pam_mysql.8
+endif
+if PAM_COND_PGSQL
+  dist_man_MANS += pam_pgsql.8
+endif
+
+config.so: $(top_srcdir)/configure.ac $(top_srcdir)/doc/Makefile.am
+        $(AM_V_GEN){\
+                echo ".ds ET $(sysconfdir)"; \
+        } > config.so
+
+BUILD_MANS=pam_fshadow.8 pam_mysql.8 pam_pgsql.8
+CLEANFILES=$(BUILD_MANS) config.so
+
+pam_fshadow.8 pam_mysql.8 pam_pgsql.8: config.so
+
+.8in.8:
+        $(AM_V_GEN){\
+                echo '.\" -*- buffer-read-only: t -*- vi: set ro:';\
+                echo '.\" THIS FILE IS GENERATED AUTOMATICALLY; DO NOT EDIT!';\
+                soelim -I$(top_builddir)/doc $<;\
+        } > $@
 
 EXTRA_DIST = \
- gendocs_template
+ gendocs_template\
+ pam_fshadow.8in\
+ pam_mysql.8in
 
 clean-local:
         rm -rf manual
diff --git a/doc/pam-modules.texi b/doc/pam-modules.texi
index 7c2d881..35d31cb 100644
--- a/doc/pam-modules.texi
+++ b/doc/pam-modules.texi
@@ -46,15 +46,9 @@ Boston, MA 02110-1301, USA
 Copyright @copyright{} 2005, 2007-2012, 2014 Sergey Poznyakoff
 
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``PAM-modules Manual'',
-and with the Back-Cover Texts as in (a) below.  A copy of the license
-is included in the section entitled ``GNU Free Documentation License''.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
+Invariant Sections, and no special Front- or Back- Cover texts/
 @end copying
 
 @titlepage
@@ -219,7 +213,7 @@ from which the @code{PAM_RUSER} entity is requesting service).  That is
 user.  In some applications, @code{PAM_RHOST} may be @samp{NULL}.
 
 @item ruser
-@code{PAM_RUSER}.  The requesting entity: user's sername for a locally
+@code{PAM_RUSER}.  The requesting entity: user's name for a locally
 requesting user or a remote requesting user.  In some cases,
 @code{PAM_RUSER} may be @samp{NULL}.
 
@@ -496,7 +490,7 @@ This section summarizes all @command{pam_fshadow} command line options:
 options, nopasswd}.
 
 @opsummary{noshadow}
-@item nopasswd
+@item noshadow
    Use only @file{passwd} for authentication.  @xref{pam_fshadow common
 options, noshadow}.
 
@@ -939,7 +933,7 @@ algorithm name in curly braces.  This variable is @code{true} by
 default. 
 
 @kwindex allow-md5-pass, @command{pam_mysql} configuration keyword
-@item allow-md5l-pass @var{bool}
+@item allow-md5-pass @var{bool}
 The returned password may be encrypted using MySQL @code{md5}
 function.  This keyword is specific for @command{pam_mysql}.
 
diff --git a/doc/pam_fshadow.8in b/doc/pam_fshadow.8in
new file mode 100644
index 0000000..eb990d1
--- /dev/null
+++ b/doc/pam_fshadow.8in
@@ -0,0 +1,223 @@
+.\" This file is part of PAM-Modules -*- nroff -*-
+.\" Copyright (C) 2001-2014 Sergey Poznyakoff
+.\"
+.\" PAM-Modules is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" PAM-Modules is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with PAM-Modules.  If not, see <http://www.gnu.org/licenses/>.
+.so config.so
+.TH PAM_FSHADOW 8 "March 30, 2014" "PAM-MODULES" "Pam-Modules User Reference"
+.SH NAME
+pam_fshadow \- use alternative passwd and/or shadow files
+.SH SYNOPSIS
+.nh
+.na
+\fBpam_fshadow\fR\
+ [\fBbasic\fR|\fBextended\fR]\
+ [\fBignore\-case\fR|\fBicase\fR|\fBcase\fR]\
+ [\fBnopasswd\fR]\
+ [\fBnoshadow\fR]\
+ [\fBregex=\fIEXPR\fR]\
+ [\fBrevert\-index\fR]\
+ [\fBsysconfdir=\fIDIR\fR]\
+ [\fBuse_authtok\fR]\
+ [\fBdebug\fR[\fB=\fINUMBER\fR]]\
+ [\fBwaitdebug\fR]\
+ [\fBaudit\fR]
+.ad
+.hy
+.SH DESCRIPTION
+Authenticates the user against alternative \fBpasswd\fR and
+\fBshadow\fR files.  There are two operation modes:
+\fBplain\fR mode, in which the module uses only
+one \fBpasswd\fR,\fBshadow\fR pair, and \fBvirtual domain\fR mode,
+which selects the pair to use based depending on the authentication
+token (the user name).
+.PP
+In plain mode, \fBpam_fshadow\fR checks the supplied user name and
+authentication token against the \fBpasswd\fR and \fBshadow\fR files
+located in the system configuration directory.  The latter is set when
+configuring the package and defaults to \fB\*(ET\fR.  Its
+location can be changed using the \fBsysconfdir\fR command line
+parameter.
+.PP
+The command line options \fBnopasswd\fR and \fBnoshadow\fR are
+provided to disable reading of either file.  E.g. if \fBnoshadow\fR is
+given, the module will expect all authentication information to be
+stored in the \fBpasswd\fR file.
+.PP
+The \fBvirtual domain\fR mode select the \fBpasswd\fR,\fBshadow\fR
+pair to use depending on the user name.  To that effect, the user name
+is first split into the \fBlocal\fR and \fBauthentication domain\fR
+parts using a regular expression supplied with the \fBregex\fR option.
+The configuration directory name is then constructed by concatenating the
+system configuration directory, a directory separator character (\fB/\fR),
+and the name of the authentication domain.   The authentication then
+proceeds as described above for the plain mode.  If the supplied user name
+does not match the regular expression, \fBpam_fshadow\fR falls back to
+the plain mode.
+.SH OPTIONS
+.TP
+\fBbasic\fR
+The argument to the \fBregex\fR option is a basic regular expression. 
+.TP
+\fBextended\fR
+The argument to the \fBregex\fR option is a POSIX extended regular
+expression.  This is the default.
+.TP
+\fBignore\-case\fR, \fBicase\fR
+Use case-insensitive regex matching.
+.TP
+Use case-sensitive regex matching (default).
+.TP
+\fBnopasswd\fR
+Use only \fBshadow\fR file for authentication.
+.TP
+\fBnoshadow\fR
+Use only \fBpasswd\fR file for authentication.
+.TP
+\fBregex=\fIEXPR\fR
+Defines a regular expression for splitting user name into the proper
+name and authentication domain.  The expression must contain two