BOOK/chapter06/gdbm.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-gdbm" role="wrap">
   9   <?dbhtml filename="gdbm.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>gdbm</productname>
  13     <productnumber>&gdbm-version;</productnumber>
  14     <address>&gdbm-url;</address>
  15   </sect1info>
  16
  17   <title>GDBM-&gdbm-version;</title>
  18
  19   <indexterm zone="ch-system-gdbm">
  20     <primary sortas="a-Gdbm">GDBM</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The GDBM package contains the GNU Database Manager.  It is a library
  27     of database functions that use extensible hashing and work similar to the
  28     standard UNIX dbm.  The library provides primitives for storing key/data
  29     pairs, searching and retrieving the data by its key and deleting a key
  30     along with its data. </para>
  31
  32     <segmentedlist>
  33       <segtitle>&buildtime;</segtitle>
  34       <segtitle>&diskspace;</segtitle>
  35
  36       <seglistitem>
  37         <seg>&gdbm-ch6-sbu;</seg>
  38         <seg>&gdbm-ch6-du;</seg>
  39       </seglistitem>
  40     </segmentedlist>
  41
  42   </sect2>
  43
  44   <sect2 role="installation">
  45     <title>Installation of GDBM</title>
  46
  47     <para>Prepare GDBM for compilation:</para>
  48
  49 <screen><userinput remap="configure">./configure --prefix=/usr    \
  50             --disable-static \
  51             --enable-libgdbm-compat</userinput></screen>
  52
  53     <variablelist>
  54       <title>The meaning of the configure option:</title>
  55
  56       <varlistentry>
  57         <term><envar>--enable-libgdbm-compat</envar></term>
  58         <listitem>
  59           <para>This switch enables the libgdbm compatibility library to be
  60           built, as some packages outside of LFS may require the older DBM
  61           routines it provides.</para>
  62         </listitem>
  63       </varlistentry>
  64     </variablelist>
  65
  66     <para>Compile the package:</para>
  67
  68 <screen><userinput remap="make">make</userinput></screen>
  69
  70     <para>To test the results, issue:</para>
  71
  72 <screen><userinput remap="test">make check</userinput></screen>
  73
  74     <para>Install the package:</para>
  75
  76 <screen><userinput remap="install">make install</userinput></screen>
  77
  78   </sect2>
  79
  80   <sect2 id="contents-gdbm" role="content">
  81     <title>Contents of GDBM</title>
  82
  83     <segmentedlist>
  84       <segtitle>Installed programs</segtitle>
  85       <segtitle>Installed libraries</segtitle>
  86
  87       <seglistitem>
  88         <seg>gdbm_dump, gdbm_load, and gdbmtool</seg>
  89         <seg>libgdbm.so and libgdbm_compat.so</seg>
  90       </seglistitem>
  91     </segmentedlist>
  92
  93     <variablelist>
  94       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  95       <?dbfo list-presentation="list"?>
  96       <?dbhtml list-presentation="table"?>
  97
  98       <varlistentry id="gdbm_dump">
  99         <term><command>gdbm_dump</command></term>
 100         <listitem>
 101           <para>Dumps a GDBM database to a file</para>
 102           <indexterm zone="ch-system-gdbm gdbm_dump">
 103             <primary sortas="b-gdbm_dump">gdbm_dump</primary>
 104           </indexterm>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry id="gdbm_load">
 109         <term><command>gdbm_load</command></term>
 110         <listitem>
 111           <para>Recreates a GDBM database from a dump file</para>
 112           <indexterm zone="ch-system-gdbm gdbm_load">
 113             <primary sortas="b-gdbm_load">gdbm_load</primary>
 114           </indexterm>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry id="gdbmtool">
 119         <term><command>gdbmtool</command></term>
 120         <listitem>
 121           <para>Tests and modifies a GDBM database</para>
 122           <indexterm zone="ch-system-gdbm gdbmtool">
 123             <primary sortas="b-gdbmtool">gdbmtool</primary>
 124           </indexterm>
 125         </listitem>
 126       </varlistentry>
 127
 128       <varlistentry id="libgdbm">
 129         <term><filename class="libraryfile">libgdbm</filename></term>
 130         <listitem>
 131           <para>Contains functions to manipulate a hashed database</para>
 132           <indexterm zone="ch-system-gdbm libgdbm">
 133             <primary sortas="c-libgdbm">libgdbm</primary>
 134           </indexterm>
 135         </listitem>
 136       </varlistentry>
 137
 138       <varlistentry id="libgdbm_compat">
 139         <term><filename class="libraryfile">libgdbm_compat</filename></term>
 140         <listitem>
 141           <para>Compatibility library containing older DBM functions</para>
 142           <indexterm zone="ch-system-gdbm libgdbm_compat">
 143             <primary sortas="c-libgdbm_compat">libgdbm_compat</primary>
 144           </indexterm>
 145         </listitem>
 146       </varlistentry>
 147
 148     </variablelist>
 149
 150   </sect2>
 151
 152 </sect1>