Relevant BUGIDs:

Purpose of commit: new feature

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

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

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

5 files changed, 417 insertions, 21 deletions

diff --git a/modules/pam_lastlog/Makefile.am b/modules/pam_lastlog/Makefile.am
index 73ee4be6..e81e7833 100644
--- a/modules/pam_lastlog/Makefile.am
+++ b/modules/pam_lastlog/Makefile.am
@@ -7,7 +7,10 @@ CLEANFILES = *~
 securelibdir = $(SECUREDIR)
 secureconfdir = $(SCONFIGDIR)
 
-EXTRA_DIST = README tst-pam_lastlog
+EXTRA_DIST = README $(MANS) $(XMLS) tst-pam_lastlog
+
+man_MANS = pam_lastlog.8
+XMLS = README.xml pam_lastlog.8.xml
 
 TESTS = tst-pam_lastlog
 
@@ -19,3 +22,10 @@ if HAVE_VERSIONING
 endif
 
 securelib_LTLIBRARIES = pam_lastlog.la
+
+if ENABLE_REGENERATE_MAN
+noinst_DATA = README
+README: pam_lastlog.8.xml
+-include $(top_srcdir)/Make.xml.rules
+endif
+
diff --git a/modules/pam_lastlog/README b/modules/pam_lastlog/README
index 0adc118b..9f6c5505 100644
--- a/modules/pam_lastlog/README
+++ b/modules/pam_lastlog/README
@@ -1,30 +1,57 @@
-pam_lastlogin: The last login module
+pam_lastlog — PAM module to display date of last login
 
