Relevant BUGIDs:

Purpose of commit: new feature

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

2006-02-07  Thorsten Kukuk  <kukuk@thkukuk.de>

        * configure.in: Check for text browser.
        * Make.xml.rules: Add rule to generate README from README.xml.

        * modules/pam_access/Makefile.am: Include Make.xml.rules.
        * modules/pam_access/README: Regenerated from README.xml.
        * modules/pam_access/README.xml: New.
        * modules/pam_access/access.conf: Extended by new examples.
        * modules/pam_access/access.conf.5: New, generated from xml file.
        * modules/pam_access/access.conf.5.xml: New.
        * modules/pam_access/pam_access.8: New, generated from xml file.
        * modules/pam_access/pam_access.8.xml: New.
        * modules/pam_access/pam_access.c: Add rules for IPv6 and
        netmasks.
        Based on patch from Mike Becher <Mike.Becher@lrz-muenchen.de>.

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

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

        * modules/pam_exec/Makefile.am: Add rule to generate README.
        * modules/pam_exec/README: Regenerated from xml file.
        * modules/pam_exec/pam_exec.8: Regenerated from xml file.
        * modules/pam_exec/pam_exec.8.xml: Syntax files.

1 files changed, 30 insertions, 17 deletions

diff --git a/modules/pam_exec/README b/modules/pam_exec/README
index 8451ef03..8ff9a742 100644
--- a/modules/pam_exec/README
+++ b/modules/pam_exec/README
@@ -1,29 +1,42 @@
+pam_exec — PAM module which calls an external command
 
-pam_exec module:
-	Call <prog> <arguments>
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
+DESCRIPTION
 
-USAGE:
-        For the services you wish to run a program put the following
-	line in the config as the last line for that service:
+pam_exec is a PAM module that can be used to run an external command.
 
-        <type>    required     pam_exec.so [options] /path/prog ...
+OPTIONS
 
-	and pam_exec.so will run "/path/prog ...".
+debug
 
+    Print debug information.
 
-OPTIONS:
+log=file
 
-	debug		print debug informations
+    The output of the command is appended to file
 
-	seteuid		pam_exec.so will call setuid(seteuid()), so that
-			the program will run with the same rights as the 
-			calling applications (effective user ID). The
-			default is that the program will be run with the
-			permissions of the calling user (real user ID).
+seteuid
 
-	log=<file>	the output is appended to this file.
+    Per default pam_exec.so will execute the external command with the real
+    user ID of the calling process. Specifying this option means the command is
+    run with the effective user ID.
 
+EXAMPLES
+
+Add the following line to /etc/pam.d/passwd to rebuild the NIS database after
+each local password change:
+
+        passwd optional pam_exec.so seteuid make -C /var/yp
+
+
+This will execute the command
+
+make -C /var/yp
+
+with effective user ID.
+
+AUTHOR
+
+pam_exec was written by Thorsten Kukuk <kukuk@thkukuk.de>.
 
-AUTHOR:
-	Thorsten Kukuk <kukuk@thkukuk.de>