Add a little documentation on how to select DBMs during build

and update the RerwiteMap and AuthDBMType directives to point
to it.

The build docs could still use a great deal of work.  There
are tons of things that aren't documented at all.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96526 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/install.html.en b/docs/manual/install.html.en
index 050e8706fca0f73d477595de6163a596ebf11d17..33b8e7fbcb4c90c18dd18fbb146ce8dc53433f09 100644 (file)
--- a/docs/manual/install.html.en
+++ b/docs/manual/install.html.en
@@ -16,7 +16,7 @@
     like many other Open Source projects.</p>
 
 <ul><li><a href="#overview">Overview for the
-    impatient</a></li><li><a href="#requirements">Requirements</a></li><li><a href="#download">Download</a></li><li><a href="#extract">Extract</a></li><li><a href="#configure">Configuring the source tree</a><ul><li><a href="#environment">Environment Variables</a></li><li><a href="#output">autoconf Output Options</a></li><li><a href="#pathnames">Pathnames</a></li><li><a href="#modules">Modules</a></li><li><a href="#suexec">Suexec</a></li></ul></li><li><a href="#compile">Build</a></li><li><a href="#install">Install</a></li><li><a href="#customize">Customize</a></li><li><a href="#test">Test</a></li></ul><hr><h2><a name="overview">Overview for the
+    impatient</a></li><li><a href="#requirements">Requirements</a></li><li><a href="#download">Download</a></li><li><a href="#extract">Extract</a></li><li><a href="#configure">Configuring the source tree</a><ul><li><a href="#environment">Environment Variables</a></li><li><a href="#output">autoconf Output Options</a></li><li><a href="#pathnames">Pathnames</a></li><li><a href="#modules">Modules</a></li><li><a href="#dbm">DBM</a></li><li><a href="#suexec">Suexec</a></li></ul></li><li><a href="#compile">Build</a></li><li><a href="#install">Install</a></li><li><a href="#customize">Customize</a></li><li><a href="#test">Test</a></li></ul><hr><h2><a name="overview">Overview for the
     impatient</a></h2>
 
     <table>
@@ -482,6 +482,32 @@
     </dl>
 
 
+<h3><a name="dbm">DBM</a></h3>
+
+    <p>Several Apache features, including
+    <code><a href="./mod/mod_auth_dbm.html">mod_auth_dbm</a></code> and <code><a href="./mod/mod_rewrite.html">mod_rewrite</a></code>'s
+    DBM <a href="./mod/mod_rewrite.html#rewritemap" class="directive"><code class="directive">RewriteMap</code></a> use
+    simple key/value databases for quick lookups of information.  Apache
+    includes SDBM with its source-code, so this database is always
+    available.  If you would like to use other database types, the
+    following <code>configure</code> options are available:</p>
+
+<dl>
+<dt><code>--with-gdbm[=<em>path</em>]</code></dt>
+<dt><code>--with-ndbm[=<em>path</em>]</code></dt>
+<dt><code>--with-berkeley-db[=<em>path</em>]</code></dt> 
+
+<dd>If no <em>path</em> is specified, Apache will search for the
+include files and libraries in the usual search paths.  An explict
+<em>path</em> will cause Apache to look in
+<em>path</em><code>/lib</code> and
+<em>path</em><code>/include</code> for the relevant files.  Finally,
+the <em>path</em> may specify specific include and library paths
+seperated by a colon.</dd>
+</dl>
+
+
+
 <h3><a name="suexec">Suexec</a></h3>
 
     <p>Apache includes a support program called <a href="suexec.html">suexec</a> which can be used to isolate user

diff --git a/docs/manual/install.xml b/docs/manual/install.xml
index 0726742d4a5ea08551b2c3276bf255b15c5ac3b3..8a71cee39f5691afeb3d7422b33f6aaeb408aaf4 100644 (file)
--- a/docs/manual/install.xml
+++ b/docs/manual/install.xml
@@ -509,6 +509,32 @@
     </dl>
 </section>
 
+<section id="dbm"><title>DBM</title>
+
+    <p>Several Apache features, including
+    <module>mod_auth_dbm</module> and <module>mod_rewrite</module>'s
+    DBM <directive module="mod_rewrite">RewriteMap</directive> use
+    simple key/value databases for quick lookups of information.  Apache
+    includes SDBM with its source-code, so this database is always
+    available.  If you would like to use other database types, the
+    following <code>configure</code> options are available:</p>
+
+<dl>
+<dt><code>--with-gdbm[=<em>path</em>]</code></dt>
+<dt><code>--with-ndbm[=<em>path</em>]</code></dt>
+<dt><code>--with-berkeley-db[=<em>path</em>]</code></dt> 
+
+<dd>If no <em>path</em> is specified, Apache will search for the
+include files and libraries in the usual search paths.  An explict
+<em>path</em> will cause Apache to look in
+<em>path</em><code>/lib</code> and
+<em>path</em><code>/include</code> for the relevant files.  Finally,
+the <em>path</em> may specify specific include and library paths
+seperated by a colon.</dd>
+</dl>
+</section>
+
+
 <section id="suexec"><title>Suexec</title>
 
     <p>Apache includes a support program called <a

diff --git a/docs/manual/mod/mod_auth_dbm.html.en b/docs/manual/mod/mod_auth_dbm.html.en
index 73ad02ad805fce4341108e70d78529d1e061e29a..33e432247641c616a0ee11dbe5cc1689a0a59bfb 100644 (file)
--- a/docs/manual/mod/mod_auth_dbm.html.en
+++ b/docs/manual/mod/mod_auth_dbm.html.en
@@ -109,7 +109,7 @@ AuthDBMUserFile /www/userbase
 <hr><h2><a name="AuthDBMType">AuthDBMType</a> <a name="authdbmtype">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: 
                   </strong></td><td>Sets the type of database file that is used to
 store passwords</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:
