gecko-dev/db/README

# @(#)README	10.61 (Sleepycat) 6/2/98

This is version 2.4.14 (6/2/98) of the Berkeley DB library.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
To view the documentation for the Berkeley DB release, point your web
browser at the following distribution files:

    man/man.html/index_c.html	 -- The C API
    man/man.html/index_cxx.html  -- The C++ API
    man/man.html/index_java.html -- The Java API

The documentation is available in PostScript, UNIX roff and flat text
format as well.  We suggest reviewing the following three pages first:

    db_intro(3)
    db_appinit(3)
    db_open(3)

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Bug fixes, answers to Frequently Asked Questions and updated versions of
this software are available.  For more information see:

    http://www.sleepycat.com

The file LICENSE has Berkeley DB copyright and redistribution information.

Sleepycat Software maintains an email list of people interested in new
features and future releases of DB.  Please send email to the address
below if you would like to be on that list.

To ask questions about Berkeley DB, report problems, request support
contract and licensing information, or to contact the authors for any
reason, please contact Sleepycat Software at one of the following
addresses:

	Sleepycat Software		db@sleepycat.com
	394 E. Riding Dr.		+1-617-633-2429
	Carlisle, MA 01741
	USA

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
The distribution layout is as follows:

    LICENSE ............ Copyright, use and redistribution information.
    README ............. This file.
    btree .............. B+tree access method source code.
    build.unix ......... UNIX build directory.
    build.unix/README .. UNIX build information.
    build.win16 ........ Windows 3.1 build directory
    build.win32 ........ Windows/95, Windows/NT build directory.
    build.win32/README . Windows/95, Windows/NT build information.
    clib ............... C library replacement source code.
    common ............. Source code shared by all of DB.
    cxx ................ C++ API.
    db ................. DB interface source code.
    db185 .............. Compatibility source code for DB version 1.85
    db_archive ......... The db_archive(1) utility source code.
    db_checkpoint ...... The db_checkpoint(1) utility source code.
    db_deadlock ........ The db_deadlock(1) utility source code.
    db_dump ............ The db_dump(1) utility source code.
    db_dump185 ......... The db_dump185(1) utility source code.
    db_load ............ The db_load(1) utility source code.
    db_printlog ........ Debugging utility, never installed.
    db_recover ......... The db_recover(1) utility source code.
    db_stat ............ The db_stat(1) utility source code.
    dbm ................ Compatibility source code for dbm(3) and ndbm(3).
    dist ............... Various files used to build the DB distribution.
    documents .......... DB documents (other than the UNIX-style manual pages).
    examples ........... C API example source code for using the DB library.
    examples_cxx ....... C++ API example source code for using the DB library.
    hash ............... Hash access method source code.
    hsearch ............ Compatibility source code for hsearch(3).
    include ............ Include files for DB.
    java ............... Java API.
    java/README ........ General Java API notes.
    libdb_java ......... Sources to build the libdb_java shared library.
    lock ............... Lock manager source code.
    log ................ Log manager source code.
    man/man.html ....... C, C++ and Java API HTML format manual pages.
    man/man.ps ......... C API PostScript format manual pages.
    man/man.roff ....... C API troff format (man macros) manual pages.
    man/man.text ....... C API flat text manual pages.
    man/mancxx.ps ...... C++ API PostScript format manual pages.
    man/mancxx.roff .... C++ API troff format (man macros) manual pages.
    man/mancxx.text .... C++ API flat text manual pages.
    mp ................. Shared memory buffer pool source code.
    mutex .............. Spin-lock source code.
    os ................. Operating-system specific functionality.
    os.win16 ........... Operating-system specific functionality (Win16).
    os.win32 ........... Operating-system specific functionality (Win32/WNT).
    test ............... Test directory.
    test/README ........ UNIX test information.
    test/README.win32 .. UNIX test information.
    txn ................ Transaction manager source code.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
To build Berkeley DB for a UNIX platform:

    cd build.unix
    ../dist/configure
    make

To build multiple UNIX versions of Berkeley DB in the same source tree,
create a new directory, then configure and build.

    mkdir build.bsdos3.0
    cd build.bsdos3.0
    ../dist/configure
    make

For additional information about building Berkeley DB for UNIX platforms,
the description of possible configuration options and other information
on DB configuration and build issues, see the file build.unix/README.

To build Berkeley DB for a WIN32 platform, see build.win32/README.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
The C++ API files and directories in the source distribution are:

db/cxx/			C++ API
db/examples_cxx/	The example programs recoded in C++.
db/include/cxx_int.h	Internal C++ include file.
db/include/db_cxx.h	External C++ include file.

C++ support is automatically built on Win32.  To configure it under
UNIX, specify --enable-cxx as a configuration argument (see the file
db/build.unix/README for more information).

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
The Java API files and directories in the source distribution are:

db/java/src/com/sleepycat/db
			The Java API
db/java/README		Information on building the Java API.
db/man/man.html/index_java.html
			The Java API manual pages (available only in HTML).
db/java/src/com/sleepycat/examples/
			The example programs recoded in Java.
db/libdb_java		Sources to build the libdb_java shared library.

Java support is NEVER automatically built.  To configure and build the
Java API, see the file db/java/README for more information.