source: gnome/add/libgda.xml@ 49b50d4

<?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 libgda-download-http "&gnome-download-http;/libgda/5.0/libgda-&libgda-version;.tar.xz">
  <!ENTITY libgda-download-ftp  "&gnome-download-ftp;/libgda/5.0/libgda-&libgda-version;.tar.xz">
  <!ENTITY libgda-md5sum        "58efdf8f727b5a0b1e5fb35d19ee76a7">
  <!ENTITY libgda-size          "11 MB">
  <!ENTITY libgda-buildsize     "196 MB">
  <!ENTITY libgda-time          "3.8 SBU">
]>

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

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

  <title>libgda-&libgda-version;</title>

  <indexterm zone="libgda">
    <primary sortas="a-libgda">libgda</primary>
  </indexterm>

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

    <para>
      The <application>libgda</application> package provides a database access
      library for the <application>GNOME</application> project.
    </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="intltool"/>,
      <xref linkend="libxml2"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="iso-codes"/>,
      <xref linkend="libgnome-keyring"/>,
      <xref linkend="libsoup"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="db"/>,
      <ulink url="http://www.firebirdsql.org/">firebird</ulink>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="gtksourceview"/>,
      <xref linkend="openjdk"/>,
      <xref linkend="mysql"/>,
      <xref linkend="openldap"/> and
      <xref linkend="postgresql"/>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --enable-system-sqlite &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>. Note that the 
      output is voluminous, and some tests appear to need the package to have been
      installed.
    </para>

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

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

  </sect2>

  <sect2 role="commands">

    <title>Command Explanations</title>

    <para>
      <option>--enable-system-sqlite</option>: use the system version of
      <application>Sqlite3</application>.  Note that you must have compiled
      <application>Sqlite3</application> with -DSQLITE_ENABLE_COLUMN_METADATA
      otherwise the internal version will be used.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gda-browser-5.0, gda-control-center-5.0, gda-list-config-5.0,
          gda-list-jdbc-providers-5.0, gda-list-server-op-5.0,
          gda-sql-5.0, gda-test-connection-5.0 and gdaui-demo-5.0
        </seg>
        <seg>
          libgda-5.0.so, libgda-report-5.0.so, libgda-ui-5.0.so and
          libgda-xslt-5.0.so
        </seg>
        <seg>
          /etc/libgda-5.0,
          /usr/include/libgda-5.0,
          /usr/lib/libgda-5.0,
          /usr/share/gnome/help/{gda-browser,gda-sql},
          /usr/share/gtk-doc/html/{gda-browser,libgda-5.0} and
          /usr/share/libgda-5.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gda-browser-5.0">
        <term><command>gda-browser-5.0</command></term>
        <listitem>
          <para>
            is a graphical tool to provide a quick access to a database's
            structure and contents.
          </para>
          <indexterm zone="libgda gda-browser-5.0">
            <primary sortas="b-gda-browser-5.0">gda-browser-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gda-control-center-5.0">
        <term><command>gda-control-center-5.0</command></term>
        <listitem>
          <para>
            is a configuration tool for <application>libgda</application>.
          </para>
          <indexterm zone="libgda gda-control-center-5.0">
            <primary sortas="b-gda-control-center-5.0">gda-control-center-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gda-list-config-5.0">
        <term><command>gda-list-config-5.0</command></term>
        <listitem>
          <para>
            lists all the declared data sources and all the installed providers.
          </para>
          <indexterm zone="libgda gda-list-config-5.0">
            <primary sortas="b-gda-list-config-5.0">gda-list-config-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gda-list-server-op-5.0">
        <term><command>gda-list-server-op-5.0</command></term>
        <listitem>
          <para>
            lists available DDL operations for one or all of the installed providers.
          </para>
          <indexterm zone="libgda gda-list-server-op-5.0">
            <primary sortas="b-gda-list-server-op-5.0">gda-list-server-op-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gda-sql-5.0">
        <term><command>gda-sql-5.0</command></term>
        <listitem>
          <para>
            is an interactive commandline tool used to run SQL commands.
          </para>
          <indexterm zone="libgda gda-sql-5.0">
            <primary sortas="b-gda-sql-5.0">gda-sql-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gda-test-connection-5.0">
        <term><command>gda-test-connection-5.0</command></term>
        <listitem>
          <para>
            is a 'ping' like tool to test connectivity to databases.
          </para>
          <indexterm zone="libgda gda-test-connection-5.0">
            <primary sortas="b-gda-test-connection-5.0">gda-test-connection-5.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgda-5">
        <term><filename class='libraryfile'>libgda-5.0.so</filename></term>
        <listitem>
          <para>
            is the <application>GNOME</application> Data Access library.
          </para>
          <indexterm zone="libgda libgda-5">
            <primary sortas="c-libgda-5">libgda-5.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgda-ui-5">
        <term><filename class='libraryfile'>libgda-ui-5.0.so</filename></term>
        <listitem>
          <para>
            is the GDA UI extension.
          </para>
          <indexterm zone="libgda libgda-ui-5">
            <primary sortas="c-libgda-ui-5">libgda-ui-5.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgda-xslt-5">
        <term><filename class='libraryfile'>libgda-xslt-5.0.so</filename></term>
        <listitem>
          <para>
            is the GDA XSLT extension.
          </para>
          <indexterm zone="libgda libgda-xslt-5">
            <primary sortas="c-libgda-xslt-5">libgda-xslt-5.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>