README

   1 GNU dbm README
   2 Copyright (C) 2011 Free Software Foundation, Inc.
   3 See the end of file for copying conditions.
   4
   5 * Introduction
   6
   7 This file contains brief information about configuring, testing
   8 and using GNU dbm.  It is *not* intended as a replacement
   9 for the documentation, instead it is provided as a brief reference
  10 only. The complete documentation is available in doc/ subdirectory.
  11 To read the manpage without installing the package use `man
  12 doc/gdbm.3'.  To read texinfo documentation without installing the
  13 package, run `info -f doc/gdbm.info'.  After the package is installed
  14 the documentation can be accessed by running `man gdbm' and
  15 `info gdbm'.
  16
  17 * Overview
  18
  19 GNU dbm is a set of database routines that use extendible hashing and
  20 works similar to the standard UNIX dbm routines.  The library provides
  21 also an optional compatibility layer for UNIX-like dbm and ndbm calls.
  22
  23 * Configuration
  24
  25    a)  configure [PARAMETERS]
  26    b)  make
  27
  28 For a list of generic PARAMETERS, see the file INCLUDE.  The gdbm-specific
  29 parameters are:
  30
  31 ** --enable-memory-mapped-io
  32
  33 Enable the use of mmap(2) for I/O optimizations.  This is the default,
  34 if mmap is available.  To disable mmap, use --disable-memory-mapped-io.
  35
  36 ** --enable-libgdbm-compat
  37
  38 Build and install libgdbm_compat, a compatibility layer which provides
  39 UNIX-like dbm and ndbm interfaces.
  40
  41 ** --enable-gdbm-export
  42
  43 Build and install gdbmexport with the specified gdbm 1.8 library.
  44
  45 ** --with-gdbm183-library=LIB
  46
  47 Build gdbmexport with specified (static) library.  LIB must be
  48 a loader argument valid for the use with cc(1), e.g.: -lgdbm-1.8.
  49
  50 ** --gdbm183-libdir=DIR
  51
  52 Build gdbmexport with the gdbm library from the specified directory.
  53
  54 ** --gdbm183-includedir=DIR
  55
  56 Build gdbmexport with gdbm.h from the specified directory.
  57
  58 * Installation
  59
  60   make install
  61
  62 * Bug reporting
  63
  64 Please report bugs to <bug-gdbm@gnu.org>
  65
  66 * Documentation, updates etc.
  67
  68 For the latest updates, visit <http://www.gnu.org/software/gdbm>,
  69
  70 In particular, a copy of GDBM documentation in various formats is
  71 available online at <http://www.gnu.org/software/gdbm/manual>.
  72
  73 Latest versions of GDBM can be downloaded from anonymous
  74 ftp://ftp.gnu.org/gnu/gdbm.
  75
  76 To track the development, visit
  77 <http://puszcza.gnu.org.ua/projects/gdbm>.
  78
  79 \f
  80 * Copyright information:
  81
  82 Copyright (C) 2011 Free Software Foundation, Inc.
  83
  84    Permission is granted to anyone to make or distribute verbatim copies
  85    of this document as received, in any medium, provided that the
  86    copyright notice and this permission notice are preserved,
  87    thus giving the recipient permission to redistribute in turn.
  88
  89    Permission is granted to distribute modified versions
  90    of this document, or of portions of it,
  91    under the above conditions, provided also that they
  92    carry prominent notices stating who last changed them.
  93
  94 \f
  95 Local Variables:
  96 mode: outline
  97 paragraph-separate: "[  \f]*$"
  98 version-control: never
  99 End: