You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ig...@apache.org on 2012/04/26 18:14:31 UTC

svn commit: r1330921 - in /httpd/httpd/trunk/docs/manual/mod: mod_authn_dbd.xml mod_authn_socache.xml mod_authnz_ldap.xml mod_authz_dbd.xml

Author: igalic
Date: Thu Apr 26 16:14:31 2012
New Revision: 1330921

URL: http://svn.apache.org/viewvc?rev=1330921&view=rev
Log:
fix XML validation.
Revert some of the hilighting to use <example><pre>, for instance: ldiffs
Make some of the lines that were artifically broken > 40char.

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_authn_dbd.xml
    httpd/httpd/trunk/docs/manual/mod/mod_authn_socache.xml
    httpd/httpd/trunk/docs/manual/mod/mod_authnz_ldap.xml
    httpd/httpd/trunk/docs/manual/mod/mod_authz_dbd.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_authn_dbd.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_authn_dbd.xml?rev=1330921&r1=1330920&r2=1330921&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_authn_dbd.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_authn_dbd.xml Thu Apr 26 16:14:31 2012
@@ -72,7 +72,7 @@ to cache credentials and take most of th
 <title>Configuration Example</title>
 <p>This simple example shows use of this module in the context of
 the Authentication and DBD frameworks.</p>
-<highlight language="config"><pre>
+<highlight language="config">
 # mod_dbd configuration
 # UPDATED to include authentication cacheing
 DBDriver pgsql
@@ -100,10 +100,9 @@ DBDExptime 300
   Require valid-user
 
   # mod_authn_dbd SQL query to authenticate a user
-  AuthDBDUserPWQuery \
-    "SELECT password FROM authn WHERE user = %s"
+  AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
 &lt;/Directory&gt;
-</pre></highlight>
+</highlight>
 </section>
 
 <section id="exposed">
@@ -136,10 +135,9 @@ configuration required in some web appli
     will be passed as a single string parameter when the SQL query is
     executed.  It may be referenced within the query statement using
     a <code>%s</code> format specifier.</p>
-    <highlight language="config"><pre>
-AuthDBDUserPWQuery \
-  "SELECT password FROM authn WHERE user = %s"
-</pre></highlight>
+    <highlight language="config">
+AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
+</highlight>
     <p>The first column value of the first row returned by the query
     statement should be a string containing the encrypted password.
     Subsequent rows will be ignored.  If no rows are returned, the user
@@ -171,10 +169,9 @@ AuthDBDUserPWQuery \
     The user's ID and the realm, in that order, will be passed as string
     parameters when the SQL query is executed.  They may be referenced
     within the query statement using <code>%s</code> format specifiers.</p>
-    <highlight language="config"><pre>
-AuthDBDUserRealmQuery \
-  "SELECT password FROM authn WHERE user = %s AND realm = %s"
-</pre></highlight>
+    <highlight language="config">
+AuthDBDUserRealmQuery "SELECT password FROM authn WHERE user = %s AND realm = %s"
+</highlight>
     <p>The first column value of the first row returned by the query
     statement should be a string containing the encrypted password.
     Subsequent rows will be ignored.  If no rows are returned, the user

Modified: httpd/httpd/trunk/docs/manual/mod/mod_authn_socache.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_authn_socache.xml?rev=1330921&r1=1330920&r2=1330921&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_authn_socache.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_authn_socache.xml Thu Apr 26 16:14:31 2012
@@ -69,7 +69,7 @@ the load on backends</description>
     </ol>
     <p>A simple usage example to accelerate <module>mod_authn_dbd</module>
     using dbm as a cache engine:</p>
-    <highlight language="config"><pre>
+    <highlight language="config">
 &lt;Directory /usr/www/myhost/private&gt;
     AuthType Basic
     AuthName "Cached Authentication Example"
@@ -80,7 +80,7 @@ the load on backends</description>
     AuthnCacheSOCache dbm
     Require valid-user
 &lt;/Directory&gt;
-    </pre></highlight>
+    </highlight>
 </section>
 
 <section id="dev"><title>Cacheing with custom modules</title>
@@ -143,7 +143,7 @@ the load on backends</description>
     or by a custom provider <var>myprovider</var>, but leave those looked
     up by lightweight providers like file or dbm lookup alone:</p>
     <highlight language="config">
-        AuthnCacheProvideFor dbd myprovider
+AuthnCacheProvideFor dbd myprovider
     </highlight>
 </usage>
 </directivesynopsis>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_authnz_ldap.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_authnz_ldap.xml?rev=1330921&r1=1330920&r2=1330921&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_authnz_ldap.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_authnz_ldap.xml Thu Apr 26 16:14:31 2012
@@ -366,12 +366,12 @@ Require ldap-user "Joe Manager"
     group. Note: Do not surround the group name with quotes.
     For example, assume that the following entry existed in
     the LDAP directory:</p>
