diff options
authorAndrew G. Morgan <>2002-05-27 23:23:15 +0000
committerAndrew G. Morgan <>2002-05-27 23:23:15 +0000
commit6b8b2ce0e764075f18e73d214321ba7ff1fc646d (patch)
parent6daa9f4e4eecb8efb60879a5c98135aa0c4d4081 (diff)
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.
2 files changed, 20 insertions, 4 deletions
index dd759764..3180a7dc 100644
@@ -55,6 +55,8 @@ bug report - outstanding bugs are listed here:
0.76: please submit patches for this section with actual code/doc
+* 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 -
diff --git a/doc/pam_source.sgml b/doc/pam_source.sgml
index 7ed1e131..f2545e6f 100644
--- 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></tt>
-<date>DRAFT v0.76 2002/05/26
+<date>DRAFT v0.76 2002/05/27
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.
As an example of the above, where it is explicit, the text assumes
@@ -546,6 +545,21 @@ by the reactions of individual modules.
+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:
+<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]/
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
client plug-in agents was introduced. This is something that makes it