source: general/genlib/gdbm.xml@ 4f26c54

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gdbm-download-http "http://ftp.gnu.org/gnu/gdbm/gdbm-&gdbm-version;.tar.gz">
  <!ENTITY gdbm-download-ftp "ftp://ftp.gnu.org/gnu/gdbm/gdbm-&gdbm-version;.tar.gz">
  <!ENTITY gdbm-md5sum "1d1b1d5c0245b1c00aff92da751e9aa1">
  <!ENTITY gdbm-size "223 KB">
  <!ENTITY gdbm-buildsize "2.75 MB">
  <!ENTITY gdbm-time "0.08 SBU">
]>

<sect1 id="gdbm" xreflabel="GDBM-&gdbm-version;">
  <?dbhtml filename="gdbm.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gdbm-&gdbm-version;.tar</keyword>
      <keyword role="ftptdir">gdbm</keyword>
    </keywordset>
  </sect1info>

  <title>GDBM-&gdbm-version;</title>

  <indexterm zone="gdbm">
    <primary sortas="a-GDBM">GDBM</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GDBM</title>

    <para>The <application>GDBM</application> package contains the
    GNU Database Manager. This is a disk file format database which stores
    key/data-pairs in single files. The actual data of any record being stored
    is indexed by a unique key, which can be retrieved in less time than if it
    was stored in a text file.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&gdbm-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gdbm-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gdbm-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gdbm-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gdbm-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gdbm-time;</para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GDBM</title>

    <para>Install <application>GDBM</application> by running
    the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make BINOWN=root BINGRP=root install</userinput></screen>

    <para>In addition, you may need to install the <application>DBM</application>
    and <application>NDBM</application> compatibility headers and library since
    some applications look for these older dbm routines.</para>

<screen role="root"><userinput>make BINOWN=root BINGRP=root install-compat</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>make BINOWN=root BINGRP=root install</command>: This
    command overrides the <varname>BINOWN</varname> and
    <varname>BINGRP</varname> variables in the <filename>Makefile</filename>
    changing ownership of the installed files to
    <systemitem class='username'>root</systemitem> instead of the
    <systemitem class='username'>bin</systemitem> user.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libgdbm.[so,a] and libgdbm_compat.[so,a]</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libgdbm">
        <term><filename class='libraryfile'>libgdbm.[so,a]</filename></term>
        <listitem>
          <para>contains functions to manipulate a hashed database.</para>
          <indexterm zone="gdbm libgdbm">
            <primary sortas="c-libgdbm">libgdbm.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>