glfs/general/genlib/libiodbc.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 libiodbc-download-http "&sourceforge-dl;/iodbc/libiodbc-&libiodbc-version;.tar.gz">
  <!ENTITY libiodbc-download-ftp  " ">
  <!ENTITY libiodbc-md5sum        "89949a41e542bb1b880d7fcc4987dad2">
  <!ENTITY libiodbc-size          "1.0 MB">
  <!ENTITY libiodbc-buildsize     "26 MB">
  <!ENTITY libiodbc-time          "0.2 SBU">
]>

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


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

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

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

    <para>
      <application>libiodbc</application> is an API to ODBC compatible
      databases.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gtk2"/> (to create the GUI admin tool)
    </para>


  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr                   \
            --with-iodbc-inidir=/etc/iodbc  \
            --includedir=/usr/include/iodbc \
            --disable-libodbc               \
            --disable-static                &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>

  </sect2>

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

    <para>
      <parameter>--with-iodbc-inidir=/etc/iodbc</parameter>:
      <application>libiodbc</application> will install configuration files
      in this directory.
    </para>

    <para>
      <parameter>--includedir=/usr/include/iodbc</parameter>: This installs the
      interface headers to a private directory to avoid a conflict with headers
      installed by <application>unixODBC</application>.
    </para>

    <para>
      <parameter>--disable-libodbc</parameter>: This prevents the installation
      of the <filename class="symlink">libodbc.so</filename> symbolic link to
      avoid a conflict with <application>unixODBC</application>.
    </para>

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

  </sect2>

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

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

      <seglistitem>
        <seg>iodbc-config, iodbctest, iodbctestw, and iodbcadm-gtk</seg>
        <seg>libdrvproxy.so, libiodbc.so, libiodbcinst.so, and
        libiodbcadm.so</seg>
        <seg>/usr/include/iodbc, /usr/share/libiodbc, and /etc/iodbc</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="iodbc-config">
        <term><command>iodbc-config</command></term>
        <listitem>
          <para>
            is a utility for retrieving the installation options of libiodbc
          </para>
          <indexterm zone="libiodbc iodbc-config">
            <primary sortas="b-iodbc-config">iodbc-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="iodbctest">
        <term><command>iodbctest{,w}</command></term>
        <listitem>
          <para>
            are interactive SQL processors
          </para>
          <indexterm zone="libiodbc iodbctest">
            <primary sortas="b-iodbctest">iodbctest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="iodbcadm">
        <term><command>iodbcadm-gtk</command></term>
        <listitem>
          <para>
            is a graphical administration utility
          </para>
          <indexterm zone="libiodbc iodbcadm">
            <primary sortas="b-iodbcadm">iodbcadm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>