From 7f0c6db93cec2034b6151a220e588ffe51f8ca0d Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Sun, 25 Aug 2002 03:53:41 +0000 Subject: [PATCH] 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 --- docs/manual/install.html.en | 28 +++++++++++++++++++++++++++- docs/manual/install.xml | 26 ++++++++++++++++++++++++++ docs/manual/mod/mod_auth_dbm.html.en | 4 ++-- docs/manual/mod/mod_auth_dbm.xml | 4 ++-- docs/manual/mod/mod_rewrite.html.en | 24 ++++++++++++++---------- docs/manual/mod/mod_rewrite.xml | 24 ++++++++++++++---------- 6 files changed, 85 insertions(+), 25 deletions(-) diff --git a/docs/manual/install.html.en b/docs/manual/install.html.en index 050e8706fc..33b8e7fbcb 100644 --- a/docs/manual/install.html.en +++ b/docs/manual/install.html.en @@ -16,7 +16,7 @@ like many other Open Source projects.

Overview for the + impatient
  • Requirements
  • Download
  • Extract
  • Configuring the source tree
  • Build
  • Install
  • Customize
  • Test

    • Overview for the impatient

    @@ -482,6 +482,32 @@ +

    DBM

    + +

    Several Apache features, including + mod_auth_dbm and mod_rewrite's + DBM RewriteMap 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 configure options are available:

    + +
    +
    --with-gdbm[=path]
    +
    --with-ndbm[=path]
    +
    --with-berkeley-db[=path]
    + +
    If no path is specified, Apache will search for the +include files and libraries in the usual search paths. An explict +path will cause Apache to look in +path/lib and +path/include for the relevant files. Finally, +the path may specify specific include and library paths +seperated by a colon.
    +
    + + +

    Suexec

    Apache includes a support program called suexec which can be used to isolate user diff --git a/docs/manual/install.xml b/docs/manual/install.xml index 0726742d4a..8a71cee39f 100644 --- a/docs/manual/install.xml +++ b/docs/manual/install.xml @@ -509,6 +509,32 @@ +

    DBM + +

    Several Apache features, including + mod_auth_dbm and mod_rewrite's + DBM RewriteMap 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 configure options are available:

    + +
    +
    --with-gdbm[=path]
    +
    --with-ndbm[=path]
    +
    --with-berkeley-db[=path]
    + +
    If no path is specified, Apache will search for the +include files and libraries in the usual search paths. An explict +path will cause Apache to look in +path/lib and +path/include for the relevant files. Finally, +the path may specify specific include and library paths +seperated by a colon.
    +
    +
    + +
    Suexec

    Apache includes a support program called

    AuthDBMType Directive

    Description: Sets the type of database file that is used to store passwords
    Syntax: - AuthDBMType default|SDBM|GDBM|DB
    Default: + AuthDBMType default|SDBM|GDBM|NDBM|DB
    Default: AuthDBMType default
    Context: directory, .htaccess
    Override: AuthConfig
    Status: @@ -120,7 +120,7 @@ store passwords
    compile-time settings.

    It is crucial that whatever program you use to create your password files is configured to use the same type of database.

    diff --git a/docs/manual/mod/mod_auth_dbm.xml b/docs/manual/mod/mod_auth_dbm.xml index 13cfd71bb2..64ed0696bb 100644 --- a/docs/manual/mod/mod_auth_dbm.xml +++ b/docs/manual/mod/mod_auth_dbm.xml @@ -123,7 +123,7 @@ passwords for authentication AuthDBMType Sets the type of database file that is used to store passwords -AuthDBMType default|SDBM|GDBM|DB +AuthDBMType default|SDBM|GDBM|NDBM|DB AuthDBMType default directory.htaccess @@ -135,7 +135,7 @@ store passwords

    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.

    +compile-time settings.

    It is crucial that whatever program you use to create your password files is configured to use the same type of database.

    diff --git a/docs/manual/mod/mod_rewrite.html.en b/docs/manual/mod/mod_rewrite.html.en index f85e7caca4..0d1d712647 100644 --- 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
  • - Hash File
    - MapType: dbm, MapSource: Unix filesystem - path to valid regular file - -

    Here the source is a binary NDBM format file - containing the same contents as a Plain Text - 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:

    + Hash File
    MapType: + dbm[=type], MapSource: Unix filesystem + path to valid regular file + +

    Here the source is a binary format DBM file containing + the same contents as a Plain Text format file, but + in a special representation which is optimized for really + fast lookups. The type can be sdbm, gdbm, ndbm, or + db depending on compile-time + settings. If the type 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.

    diff --git a/docs/manual/mod/mod_rewrite.xml b/docs/manual/mod/mod_rewrite.xml
index f11e1b1fdc..b2334554ec 100644
--- 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
         
 
         
  • 
-          Hash File
    
-           MapType: dbm, MapSource: Unix filesystem
-          path to valid regular file 
-
-          
    Here the source is a binary NDBM format file
-          containing the same contents as a Plain Text
-          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:
    
+          Hash File
     MapType:
+          dbm[=type], MapSource: Unix filesystem
+          path to valid regular file
+
+          
    Here the source is a binary format DBM file containing
+          the same contents as a Plain Text format file, but
+          in a special representation which is optimized for really
+          fast lookups. The type can be sdbm, gdbm, ndbm, or
+          db depending on compile-time
+          settings.  If the type 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.
    
 
 
 
    -- 
2.40.0