Relevant BUGIDs:

Purpose of commit: new feature

Commit summary:
---------------

2006-06-01  Thorsten Kukuk  <kukuk@thkukuk.de>

        * modules/pam_issue/Makefile.am: Include Make.xml.rules.
        * modules/pam_issue/pam_issue.8.xml: New.
        * modules/pam_issue/pam_issue.8: New, generated from xml file.
        * modules/pam_issue/README.xml: New.
        * modules/pam_issue/README: Regenerated from xml file.

        * modules/pam_filter/Makefile.am: Include Make.xml.rules.
        * modules/pam_filter/pam_filter.8.xml: New.
        * modules/pam_filter/pam_filter.8: New, generated from xml file.
        * modules/pam_filter/README.xml: New.
        * modules/pam_filter/README: Regenerated from xml file.

5 files changed, 465 insertions, 1 deletions

diff --git a/modules/pam_issue/Makefile.am b/modules/pam_issue/Makefile.am
index 8ad994a4..4e43bd05 100644
--- a/modules/pam_issue/Makefile.am
+++ b/modules/pam_issue/Makefile.am
@@ -4,7 +4,10 @@
 
 CLEANFILES = *~
 
-EXTRA_DIST = tst-pam_issue
+EXTRA_DIST = README $(MANS) $(XMLS) tst-pam_issue
+
+man_MANS = pam_issue.8
+XMLS = README.xml pam_issue.8.xml
 
 TESTS = tst-pam_issue
 
@@ -19,3 +22,10 @@ if HAVE_VERSIONING
 endif
 
 securelib_LTLIBRARIES = pam_issue.la