-<highlight language="config">
+<example><pre>
 dn: cn=Administrators, o=Example
 objectClass: groupOfUniqueNames
 uniqueMember: cn=Barbara Jenson, o=Example
 uniqueMember: cn=Fred User, o=Example
-</highlight>
+</pre></example>
 
     <p>The following directive would grant access to both Fred and
     Barbara:</p>
@@ -381,7 +381,7 @@ uniqueMember: cn=Fred User, o=Example
     if <directive module="mod_authnz_ldap">AuthLDAPMaxSubGroupDepth</directive>
     is set to a value greater than 0. For example, assume the following entries
     exist in the LDAP directory:</p>
-<highlight language="config">
+<example><pre>
 dn: cn=Employees, o=Example
 objectClass: groupOfUniqueNames
 uniqueMember: cn=Managers, o=Example
@@ -408,7 +408,7 @@ dn: cn=Temporary Employees, o=Example
 objectClass: groupOfUniqueNames
 uniqueMember: cn=Jim Swenson, o=Example
 uniqueMember: cn=Elliot Rhodes, o=Example
-</highlight>
+</pre></example>
 
     <p>The following directives would allow access for Bob Ellis, Tom Jackson,
     Barbara Jensen, Fred User, Allan Jefferson, and Paul Tilley but would not
@@ -690,11 +690,11 @@ AuthLDAPURL ldap://10.0.0.1:3268/?userPr
     authentication to it is a matter of adding the following
     directives to <em>every</em> <code>.htaccess</code> file
     that gets created in the web</p>
-<highlight language="config"><pre>
+<highlight language="config">
 AuthLDAPURL            "the url"
 AuthGroupFile <em>mygroupfile</em>
 Require group <em>mygroupfile</em>
-</pre></highlight>
+</highlight>
 
 <section id="howitworks"><title>How It Works</title>
 

Modified: httpd/httpd/trunk/docs/manual/mod/mod_authz_dbd.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_authz_dbd.xml?rev=1330921&r1=1330920&r2=1330921&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_authz_dbd.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_authz_dbd.xml Thu Apr 26 16:14:31 2012
@@ -81,7 +81,7 @@ to implement functions that start and en
 
 <section id="example">
 <title>Configuration example</title>
-<highlight language="config"><pre>
+<highlight language="config">
 # mod_dbd configuration
 DBDriver pgsql
 DBDParams "dbname=apacheauth user=apache pass=xxxxxx"
@@ -115,13 +115,11 @@ DBDExptime 300
 
   &lt;Files login.html&gt;
     # don't require user to already be logged in!
-    AuthDBDUserPWQuery \
-      "SELECT password FROM authn WHERE user = %s"
+    AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
 
     # dbd-login action executes a statement to log user in
     Require dbd-login
-    AuthzDBDQuery \
-      "UPDATE authn SET login = 'true' WHERE user = %s"
+    AuthzDBDQuery "UPDATE authn SET login = 'true' WHERE user = %s"
 
     # return user to referring page (if any) after
     # successful login
@@ -131,11 +129,10 @@ DBDExptime 300
   &lt;Files logout.html&gt;
     # dbd-logout action executes a statement to log user out
     Require dbd-logout
-    AuthzDBDQuery \
-      "UPDATE authn SET login = 'false' WHERE user = %s"
+    AuthzDBDQuery "UPDATE authn SET login = 'false' WHERE user = %s"
   &lt;/Files&gt;
 &lt;/Directory&gt;
-</pre></highlight>
+</highlight>
 </section>
 
 <directivesynopsis>
@@ -159,8 +156,7 @@ DBDExptime 300
     may be returned.
     <highlight language="config">
 Require dbd-group
-AuthzDBDQuery \
-  "SELECT group FROM groups WHERE user = %s"
+AuthzDBDQuery "SELECT group FROM groups WHERE user = %s"
 </highlight>
     </li>
     <li>When used with a <code>Require dbd-login</code> or
@@ -168,11 +164,10 @@ AuthzDBDQuery \
     but will instead execute a SQL statement designed to log the user
     in or out.  The user must already be authenticated with
     <module>mod_authn_dbd</module>.
-    <highlight language="config"><pre>
+    <highlight language="config">
 Require dbd-login
-AuthzDBDQuery \
-  "UPDATE authn SET login = 'true' WHERE user = %s"
-</pre></highlight>
+AuthzDBDQuery "UPDATE authn SET login = 'true' WHERE user = %s"
+</highlight>
     </li>
     </ul>
     <p>In all cases, the user's ID will be passed as a single string
@@ -194,8 +189,7 @@ AuthzDBDQuery \
     parameter when the SQL query is executed.  It may be referenced within
     the query statement using a <code>%s</code> format specifier.</p>
     <highlight language="config">
-AuthzDBDRedirectQuery \
-  "SELECT userpage FROM userpages WHERE user = %s"
+AuthzDBDRedirectQuery "SELECT userpage FROM userpages WHERE user = %s"
 </highlight>
     <p>The first column value of the first row returned by the query
     statement should be a string containing a URL to which to redirect