source: server/databases/db.xml@ 5f0bab7

<?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 db-download-http " ">
  <!ENTITY db-download-ftp  "ftp://sleepycat1.inetu.net/releases/db-&db-version;.tar.gz">
  <!ENTITY db-md5sum        "fcc481d52c3b80e20a328f8c0cb042bd">
  <!ENTITY db-size          "5.7 MB">
  <!ENTITY db-buildsize     "68 MB (additional 140 MB to run parallel standard testsuite)">
  <!ENTITY db-time          "1.23 SBU (additional 74.5 SBU to run parallel standard testsuite)">
]>

<sect1 id="db" xreflabel="Berkeley DB-&db-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="db.html"?>
<title>Berkeley DB-&db-version;</title>
<indexterm zone="db">
<primary sortas="a-Berkeley-DB">Berkeley DB</primary></indexterm>

<sect2>
<title>Introduction to <application>Berkeley DB</application></title>

<para>The <application>Berkeley DB</application> package contains programs and
utilities used by many other applications for database related
functions.</para>

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

<sect3><title><application>Berkeley DB</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="tcl"/> and <xref linkend="jdk"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Berkeley DB</application></title>

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

<screen><userinput><command>cd build_unix &amp;&amp;
../dist/configure --prefix=/usr \
    --enable-compat185 \
    --enable-cxx &amp;&amp;
make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread"</command></userinput></screen>

<para>To test the results, start <command>tclsh</command> and issue:</para>

<screen><userinput><command>source ../test/test.tcl
run_parallel run_std</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make docdir=/usr/share/doc/db-&db-version; install &amp;&amp;
chown root:root /usr/bin/db_* \
/usr/lib/libdb* /usr/include/db* &amp;&amp;
chown -R root:root /usr/share/doc/db-&db-version;</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>cd build_unix &amp;&amp; 
../dist/configure --prefix=/usr...</command>: 
This replaces the normal <command>./configure</command> command, as
<application>Berkeley DB</application> comes with various 
build directories for different platforms.</para>

<para><parameter>--enable-compat185</parameter>: This switch enables
building DB 1.85 compatibility <acronym>API</acronym>.</para>

<para><parameter>--enable-cxx</parameter>: This switch enables building
C++ <acronym>API</acronym> libraries.</para>

<para><command>make LIBSO_LIBS="-lpthread"
LIBXSO_LIBS="-lpthread"</command>:  <command>configure</command> does not 
correctly handle <acronym>NPTL</acronym>. These variables force it to 
properly link against <acronym>NPTL</acronym>.</para> 

<para><command>make docdir=/usr/share/doc/db-&db-version; 
install</command>: This installs the documentation in
the correct place.</para>

<para><option>--enable-test</option>: Enables building the test suite
(requires the two Tcl switches below).</para>

<para><option>--enable-tcl --with-tcl=/usr/lib</option>:
Enables <application>Tcl</application> support in DB and creates the
<filename class="libraryfile">libdb_tcl</filename> libraries.</para>

<para><option>--enable-java</option>: Enables <application>Java</application>
support in DB and creates the 
<filename class='libraryfile'>libdb_java</filename> libraries.</para>

<para><option>--enable-rpc</option>: Enables building the 
<application>Berkeley DB</application> <acronym>RPC</acronym> server.</para>

</sect2>

<sect2>
<title>Contents</title>

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

<seglistitem>
<seg>berkeley_db_svc, db_archive, db_checkpoint, db_deadlock, db_dump, 
db_load, db_printlog, db_recover, db_stat, db_upgrade and db_verify</seg>
<seg>libdb.[so,a], libdb_cxx.[so,a], libdb_java.[so,a] and 
libdb_tcl.[so,a]</seg>
<seg>/usr/share/doc/db-&db-version;</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="berkeley_db_svc">
<term><command>berkeley_db_svc</command></term>
<listitem><para>is the <application>Berkeley DB</application> 
<acronym>RPC</acronym> server.</para>
<indexterm zone="db berkeley_db_svc">
<primary sortas="b-berkeley_db_svc">berkeley_db_svc</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_archive">
<term><command>db_archive</command></term>
<listitem><para>prints the pathnames of log files that are no longer in 
use.</para>
<indexterm zone="db db_archive">
<primary sortas="b-db_archive">db_archive</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_checkpoint">
<term><command>db_checkpoint</command></term>
<listitem><para>is a daemon process used to monitor and checkpoint database 
logs.</para>
<indexterm zone="db db_checkpoint">
<primary sortas="b-db_checkpoint">db_checkpoint</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_deadlock">
<term><command>db_deadlock</command></term>
<listitem><para>is used to abort lock requests when deadlocks are 
detected.</para>
<indexterm zone="db db_deadlock">
<primary sortas="b-db_deadlock">db_deadlock</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_dump">
<term><command>db_dump</command></term>
<listitem><para>converts database files to a flat file format readable by 
<command>db_load</command>.</para>
<indexterm zone="db db_dump">
<primary sortas="b-db_dump">db_dump</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_load">
<term><command>db_load</command></term>
<listitem><para>is used to create database files from flat files created with 
<command>db_dump</command>.</para>
<indexterm zone="db db_load">
<primary sortas="b-db_load">db_load</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_printlog">
<term><command>db_printlog</command></term>
<listitem><para>converts database log files to human readable text.</para>
<indexterm zone="db db_printlog">
<primary sortas="b-db_printlog">db_printlog</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_recover">
<term><command>db_recover</command></term>
<listitem><para>is used to restore a database to a consistent state after a 
failure.</para>
<indexterm zone="db db_recover">
<primary sortas="b-db_recover">db_recover</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_stat">
<term><command>db_stat</command></term>
<listitem><para>displays database environment statistics.</para>
<indexterm zone="db db_stat">
<primary sortas="b-db_stat">db_stat</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_upgrade">
<term><command>db_upgrade</command></term>
<listitem><para>is used to upgrade database files to a newer version of 
<application>Berkeley DB</application>.</para>
<indexterm zone="db db_upgrade">
<primary sortas="b-db_upgrade">db_upgrade</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="db_verify">
<term><command>db_verify</command></term>
<listitem><para>is used to run consistency checks on database files.</para>
<indexterm zone="db db_verify">
<primary sortas="b-db_verify">db_verify</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>