+
+if ENABLE_REGENERATE_MAN
+noinst_DATA = README
+README: pam_issue.8.xml
+-include $(top_srcdir)/Make.xml.rules
+endif
+
diff --git a/modules/pam_issue/README b/modules/pam_issue/README
new file mode 100644
index 00000000..e3192beb
--- /dev/null
+++ b/modules/pam_issue/README
@@ -0,0 +1,79 @@
+pam_issue — PAM module to add issue file to user prompt
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+DESCRIPTION
+
+pam_issue is a PAM module to prepend an issue file to the username prompt. It
+also by default parses escape codes in the issue file similar to some common
+getty's (using \x format).
+
+Recognized escapes:
+
+\d
+
+    current day
+
+\l
+
+    name of this tty
+
+\m
+
+    machine architecture (uname -m)
+
+\n
+
+    machine's network node hostname (uname -n)
+
+\o
+
+    domain name of this system
+
+\r
+
+    release number of operating system (uname -r)
+
+\t
+
+    current time
+
+\s
+
+    operating system name (uname -s)
+
+\u
+
+    number of users currently logged in
+
+\U
+
+    same as \u except it is suffixed with "user" or "users" (eg. "1 user" or
+    "10 users")
+
+\v
+
+    operating system version and build date (uname -v)
+
+OPTIONS
+
+noesc
+
+    Turns off escape code parsing.
+
+issue=issue-file-name
+
+    The file to output if not using the default.
+
+EXAMPLES
+
+Add the following line to /etc/pam.d/login to set the user specific issue at
+login:
+
+        auth optional pam_issue.so issue=/etc/issue
+
+
+AUTHOR
+
+pam_issue was written by Ben Collins <bcollins@debian.org>.
+
diff --git a/modules/pam_issue/README.xml b/modules/pam_issue/README.xml
new file mode 100644
index 00000000..b5b61c3a
--- /dev/null
+++ b/modules/pam_issue/README.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+[
+<!--
+<!ENTITY pamaccess SYSTEM "pam_issue.8.xml">
+-->
+]>
+
+<article>
+
+  <articleinfo>
+
+    <title>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_issue.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_issue-name"]/*)'/>
+    </title>
+
+  </articleinfo>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_issue.8.xml" xpointer='xpointer(//refsect1[@id = "pam_issue-description"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_issue.8.xml" xpointer='xpointer(//refsect1[@id = "pam_issue-options"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_issue.8.xml" xpointer='xpointer(//refsect1[@id = "pam_issue-examples"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_issue.8.xml" xpointer='xpointer(//refsect1[@id = "pam_issue-author"]/*)'/>
+  </section>
+
+</article>
diff --git a/modules/pam_issue/pam_issue.8 b/modules/pam_issue/pam_issue.8
new file mode 100644
index 00000000..467ae26b
--- /dev/null
+++ b/modules/pam_issue/pam_issue.8
@@ -0,0 +1,98 @@
+.\" ** 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_ISSUE" "8" "06/01/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_issue \- PAM module to add issue file to user prompt
+.SH "SYNOPSIS"
+.HP 13
+\fBpam_issue.so\fR [noesc] [issue=\fIissue\-file\-name\fR]
+.SH "DESCRIPTION"
+.PP
+pam_issue is a PAM module to prepend an issue file to the username prompt. It also by default parses escape codes in the issue file similar to some common getty's (using \\x format).
+.PP
+Recognized escapes:
+.TP
+\fI\\d\fR
+current day
+.TP
+\fI\\l\fR
+name of this tty
+.TP
+\fI\\m\fR
+machine architecture (uname \-m)
+.TP
+\fI\\n\fR
+machine's network node hostname (uname \-n)
+.TP
+\fI\\o\fR
+domain name of this system
+.TP
+\fI\\r\fR
+release number of operating system (uname \-r)
+.TP
+\fI\\t\fR
+current time
+.TP
+\fI\\s\fR
+operating system name (uname \-s)
+.TP
+\fI\\u\fR
+number of users currently logged in
+.TP
+\fI\\U\fR
+same as \\u except it is suffixed with "user" or "users" (eg. "1 user" or "10 users")
+.TP
+\fI\\v\fR
+operating system version and build date (uname \-v)
+.SH "OPTIONS"
+.PP
+.TP
+\fBnoesc\fR
+Turns off escape code parsing.
+.TP
+\fBissue=\fR\fB\fIissue\-file\-name\fR\fR
+The file to output if not using the default.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+Only the
+\fBauth\fR
+service is supported.
+.SH "RETURN VALUES"
+.PP
+.TP
+PAM_BUF_ERR
+Memory buffer error.
+.TP
+PAM_IGNORE
+The prompt was already changed.
+.TP
+PAM_SERVICE_ERR
+A service module error occured.
+.TP
+PAM_SUCCESS
+The new prompt was set successfull.
+.SH "EXAMPLES"
+.PP
+Add the following line to
+\fI/etc/pam.d/login\fR
+to set the user specific issue at login:
+.sp
+.nf
+        auth optional pam_issue.so issue=/etc/issue
+      
+.fi
+.sp
+.SH "SEE ALSO"
+.PP
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_issue was written by Ben Collins <bcollins@debian.org>.
diff --git a/modules/pam_issue/pam_issue.8.xml b/modules/pam_issue/pam_issue.8.xml
new file mode 100644
index 00000000..6b1cf4fd
--- /dev/null
+++ b/modules/pam_issue/pam_issue.8.xml
@@ -0,0 +1,236 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+
+<refentry id="pam_issue">
+
+  <refmeta>
+    <refentrytitle>pam_issue</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_issue-name">
+    <refname>pam_issue</refname>
+    <refpurpose>PAM module to add issue file to user prompt</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="pam_issue-cmdsynopsis">
+      <command>pam_issue.so</command>
+      <arg choice="opt">
+        noesc
+      </arg>
+      <arg choice="opt">
+        issue=<replaceable>issue-file-name</replaceable>
+      </arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id="pam_issue-description">
+
+    <title>DESCRIPTION</title>
+
+    <para>
+      pam_issue is a PAM module to prepend an issue file to the username
+      prompt. It also by default parses escape codes in the issue file
+      similar to some common getty's (using &bsol;x format).
+    </para>
+    <para>
+      Recognized escapes:
+    </para>
+    <variablelist remap='IP'>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;d</emphasis></term>
+        <listitem>
+          <para>current day</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;l</emphasis></term>
+        <listitem>
+          <para>name of this tty</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;m</emphasis></term>
+        <listitem>
+          <para>machine architecture (uname -m)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;n</emphasis></term>
+        <listitem>
+          <para>machine's network node hostname (uname -n)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;o</emphasis></term>
+        <listitem>
+          <para>domain name of this system</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;r</emphasis></term>
+        <listitem>
+          <para>release number of operating system (uname -r)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;t</emphasis></term>
+        <listitem>
+          <para>current time</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;s</emphasis></term>
+        <listitem>
+          <para>operating system name (uname -s)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;u</emphasis></term>
+        <listitem>
+          <para>number of users currently logged in</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;U</emphasis></term>
+        <listitem>
+          <para>
+            same as &bsol;u except it is suffixed with "user" or
+            "users" (eg. "1 user" or "10 users")
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis remap='B'>&bsol;v</emphasis></term>
+        <listitem>
+          <para>operating system version and build date (uname -v)</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1 id="pam_issue-options">
+
+    <title>OPTIONS</title>
+    <para>
+      <variablelist>
+
+        <varlistentry>
+          <term>
+            <option>noesc</option>
+          </term>
+          <listitem>
+            <para>
+              Turns off escape code parsing.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>
+            <option>issue=<replaceable>issue-file-name</replaceable></option>
+          </term>
+          <listitem>
+            <para>
+              The file to output if not using the default.
+            </para>
+          </listitem>
+	</varlistentry>
+
+      </variablelist>
+
+    </para>
+  </refsect1>
+
+  <refsect1 id="pam_issue-services">
+    <title>MODULE SERVICES PROVIDED</title>
+    <para>
+      Only the <option>auth</option> service is supported.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_issue-return_values'>
+    <title>RETURN VALUES</title>
+    <para>
+      <variablelist>
+
+        <varlistentry>
+          <term>PAM_BUF_ERR</term>
+          <listitem>
+             <para>
+               Memory buffer error.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>PAM_IGNORE</term>
+          <listitem>
+            <para>
+              The prompt was already changed.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>PAM_SERVICE_ERR</term>
+          <listitem>
+            <para>
+	      A service module error occured.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>PAM_SUCCESS</term>
+          <listitem>
+            <para>
+              The new prompt was set successfull.
+            </para>
+          </listitem>
+        </varlistentry>
+
+      </variablelist>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_issue-examples'>
+    <title>EXAMPLES</title>
+    <para>
+      Add the following line to <filename>/etc/pam.d/login</filename> to
+      set the user specific issue at login:
+      <programlisting>
+        auth optional pam_issue.so issue=/etc/issue
+      </programlisting>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_issue-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+	<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>pam.d</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_issue-author'>
+    <title>AUTHOR</title>
+      <para>
+        pam_issue was written by Ben Collins &lt;bcollins@debian.org&gt;.
+      </para>
+  </refsect1>
+
+</refentry>
+<!-- vim: sw=2
+-->