path: root/README
diff options
authorSergey Poznyakoff <gray@gnu.org.ua>2011-08-03 21:07:36 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2011-08-03 21:07:36 +0000
commit131ddf402e184a45963e9c61af74571ef2ea2c1a (patch)
tree6762d48fdacae7d5986a2f32c498945785d3bc93 /README
parent2bfd5fd7a5f1fec18200cf3b22d1e23cbdcd8f13 (diff)
Diffstat (limited to 'README')
1 files changed, 66 insertions, 36 deletions
diff --git a/README b/README
index f30d688..7e416f8 100644
--- a/README
+++ b/README
@@ -1,56 +1,86 @@
-GNU dbm is a set of database routines that use extendible hashing and
-works similar to the standard UNIX dbm routines.
+Copyright (C) 2011 Free Software Foundation, Inc.
+See the end of file for copying conditions.
+* Introduction
+This file contains brief information about configuring, testing
+and using GNU dbm. It is *not* intended as a replacement
+for the documentation, instead it is provided as a brief reference
+only. The complete documentation is available in doc/ subdirectory.
+To read the manpage without installing the package use `man
+doc/gdbm.3'. To read texinfo documentation without installing the
+package, run `info -f doc/gdbm.info'. After the package is installed
+the documentation can be accessed by running `man gdbm' and
+`info gdbm'.
-This is release 1.9.0 of GNU dbm.
+* Overview
-To compile gdbm:
+GNU dbm is a set of database routines that use extendible hashing and
+works similar to the standard UNIX dbm routines. The library provides
+also an optional compatibility layer for UNIX-like dbm and ndbm calls.
+* Configuration
- a) configure <config parameters like -prefix ... see INSTALL>
+ a) configure [PARAMETERS]
b) make
-To compile the optional test and conversion programs:
+For a list of generic PARAMETERS, see the file INCLUDE. The gdbm-specific
+parameters are:
+** --enable-memory-mapped-io
+Enable the use of mmap(2) for I/O optimizations. This is the default,
+if mmap is available. To disable mmap, use --disable-memory-mapped-io.
+** --enable-libgdbm-compat
+Build and install libgdbm_compat, a compatibility layer which provides
+UNIX-like dbm and ndbm interfaces.
+** --enable-gdbm-export
+Build and install gdbmexport with specified gdbm 1.8 library.
- a) make progs
+** --with-gdbm183-library=LIB
-To install the basic package:
+Build gdbmexport with specified (static) library. LIB must be
+a loader argument valid for the use with cc(1), e.g.: -lgdbm-1.8.
- a) make install
+** --gdbm183-libdir=DIR
-To install the optional dbm and ndbm API compatibility library and headers:
+Build gdbmexport with the gdbm library from the specified directory.
- a) make install-compat
+** --gdbm183-includedir=DIR
-Please report bugs to
- bug-gnu-utils@gnu.org
+Build gdbmexport with gdbm.h from the specified directory.
+* Installation
-The files are:
+ make install
-INSTALL - Installation tips and information.
-NEWS - New and changed things.
-COPYING - Copying information.
-README - This file.
+* Bug reporting
-bucket.c, extern.h, falloc.c, findkey.c, gdbm.proto, gdbmclose.c,
-gdbmconst.h gdbmdefs.h, gdbmdelete.c, gdbmerrno.h, gdbmfdesc.c, gdbmfetch.c,
-gdbmsync.c, gdbmopen.c, gdbmreorg.c, gdbmseq.c, gdbmstore.c, global.c, gdbm.h,
-hash.c systems.h, update.c, version.c - Source for GNU dbm library.
+Please report bugs to <bug-gdbm@gnu.org>
-dbm.h dbminit.c, delete.c, fetch.c, seq.c, store.c - Source for the
-DBM interface.
+* Copyright information:
-dbmclose.c, dbmdelete.c, dbmdirfno.c, dbmfetch.c, dbmopen.c, dbmpagfno.c
-dbmseq.c, dbmstore.c, ndbm.h - Source for the NDBM interface.
+Copyright (C) 2011 Free Software Foundation, Inc.
-Makefile - Makefile, will make gdbm.a (BSD and SYSV)
-testgdbm.c - A simple test program.
-testdbm.c - A simple test program.
-testndbm.c - A simple test program.
-conv2gdbm.c - A dbm database conversion program.
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
-gdbm.3, gdbm.texinfo - Documentation for gdbm.
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
-The author of GNU dbm may be reached via e-mail to <phil@cs.wwu.edu>,
-and the current maintainer may be reached at <downsj@downsj.com>.
-E-mail may be sent to either, or both, of these people.
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never

Return to:

Send suggestions and report system problems to the System administrator.