glfs/server/databases/sqlite.xml

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

  <!ENTITY sqlite-download-http "http://sqlite.org/sqlite-amalgamation-&sqlite-version;.tar.gz">
  <!ENTITY sqlite-download-ftp  " ">
  <!ENTITY sqlite-md5sum        "74fe78b264f1c434c4b159d45b78e9b7">
  <!ENTITY sqlite-size          "1.5 MB">
  <!ENTITY sqlite-buildsize     "30 MB (includes optional documentation)">
  <!ENTITY sqlite-time          "0.4 SBU">

  <!ENTITY sqlite-docs-version  "3_7_3">
  <!ENTITY sqlite-docs-md5sum   "ed6f040910936cf57ad55045fa3bcb1d">
  <!ENTITY sqlite-docs-size     "3.2 MB">
  <!ENTITY sqlite-docs-download "http://sqlite.org/sqlite_docs_&sqlite-docs-version;.zip">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>SQLite-&sqlite-version;</title>

  <indexterm zone="sqlite">
    <primary sortas="a-SQLite">SQLite</primary>
  </indexterm>

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

    <para>The <application>SQLite</application> package is a software
    library that implements a self-contained, serverless,
    zero-configuration, transactional SQL database engine.</para>

    &lfs67_checked;

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

    <!-- <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="tcl"/> (Required to run the test suite)</para> -->

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <title>Optional Documentation</title>
      <listitem>
        <para>Download (HTTP): <ulink url="&sqlite-docs-download;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &sqlite-docs-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &sqlite-docs-size;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">SQLite Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="unzip"/> (Required to unzip the documentation)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/sqlite"/></para>

  </sect2>

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

    <para>If you downloaded the optional documentation, issue the following
    command to install the documentation into the source tree:</para>

<screen><userinput>unzip -q ../sqlite_docs_&sqlite-docs-version;.zip</userinput></screen>

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

<screen><userinput>CFLAGS="-g -O2 -DSQLITE_SECURE_DELETE -DSQLITE_ENABLE_UNLOCK_NOTIFY=1" \
            ./configure --prefix=/usr \
            --enable-threadsafe \
            --enable-readline \
            --enable-dynamic-extensions &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 install</userinput></screen>

    <para>If you downloaded the optional documentation, issue the following
    commands as the <systemitem class="username">root</systemitem> user to
    install it:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/sqlite-&sqlite-version; &amp;&amp;
cp      -v -R       sqlite-&sqlite-docs-version;-docs/* \
                    /usr/share/doc/sqlite-&sqlite-version;</userinput></screen>

  </sect2>

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

    <para><parameter>CFLAGS="-g -O2 -DSQLITE_SECURE_DELETE -DSQLITE_ENABLE_UNLOCK_NOTIFY=1"
    </parameter>: Applications such as <application>firefox</application> require
    secure delete and enable unlock notify to be turned on.  The only way to do
    this is to include them in the CFLAGS.  By default, these are set to
    <literal>"-g -O2"</literal> so we specify that to preserve those settings.
    You may, of course, wish to omit the <literal>'-g'</literal> if you do not
    wish to create debugging information.  For further information on what can
    be specified see <ulink url="http://www.sqlite.org/compile.html"/>.</para>

    <para><parameter>--enable-threadsafe</parameter>: Though the documentation
    and running <command>./configure --help</command> indicate that this is the
    default, it is not. You must add this parameter if you want a threadsafe
    library.</para>

    <para><parameter>--enable-readline</parameter>: This parameter enables
    command line editing capability to the <command>sqlite3</command>
    program.</para>

    <para><parameter>--enable-dynamic-extensions</parameter>: This creates
    library modules that are dynamically linked as needed instead of statically
    linking them into the main <application>SQLite</application> library.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>sqlite3</seg>
        <seg>libsqlite3.{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="sqlite3">
        <term><command>sqlite3</command></term>
        <listitem>
          <para>A terminal-based front-end to the <application>SQLite
          </application> library that can evaluate queries interactively
          and display the results.</para>
          <indexterm zone="sqlite sqlite3">
            <primary sortas="b-sqlite3">sqlite3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsqlite3">
        <term><filename class='libraryfile'>libsqlite3.{so,a}</filename></term>
        <listitem>
          <para>Contains the <application>SQLite</application> API functions.</para>
          <indexterm zone="sqlite libsqlite3">
            <primary sortas="c-libsqlite3">libsqlite3.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>