-                  </a></td><td>AuthDBMType default|SDBM|GDBM|DB</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: 
+                  </a></td><td>AuthDBMType default|SDBM|GDBM|NDBM|DB</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: 
                     </a></td><td><code>AuthDBMType default</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:
                   </a></td><td>directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:
                     </a></td><td>AuthConfig</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:
@@ -120,7 +120,7 @@ store passwords</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Sy
 <p>Sets the type of database file that is used to store the passwords.
 The default database type is determined at compile time.  The
 availability of other types of database files also depends on
-compile-time settings.</p>
+<a href="../install.html#dbm">compile-time settings</a>.</p>
 
 <p>It is crucial that whatever program you use to create your password
 files is configured to use the same type of database.</p>

diff --git a/docs/manual/mod/mod_auth_dbm.xml b/docs/manual/mod/mod_auth_dbm.xml
index 13cfd71bb250cd061542489a5fa9c442d34608b2..64ed0696bb9bf0979f5e0a1099e44b9f4d1cf615 100644 (file)
--- a/docs/manual/mod/mod_auth_dbm.xml
+++ b/docs/manual/mod/mod_auth_dbm.xml
@@ -123,7 +123,7 @@ passwords for authentication</description>
 <name>AuthDBMType</name>
 <description>Sets the type of database file that is used to
 store passwords</description>
-<syntax>AuthDBMType default|SDBM|GDBM|DB</syntax>
+<syntax>AuthDBMType default|SDBM|GDBM|NDBM|DB</syntax>
 <default>AuthDBMType default</default>
 <contextlist><context>directory</context><context>.htaccess</context>
 </contextlist>
@@ -135,7 +135,7 @@ store passwords</description>
 <p>Sets the type of database file that is used to store the passwords.
 The default database type is determined at compile time.  The
 availability of other types of database files also depends on
-compile-time settings.</p>
+<a href="../install.html#dbm">compile-time settings</a>.</p>
 
 <p>It is crucial that whatever program you use to create your password
 files is configured to use the same type of database.</p>

diff --git a/docs/manual/mod/mod_rewrite.html.en b/docs/manual/mod/mod_rewrite.html.en
index f85e7caca46eca5086ea5fabf1ee3b706b0b66fb..0d1d7126470dd660a54608ba50748b0f5ae10d4c 100644 (file)
--- a/docs/manual/mod/mod_rewrite.html.en
+++ b/docs/manual/mod/mod_rewrite.html.en
@@ -951,16 +951,20 @@ RewriteMap servers rnd:/path/to/file/map.txt
         </li>
 
         <li>
-          <strong>Hash File</strong><br>
-           MapType: <code>dbm</code>, MapSource: Unix filesystem
-          path to valid regular file 
-
-          <p>Here the source is a binary NDBM format file
-          containing the same contents as a <em>Plain Text</em>
-          format file, but in a special representation which is
-          optimized for really fast lookups. You can create such a
-          file with any NDBM tool or with the following Perl
-          script:</p>
+          <strong>Hash File</strong><br> MapType:
+          <code>dbm[=<em>type</em>]</code>, MapSource: Unix filesystem
+          path to valid regular file
+
+          <p>Here the source is a binary format DBM file containing
+          the same contents as a <em>Plain Text</em> format file, but
+          in a special representation which is optimized for really
+          fast lookups. The <em>type</em> can be sdbm, gdbm, ndbm, or
+          db depending on <a href="../install.html#dbm">compile-time
+          settings</a>.  If the <em>type</em> is ommitted, the
+          compile-time default will be chosen. You can create such a
+          file with any DBM tool or with the following Perl
+          script.  Be sure to adjust it to create the appropriate
+          type of DBM.  The example creates an NDBM file.</p>
 
 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
 <pre>

diff --git a/docs/manual/mod/mod_rewrite.xml b/docs/manual/mod/mod_rewrite.xml
index f11e1b1fdcebf1d5e0ccb0fa16dfe7414f94e4de..b2334554ece55ec54c968d8c78c247e30ebd2f10 100644 (file)
--- a/docs/manual/mod/mod_rewrite.xml
+++ b/docs/manual/mod/mod_rewrite.xml
@@ -537,16 +537,20 @@ RewriteMap servers rnd:/path/to/file/map.txt
         </li>
 
         <li>
-          <strong>Hash File</strong><br />
-           MapType: <code>dbm</code>, MapSource: Unix filesystem
-          path to valid regular file 
-
-          <p>Here the source is a binary NDBM format file
-          containing the same contents as a <em>Plain Text</em>
-          format file, but in a special representation which is
-          optimized for really fast lookups. You can create such a
-          file with any NDBM tool or with the following Perl
-          script:</p>
+          <strong>Hash File</strong><br /> MapType:
+          <code>dbm[=<em>type</em>]</code>, MapSource: Unix filesystem
+          path to valid regular file
+
+          <p>Here the source is a binary format DBM file containing
+          the same contents as a <em>Plain Text</em> format file, but
+          in a special representation which is optimized for really
+          fast lookups. The <em>type</em> can be sdbm, gdbm, ndbm, or
+          db depending on <a href="../install.html#dbm">compile-time
+          settings</a>.  If the <em>type</em> is ommitted, the
+          compile-time default will be chosen. You can create such a
+          file with any DBM tool or with the following Perl
+          script.  Be sure to adjust it to create the appropriate
+          type of DBM.  The example creates an NDBM file.</p>
 
 <example>
 <pre>