-This module can be used as session entry to provide a `Last login on ...'
-message. When the user logs into the system from what ever application
-uses the PAM libraries.  In addition, the module maintains the
-/var/log/lastlog file and the wtmp entry.
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
+DESCRIPTION
 
-The behavior of this module can be modified with one of the following
-flags:
+pam_lastlog is a PAM module to display a line of information about the last
+login of the user. In addition, the module maintains the /var/log/lastlog file.
 
- * debug - write more information to syslog(3).
+Some applications may perform this function themselves. In such cases, this
+module is not necessary.
 
- * nodate - neglect to give the date of the last login when displaying
-            information about the last login on the system.
+OPTIONS
 
- * noterm - neglect to diplay the terminal name on which the last
-            login was attempt.
+debug
 
- * nohost - neglect to indicate from which host the last login was
-            attempted.
+    Print debug information.
 
- * silent - neglect to inform the user about any previous login:
-            just update the /var/log/lastlog file.
+silent
 
- * never - if the /var/log/lastlog file does not contain any old
-           entries for the user, indicate that the user has never
-           previously logged in with a ``welcome..." message.
+    Don't inform the user about any previous login, just upate the /var/log/
+    lastlog file.
+
+never
+
+    If the /var/log/lastlog file does not contain any old entries for the user,
+    indicate that the user has never previously logged in with a welcome
+    message.
+
+nodate
+
+    Don't display the date of the last login.
+
+noterm
+
+    Don't display the terminal name on which the last login was attempted.
+
+nohost
+
+    Don't indicate from which host the last login was attempted.
+
+nowtmp
+
+    Don't update the wtmp entry.
+
+EXAMPLES
+
+Add the following line to /etc/pam.d/login to display the last login time of an
+user:
+
+    session  required  pam_lastlog.so nowtmp
+
+
+AUTHOR
+
+pam_lastlog was written by Andrew G. Morgan <morgan@kernel.org>.
 
- * nowtmp - Don't update the wtmp entry.
diff --git a/modules/pam_lastlog/README.xml b/modules/pam_lastlog/README.xml
new file mode 100644
index 00000000..7fe70339
--- /dev/null
+++ b/modules/pam_lastlog/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_lastlog.8.xml">
+-->
+]>
+
+<article>
+
+  <articleinfo>
+
+    <title>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_lastlog.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_lastlog-name"]/*)'/>
+    </title>
+
+  </articleinfo>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_lastlog.8.xml" xpointer='xpointer(//refsect1[@id = "pam_lastlog-description"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_lastlog.8.xml" xpointer='xpointer(//refsect1[@id = "pam_lastlog-options"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_lastlog.8.xml" xpointer='xpointer(//refsect1[@id = "pam_lastlog-examples"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_lastlog.8.xml" xpointer='xpointer(//refsect1[@id = "pam_lastlog-author"]/*)'/>
+  </section>
+
+</article>
diff --git a/modules/pam_lastlog/pam_lastlog.8 b/modules/pam_lastlog/pam_lastlog.8
new file mode 100644
index 00000000..407f1961
--- /dev/null
+++ b/modules/pam_lastlog/pam_lastlog.8
@@ -0,0 +1,85 @@
+.\" ** 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_LASTLOG" "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_lastlog \- PAM module to display date of last login
+.SH "SYNOPSIS"
+.HP 15
+\fBpam_lastlog.so\fR [debug] [silent] [never] [nodate] [nohost] [noterm] [nowtmp]
+.SH "DESCRIPTION"
+.PP
+pam_lastlog is a PAM module to display a line of information about the last login of the user. In addition, the module maintains the
+\fI/var/log/lastlog\fR
+file.
+.PP
+Some applications may perform this function themselves. In such cases, this module is not necessary.
+.SH "OPTIONS"
+.TP
+\fBdebug\fR
+Print debug information.
+.TP
+\fBsilent\fR
+Don't inform the user about any previous login, just upate the
+\fI/var/log/lastlog\fR
+file.
+.TP
+\fBnever\fR
+If the
+\fI/var/log/lastlog\fR
+file does not contain any old entries for the user, indicate that the user has never previously logged in with a welcome message.
+.TP
+\fBnodate\fR
+Don't display the date of the last login.
+.TP
+\fBnoterm\fR
+Don't display the terminal name on which the last login was attempted.
+.TP
+\fBnohost\fR
+Don't indicate from which host the last login was attempted.
+.TP
+\fBnowtmp\fR
+Don't update the wtmp entry.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+Only the
+\fBsession\fR
+service is supported.
+.SH "RETURN VALUES"
+.PP
+.TP
+PAM_SUCCESS
+Everything was successfull.
+.TP
+PAM_SERVICE_ERR
+Internal service module error.
+.TP
+PAM_USER_UNKNOWN
+User not known.
+.SH "EXAMPLES"
+.PP
+Add the following line to
+\fI/etc/pam.d/login\fR
+to display the last login time of an user:
+.sp
+.nf
+    session  required  pam_lastlog.so nowtmp
+      
+.fi
+.SH "FILES"
+.TP
+\fI/var/log/lastlog\fR
+Lastlog logging file
+.SH "SEE ALSO"
+.PP
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_lastlog was written by Andrew G. Morgan <morgan@kernel.org>.
diff --git a/modules/pam_lastlog/pam_lastlog.8.xml b/modules/pam_lastlog/pam_lastlog.8.xml
new file mode 100644
index 00000000..fa97b03e
--- /dev/null
+++ b/modules/pam_lastlog/pam_lastlog.8.xml
@@ -0,0 +1,233 @@
+<?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_lastlog">
+
+  <refmeta>
+    <refentrytitle>pam_lastlog</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_lastlog-name">
+    <refname>pam_lastlog</refname>
+    <refpurpose>PAM module to display date of last login</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="pam_lastlog-cmdsynopsis">
+      <command>pam_lastlog.so</command>
+      <arg choice="opt">
+	debug
+      </arg>
+      <arg choice="opt">
+        silent
+      </arg>
+      <arg choice="opt">
+        never
+      </arg>
+      <arg choice="opt">
+        nodate
+      </arg>
+      <arg choice="opt">
+        nohost
+      </arg>
+      <arg choice="opt">
+        noterm
+      </arg>
+      <arg choice="opt">
+        nowtmp
+      </arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id="pam_lastlog-description">
+
+    <title>DESCRIPTION</title>
+
+    <para>
+      pam_lastlog is a PAM module to display a line of information
+      about the last login of the user. In addition, the module maintains
+      the <filename>/var/log/lastlog</filename> file.
+    </para>
+    <para>
+      Some applications may perform this function themselves. In such
+      cases, this module is not necessary.
+    </para>
+  </refsect1>
+
+  <refsect1 id="pam_lastlog-options">
+
+    <title>OPTIONS</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <option>debug</option>
+        </term>
+        <listitem>
+          <para>
+            Print debug information.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>silent</option>
+        </term>
+        <listitem>
+          <para>
+            Don't inform the user about any previous login,
+            just upate the <filename>/var/log/lastlog</filename> file.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>never</option>
+        </term>
+        <listitem>
+          <para>
+            If the <filename>/var/log/lastlog</filename> file does
+            not contain any old entries for the user, indicate that
+            the user has never previously logged in with a welcome
+            message.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>nodate</option>
+        </term>
+        <listitem>
+          <para>
+            Don't display the date of the last login.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>noterm</option>
+        </term>
+        <listitem>
+          <para>
+            Don't display the terminal name on which the
+            last login was attempted.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>nohost</option>
+        </term>
+        <listitem>
+          <para>
+            Don't indicate from which host the last login was
+            attempted.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>nowtmp</option>
+        </term>
+        <listitem>
+          <para>
+            Don't update the wtmp entry.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_lastlog-services">
+    <title>MODULE SERVICES PROVIDED</title>
+    <para>
+      Only the <option>session</option> service is supported.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_lastlog-return_values'>
+    <title>RETURN VALUES</title>
+    <para>
+      <variablelist>
+
+        <varlistentry>
+          <term>PAM_SUCCESS</term>
+          <listitem>
+            <para>
+              Everything was successfull.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>PAM_SERVICE_ERR</term>
+          <listitem>
+            <para>
+	      Internal service module error.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>PAM_USER_UNKNOWN</term>
+          <listitem>
+            <para>
+	      User not known.
+            </para>
+          </listitem>
+        </varlistentry>
+
+      </variablelist>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_lastlog-examples'>
+    <title>EXAMPLES</title>
+    <para>
+      Add the following line to <filename>/etc/pam.d/login</filename> to
+      display the last login time of an user:
+    </para>
+      <programlisting>
+    session  required  pam_lastlog.so nowtmp
+      </programlisting>
+  </refsect1>
+
+  <refsect1 id="pam_lastlog-files">
+    <title>FILES</title>
+    <variablelist>
+      <varlistentry>
+        <term><filename>/var/log/lastlog</filename></term>
+        <listitem>
+          <para>Lastlog logging file</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='pam_lastlog-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_lastlog-author'>
+    <title>AUTHOR</title>
+      <para>
+        pam_lastlog was written by Andrew G. Morgan &lt;morgan@kernel.org&gt;.
+      </para>
+  </refsect1>
+
+</refentry>
+<!-- vim: sw=2
+-->