Relevant BUGIDs:

Purpose of commit: new feature

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

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

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

5 files changed, 253 insertions, 1 deletions

diff --git a/modules/pam_motd/Makefile.am b/modules/pam_motd/Makefile.am
index 21dfc245..d6e1bafa 100644
--- a/modules/pam_motd/Makefile.am
+++ b/modules/pam_motd/Makefile.am
@@ -4,7 +4,10 @@
 
 CLEANFILES = *~
 
-EXTRA_DIST = tst-pam_motd
+EXTRA_DIST = README $(MANS) $(XMLS) tst-pam_motd
+
+man_MANS = pam_motd.8
+XMLS = README.xml pam_motd.8.xml
 
 TESTS = tst-pam_motd
 
@@ -19,3 +22,10 @@ if HAVE_VERSIONING
 endif
 
 securelib_LTLIBRARIES = pam_motd.la
+
+if ENABLE_REGENERATE_MAN
+noinst_DATA = README
+README: pam_motd.8.xml
+-include $(top_srcdir)/Make.xml.rules
+endif
+
diff --git a/modules/pam_motd/README b/modules/pam_motd/README
new file mode 100644
index 00000000..74947dac
--- /dev/null
+++ b/modules/pam_motd/README
@@ -0,0 +1,27 @@
+pam_motd — Display the motd file
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+DESCRIPTION
+
+pam_motd is a PAM module that can be used to display arbitrary motd (message of
+the day) files after a succesful login. By default the /etc/motd file is shown.
+The message size is limited to 64KB.
+
+OPTIONS
+
+motd=/path/filename
+
+    The /path/filename file is displayed as message of the day.
+
+EXAMPLES
+
+The suggested usage for /etc/pam.d/login is:
+
+session  optoinal  pam_motd.so  motd=/etc/motd
+
+
+AUTHOR
+
+pam_motd was written by Ben Collins <bcollins@debian.org>.
+
diff --git a/modules/pam_motd/README.xml b/modules/pam_motd/README.xml
new file mode 100644
index 00000000..779e4d17
--- /dev/null
+++ b/modules/pam_motd/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_motd.8.xml">
+-->
+]>
+
+<article>
+
+  <articleinfo>
+
+    <title>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_motd.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_motd-name"]/*)'/>
+    </title>
+
+  </articleinfo>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_motd.8.xml" xpointer='xpointer(//refsect1[@id = "pam_motd-description"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_motd.8.xml" xpointer='xpointer(//refsect1[@id = "pam_motd-options"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_motd.8.xml" xpointer='xpointer(//refsect1[@id = "pam_motd-examples"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_motd.8.xml" xpointer='xpointer(//refsect1[@id = "pam_motd-author"]/*)'/>
+  </section>
+
+</article>
diff --git a/modules/pam_motd/pam_motd.8 b/modules/pam_motd/pam_motd.8
new file mode 100644
index 00000000..62fad5bc
--- /dev/null
+++ b/modules/pam_motd/pam_motd.8
@@ -0,0 +1,60 @@
+.\"     Title: pam_motd
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 06/03/2006
+.\"    Manual: Linux\-PAM Manual
+.\"    Source: Linux\-PAM Manual
+.\"
+.TH "PAM_MOTD" "8" "06/03/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_motd \- Display the motd file
+.SH "SYNOPSIS"
+.HP 12
+\fBpam_motd.so\fR [motd=\fI/path/filename\fR]
+.SH "DESCRIPTION"
+.PP
+pam_motd is a PAM module that can be used to display arbitrary motd (message of the day) files after a succesful login. By default the
+\fI/etc/motd\fR
+file is shown. The message size is limited to 64KB.
+.SH "OPTIONS"
+.TP 3n
+\fBmotd=\fR\fB\fI/path/filename\fR\fR
+The
+\fI/path/filename\fR
+file is displayed as message of the day.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+Only the
+\fBsession\fR
+service is supported.
+.SH "RETURN VALUES"
+.TP 3n
+PAM_IGNORE
+This is the only return value of this module.
+.SH "EXAMPLES"
+.PP
+The suggested usage for
+\fI/etc/pam.d/login\fR
+is:
+.sp
+.RS 3n
+.nf
+session  optoinal  pam_motd.so  motd=/etc/motd
+      
+.fi
+.RE
+.sp
+.SH "SEE ALSO"
+.PP
+
+\fBmotd\fR(5),
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_motd was written by Ben Collins <bcollins@debian.org>.
diff --git a/modules/pam_motd/pam_motd.8.xml b/modules/pam_motd/pam_motd.8.xml
new file mode 100644
index 00000000..3b60a96b
--- /dev/null
+++ b/modules/pam_motd/pam_motd.8.xml
@@ -0,0 +1,114 @@
+<?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_motd">
+
+  <refmeta>
+    <refentrytitle>pam_motd</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_motd-name">
+    <refname>pam_motd</refname>
+    <refpurpose>Display the motd file</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="pam_motd-cmdsynopsis">
+      <command>pam_motd.so</command>
+      <arg choice="opt">
+        motd=<replaceable>/path/filename</replaceable>
+      </arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id="pam_motd-description">
+
+    <title>DESCRIPTION</title>
+
+    <para>
+      pam_motd is a PAM module that can be used to display
+      arbitrary motd (message of the day) files after a succesful
+      login. By default the <filename>/etc/motd</filename> file is
+      shown. The message size is limited to 64KB.
+    </para>
+
+  </refsect1>
+
+  <refsect1 id="pam_motd-options">
+
+    <title>OPTIONS</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <option>motd=<replaceable>/path/filename</replaceable></option>
+        </term>
+        <listitem>
+          <para>
+	    The <filename>/path/filename</filename> file is displayed
+            as message of the day.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_motd-services">
+    <title>MODULE SERVICES PROVIDED</title>
+    <para>
+      Only the <option>session</option> service is supported.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_motd-return_values'>
+    <title>RETURN VALUES</title>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_IGNORE</term>
+        <listitem>
+          <para>
+            This is the only return value of this module.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+     </refsect1>
+
+  <refsect1 id='pam_motd-examples'>
+    <title>EXAMPLES</title>
+    <para>
+      The suggested usage for <filename>/etc/pam.d/login</filename> is:
+      <programlisting>
+session  optoinal  pam_motd.so  motd=/etc/motd
+      </programlisting>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_motd-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+	<refentrytitle>motd</refentrytitle><manvolnum>5</manvolnum>
+      </citerefentry>,
+      <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_motd-author'>
+    <title>AUTHOR</title>
+      <para>
+        pam_motd was written by Ben Collins &lt;bcollins@debian.org&gt;.
+      </para>
+  </refsect1>
+
+</refentry>