BOOK/chapter08/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 works 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-fin-sbu;</seg>
  38         <seg>&gdbm-fin-du;</seg>
  39       </seglistitem>
  40     </segmentedlist>
  41
  42   </sect2>
  43
  44   <sect2 role="installation">
  45     <title>Installation of GDBM</title>
  46 <!--
  47     <para>First, fix an issue first identified by gcc-10:</para>
  48
  49 <screen><userinput remap="pre">sed -r -i '/^char.*parseopt_program_(doc|args)/d' src/parseopt.c</userinput></screen>
  50 -->
  51     <para>Prepare GDBM for compilation:</para>
  52
  53 <screen><userinput remap="configure">./configure --prefix=/usr    \
  54             --disable-static \
  55             --enable-libgdbm-compat</userinput></screen>
  56
  57     <variablelist>
  58       <title>The meaning of the configure option:</title>
  59
  60       <varlistentry>
  61         <term><envar>--enable-libgdbm-compat</envar></term>
  62         <listitem>
  63           <para>This switch enables building the libgdbm compatibility library.
  64           Some packages outside of LFS may require the older DBM
  65           routines it provides.</para>
  66         </listitem>
  67       </varlistentry>
  68     </variablelist>
  69
  70     <para>Compile the package:</para>
  71
  72 <screen><userinput remap="make">make</userinput></screen>
  73
  74     <para>To test the results, issue:</para>
  75
  76 <screen><userinput remap="test">make check</userinput></screen>
  77
  78     <para>
  79       One test, <filename>VERSION</filename>, is known to fail.
  80     </para>
  81
  82     <para>Install the package:</para>
  83
  84 <screen><userinput remap="install">make install</userinput></screen>
  85
  86   </sect2>
  87
  88   <sect2 id="contents-gdbm" role="content">
  89     <title>Contents of GDBM</title>
  90
  91     <segmentedlist>
  92       <segtitle>Installed programs</segtitle>
  93       <segtitle>Installed libraries</segtitle>
  94
  95       <seglistitem>
  96         <seg>gdbm_dump, gdbm_load, and gdbmtool</seg>
  97         <seg>libgdbm.so and libgdbm_compat.so</seg>
  98       </seglistitem>
  99     </segmentedlist>
 100
 101     <variablelist>
 102       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 103       <?dbfo list-presentation="list"?>
 104       <?dbhtml list-presentation="table"?>
 105
 106       <varlistentry id="gdbm_dump">
 107         <term><command>gdbm_dump</command></term>
 108         <listitem>
 109           <para>Dumps a GDBM database to a file</para>
 110           <indexterm zone="ch-system-gdbm gdbm_dump">
 111             <primary sortas="b-gdbm_dump">gdbm_dump</primary>
 112           </indexterm>
 113         </listitem>
 114       </varlistentry>
 115
 116       <varlistentry id="gdbm_load">
 117         <term><command>gdbm_load</command></term>
 118         <listitem>
 119           <para>Recreates a GDBM database from a dump file</para>
 120           <indexterm zone="ch-system-gdbm gdbm_load">
 121             <primary sortas="b-gdbm_load">gdbm_load</primary>
 122           </indexterm>
 123         </listitem>
 124       </varlistentry>
 125
 126       <varlistentry id="gdbmtool">
 127         <term><command>gdbmtool</command></term>
 128         <listitem>
 129           <para>Tests and modifies a GDBM database</para>
 130           <indexterm zone="ch-system-gdbm gdbmtool">
 131             <primary sortas="b-gdbmtool">gdbmtool</primary>
 132           </indexterm>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry id="libgdbm">
 137         <term><filename class="libraryfile">libgdbm</filename></term>
 138         <listitem>
 139           <para>Contains functions to manipulate a hashed database</para>
 140           <indexterm zone="ch-system-gdbm libgdbm">
 141             <primary sortas="c-libgdbm">libgdbm</primary>
 142           </indexterm>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry id="libgdbm_compat">
 147         <term><filename class="libraryfile">libgdbm_compat</filename></term>
 148         <listitem>
 149           <para>Compatibility library containing older DBM functions</para>
 150           <indexterm zone="ch-system-gdbm libgdbm_compat">
 151             <primary sortas="c-libgdbm_compat">libgdbm_compat</primary>
 152           </indexterm>
 153         </listitem>
 154       </varlistentry>
 155
 156     </variablelist>
 157
 158   </sect2>
 159
 160 </sect1>