Relevant BUGIDs: 529078

Purpose of commit: documentation

Commit summary:
---------------
removed an inappropriate Red Hat ref.
added a description of required etc. in terms of the [..] syntax.

diff --git a/CHANGELOG b/CHANGELOG
index dd75976499b8e4b67b8cadb330d41f6b8e0d8fb5..3180a7dc22881740ac86fdf61dde2cbb3860ba1a 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -55,6 +55,8 @@ bug report - outstanding bugs are listed here:
 0.76: please submit patches for this section with actual code/doc
       patches!
 
+* documented the equivalent '[..]' expressions for "required"
+  etc. Request from Ross Patterson (Bug 529078 - agmorgan).
 * '[...]' parsing: document it and also fix it to support '\]' escape
   sequence. Feature request from Russell Kliese (Bug 517064 -
   agmorgan).

diff --git a/doc/pam_source.sgml b/doc/pam_source.sgml
index 7ed1e131893d71d5452aeb2183ae53630d2193b6..f2545e6f34bffd8d5b59ea63828315df763331d1 100644 (file)
--- a/doc/pam_source.sgml
+++ b/doc/pam_source.sgml
@@ -46,7 +46,7 @@ DAMAGE.
 
 <title>The Linux-PAM System Administrators' Guide
 <author>Andrew G. Morgan, <tt>morgan@kernel.org</tt>
-<date>DRAFT v0.76 2002/05/26
+<date>DRAFT v0.76 2002/05/27
 <abstract>
 This manual documents what a system-administrator needs to know about
 the <bf>Linux-PAM</bf> library. It covers the correct syntax of the
@@ -115,9 +115,8 @@ directories.  Where they have been specified, the conventions we adopt
 here for locating these files are those of the relevant RFC (RFC-86.0,
 see <ref id="see-also-sec" name="bibliography">).  If you are using a
 distribution of Linux (or some other operating system) that supports
-PAM but chooses to distribute these files in a diferent way (Red Hat
-is one such distribution), you should be careful when copying examples
-directly from the text.
+PAM but chooses to distribute these files in a diferent way you should
+be careful when copying examples directly from the text.
 
 <p>
 As an example of the above, where it is explicit, the text assumes
@@ -545,6 +544,21 @@ by the reactions of individual modules.
   start again with the next stacked module.
 </itemize>
 
+<p>
+Each of the four keywords: <tt/required/; <tt/requisite/;
+<tt/sufficient/; and <tt/optional/, have an equivalent expression in
+terms of the <tt/[...]/ syntax. They are as follows:
+<itemize>
+<item><tt/required/ is equivalent to
+<tt/[success=ok new_authtok_reqd=ok ignore=ignore default=bad]/
+<item><tt/requisite/ is equivalent to
+<tt/[success=ok new_authtok_reqd=ok ignore=ignore default=die]/
+<item><tt/sufficient/ is equivalent to
+<tt/[success=done new_authtok_reqd=done default=ignore]/
+<item><tt/optional/ is equivalent to 
+<tt/[success=ok new_authtok_reqd=ok default=ignore]/
+</itemize>
+
 <p>
 Just to get a feel for the power of this new syntax, here is a taste
 of what you can do with it.  With <bf/Linux-PAM-0.63/, the notion of