db.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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. <sect1 id="ch-system-db" role="wrap">
  8. <?dbhtml filename="db.html"?>
  9. <sect1info condition="script">
  10. <productname>db</productname>
  11. <productnumber>&db-version;</productnumber>
  12. <address>&db-url;</address>
  13. </sect1info>
  14. <title>Berkeley DB-&db-version;</title>
  15. <indexterm zone="ch-system-db">
  16. <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Berkeley DB package contains programs and utilities used by many
  21. other applications for database related functions.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&db-ch6-sbu;</seg>
  27. <seg>&db-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. <tip>
  31. <title>Other Installation Possibilities</title>
  32. <para>There are instructions to build this package in the BLFS book if you
  33. need to build the RPC server or additional language bindings. The
  34. additional language bindings will require additional packages to be
  35. installed. See <ulink url="&blfs-root;view/svn/server/databases.html#db"/>
  36. for suggested installation instructions.</para>
  37. <para>Also, GDBM <emphasis>could</emphasis> be used in place of Berkeley
  38. DB to satisfy Man-DB. However, since Berkeley DB is considered a core part
  39. of the LFS build, it will not be listed as a dependency for any package in
  40. the BLFS book. Likewise, many hours go into testing LFS with Berkeley DB
  41. installed, not with GDBM. If you fully understand the risks versus
  42. benefits of using GDBM and wish to use it anyway, see the BLFS
  43. instructions located at <ulink
  44. url="&blfs-root;view/svn/general/gdbm.html"/></para>
  45. </tip>
  46. </sect2>
  47. <sect2 role="installation">
  48. <title>Installation of Berkeley DB</title>
  49. <para>Apply an upstream patch so that replication clients can open a
  50. sequence:</para>
  51. <screen><userinput remap="pre">patch -Np1 -i ../&db-fixes-patch;</userinput></screen>
  52. <para>Prepare Berkeley DB for compilation:</para>
  53. <screen><userinput remap="configure">cd build_unix
  54. ../dist/configure --prefix=/usr --enable-compat185 --enable-cxx</userinput></screen>
  55. <variablelist>
  56. <title>The meaning of the configure options:</title>
  57. <varlistentry>
  58. <term><parameter>--enable-compat185</parameter></term>
  59. <listitem>
  60. <para>This option enables building Berkeley DB 1.85 compatibility
  61. API.</para>
  62. </listitem>
  63. </varlistentry>
  64. <varlistentry>
  65. <term><parameter>--enable-cxx</parameter></term>
  66. <listitem>
  67. <para>This option enables building C++ API libraries.</para>
  68. </listitem>
  69. </varlistentry>
  70. </variablelist>
  71. <para>Compile the package:</para>
  72. <screen><userinput remap="make">make</userinput></screen>
  73. <para>It is not possible to test the package meaningfully, because
  74. that would involve building Tcl bindings. Tcl bindings cannot be
  75. built properly now because Tcl is linked against Glibc in
  76. <filename class="directory">/tools</filename>, not against Glibc in
  77. <filename class="directory">/usr</filename>.</para>
  78. <para>Install the package:</para>
  79. <screen><userinput remap="install">make docdir=/usr/share/doc/db-&db-version; install</userinput></screen>
  80. <variablelist>
  81. <title>The meaning of the make parameter:</title>
  82. <varlistentry>
  83. <term><parameter>docdir=...</parameter></term>
  84. <listitem>
  85. <para>This variable specifies the correct place for the
  86. documentation.</para>
  87. </listitem>
  88. </varlistentry>
  89. </variablelist>
  90. <para>Fix the ownership of the installed documentation:</para>
  91. <screen><userinput remap="install">chown -Rv root:root /usr/share/doc/db-&db-version;</userinput></screen>
  92. </sect2>
  93. <sect2 id="contents-db" role="content">
  94. <title>Contents of Berkeley DB</title>
  95. <segmentedlist>
  96. <segtitle>Installed programs</segtitle>
  97. <segtitle>Installed libraries</segtitle>
  98. <seglistitem>
  99. <seg>db_archive, db_checkpoint, db_codegen, db_deadlock, db_dump,
  100. db_hotbackup, db_load, db_printlog, db_recover, db_stat, db_upgrade, and
  101. db_verify</seg>
  102. <seg>libdb.{a,so}and libdb_cxx.{a,so}</seg>
  103. </seglistitem>
  104. </segmentedlist>
  105. <variablelist>
  106. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  107. <?dbfo list-presentation="list"?>
  108. <?dbhtml list-presentation="table"?>
  109. <varlistentry id="db_archive">
  110. <term><command>db_archive</command></term>
  111. <listitem>
  112. <para>Prints the pathnames of log files that are no longer in use</para>
  113. <indexterm zone="ch-system-db db_archive">
  114. <primary sortas="b-db_archive">db_archive</primary>
  115. </indexterm>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry id="db_checkpoint">
  119. <term><command>db_checkpoint</command></term>
  120. <listitem>
  121. <para>A daemon used to monitor and checkpoint database logs</para>
  122. <indexterm zone="ch-system-db db_checkpoint">
  123. <primary sortas="b-db_checkpoint">db_checkpoint</primary>
  124. </indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="db_codegen">
  128. <term><command>db_codegen</command></term>
  129. <listitem>
  130. <para>Generates application code to create and configure Berkeley DB
  131. database environments and databases based on a simple description
  132. language, and writes it to one or more output files</para>
  133. <indexterm zone="ch-system-db db_codegen">
  134. <primary sortas="b-db_codegen">db_codegen</primary>
  135. </indexterm>
  136. </listitem>
  137. </varlistentry>
  138. <varlistentry id="db_deadlock">
  139. <term><command>db_deadlock</command></term>
  140. <listitem>
  141. <para>A daemon used to abort lock requests when deadlocks are
  142. detected</para>
  143. <indexterm zone="ch-system-db db_deadlock">
  144. <primary sortas="b-db_deadlock">db_deadlock</primary>
  145. </indexterm>
  146. </listitem>
  147. </varlistentry>
  148. <varlistentry id="db_dump">
  149. <term><command>db_dump</command></term>
  150. <listitem>
  151. <para>Converts database files to a plain-text file format readable
  152. by <command>db_load</command></para>
  153. <indexterm zone="ch-system-db db_dump">
  154. <primary sortas="b-db_dump">db_dump</primary>
  155. </indexterm>
  156. </listitem>
  157. </varlistentry>
  158. <varlistentry id="db_hotbackup">
  159. <term><command>db_hotbackup</command></term>
  160. <listitem>
  161. <para>Creates <quote>hot backup</quote> or <quote>hot failover</quote>
  162. snapshots of Berkeley DB databases</para>
  163. <indexterm zone="ch-system-db db_hotbackup">
  164. <primary sortas="b-db_hotbackup">db_hotbackup</primary>
  165. </indexterm>
  166. </listitem>
  167. </varlistentry>
  168. <varlistentry id="db_load">
  169. <term><command>db_load</command></term>
  170. <listitem>
  171. <para>Is used to create database files from plain-text files</para>
  172. <indexterm zone="ch-system-db db_load">
  173. <primary sortas="b-db_load">db_load</primary>
  174. </indexterm>
  175. </listitem>
  176. </varlistentry>
  177. <varlistentry id="db_printlog">
  178. <term><command>db_printlog</command></term>
  179. <listitem>
  180. <para>Converts database log files to human readable text</para>
  181. <indexterm zone="ch-system-db db_printlog">
  182. <primary sortas="b-db_printlog">db_printlog</primary>
  183. </indexterm>
  184. </listitem>
  185. </varlistentry>
  186. <varlistentry id="db_recover">
  187. <term><command>db_recover</command></term>
  188. <listitem>
  189. <para>Is used to restore a database to a consistent state after a
  190. failure</para>
  191. <indexterm zone="ch-system-db db_recover">
  192. <primary sortas="b-db_recover">db_recover</primary>
  193. </indexterm>
  194. </listitem>
  195. </varlistentry>
  196. <varlistentry id="db_stat">
  197. <term><command>db_stat</command></term>
  198. <listitem>
  199. <para>Displays statistics for Berkeley databases</para>
  200. <indexterm zone="ch-system-db db_stat">
  201. <primary sortas="b-db_stat">db_stat</primary>
  202. </indexterm>
  203. </listitem>
  204. </varlistentry>
  205. <varlistentry id="db_upgrade">
  206. <term><command>db_upgrade</command></term>
  207. <listitem>
  208. <para>Is used to upgrade database files to a newer version of
  209. Berkeley DB</para>
  210. <indexterm zone="ch-system-db db_upgrade">
  211. <primary sortas="b-db_upgrade">db_upgrade</primary>
  212. </indexterm>
  213. </listitem>
  214. </varlistentry>
  215. <varlistentry id="db_verify">
  216. <term><command>db_verify</command></term>
  217. <listitem>
  218. <para>Is used to run consistency checks on database files</para>
  219. <indexterm zone="ch-system-db db_verify">
  220. <primary sortas="b-db_verify">db_verify</primary>
  221. </indexterm>
  222. </listitem>
  223. </varlistentry>
  224. <varlistentry id="libdb">
  225. <term><filename class="libraryfile">libdb.{so,a}</filename></term>
  226. <listitem>
  227. <para>Contains functions to manipulate database files from C
  228. programs</para>
  229. <indexterm zone="ch-system-db libdb">
  230. <primary sortas="c-libdb">libdb</primary>
  231. </indexterm>
  232. </listitem>
  233. </varlistentry>
  234. <varlistentry id="libdb_cxx">
  235. <term><filename class="libraryfile">libdb_cxx.{so,a}</filename></term>
  236. <listitem>
  237. <para>Contains functions to manipulate database files from C++
  238. programs</para>
  239. <indexterm zone="ch-system-db libdb_cxx">
  240. <primary sortas="c-libdb_cxx">libdb_cxx</primary>
  241. </indexterm>
  242. </listitem>
  243. </varlistentry>
  244. </variablelist>
  245. </sect2>
  246. </sect1>