glfs/general/genutils/unixodbc.xml

305 lines
12 KiB
XML

<?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 unixodbc-download-http "http://www.unixodbc.org/unixODBC-&unixodbc-version;.tar.gz">
<!ENTITY unixodbc-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/unixODBC-&unixodbc-version;.tar.gz">
<!ENTITY unixodbc-md5sum "9ae806396844e38244cf65ad26ba0f23">
<!ENTITY unixodbc-size "2.4 MB">
<!ENTITY unixodbc-buildsize "82.5 MB">
<!ENTITY unixodbc-time "3.4 SBU (includes building the GUI tools)">
]>
<sect1 id="unixodbc" xreflabel="unixODBC-&unixodbc-version;">
<?dbhtml filename="unixodbc.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>unixODBC-&unixodbc-version;</title>
<indexterm zone="unixodbc">
<primary sortas="a-unixODBC">unixODBC</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to unixODBC</title>
<para>The <application>unixODBC</application> package is an Open Source
ODBC (Open DataBase Connectivity) sub-system and an ODBC SDK for Linux, Mac
OSX, and UNIX. ODBC is an open specification for providing application
developers with a predictable API with which to access data sources. Data
sources include SQL Servers and any data source with an ODBC Driver.
<application>unixODBC</application> contains the following components used
to assist with the manipulation of ODBC data sources: a driver manager, an
installer library and command line tool, command line tools to help install
a driver and work with SQL, drivers and driver setup libraries and a suite
of graphical tools used to administer ODBC, test drivers and browse data
sources.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&unixodbc-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&unixodbc-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &unixodbc-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &unixodbc-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &unixodbc-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &unixodbc-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">unixODBC Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="qt"/> (required to build the GUI tools),
<ulink url="http://www.gnu.org/software/pth/">GNU Pth</ulink> and
<ulink url="http://www.hughes.com.au/products/msql/">Mini SQL</ulink></para>
<note>
<para>There is a circular dependency with <application>Qt</application>
and <application>unixODBC</application>. If you need to build the
<application>Qt</application> <application>unixODBC</application>
plugin module, you will have to build and install
<application>unixODBC</application> once without the GUI tools to satisfy
the <application>Qt</application> build. Then, after
<application>Qt</application> has been installed, you'll need to build
and install <application>unixODBC</application> again if you wish to
build the GUI tools.</para>
</note>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/unixodbc"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of unixODBC</title>
<para>Install <application>unixODBC</application> by running the following
commands:</para>
<screen><userinput>sed -i "s/void yyerror/#define YY_FLUSH_BUFFER\n\n&amp;/" sqp/lex.l &amp;&amp;
./configure --prefix=/usr --sysconfdir=/etc/unixodbc \
--enable-ltdllib --enable-fdb --disable-gui &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 &amp;&amp;
find doc -name "Makefile*" -exec rm {} \; &amp;&amp;
chmod 644 doc/{lst,ProgrammerManual/Tutorial}/* &amp;&amp;
install -v -m755 -d /usr/share/doc/unixODBC-&unixodbc-version; &amp;&amp;
cp -v -R doc/* /usr/share/doc/unixODBC-&unixodbc-version;</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para><command>sed -i "..." sqp/lex.l</command>: This fixes a build issue
if using a compiler version greater than
<application>GCC</application>-3.x.x.</para>
<para><parameter>--enable-ltdllib</parameter>: This parameter causes the
build to use the system-installed version of
<application>Libtool</application>.</para>
<para><parameter>--enable-fdb</parameter>: This parameter enables support
for file-based data access.</para>
<para><parameter>--disable-gui</parameter>: This parameter disables
building the GUI tools. Remove it if you have
<application>Qt</application> installed and wish to build the GUI
tools.</para>
</sect2>
<sect2 role="configuration">
<title>Configuring unixODBC</title>
<sect3 id="unixodbc-config">
<title>Config Files</title>
<para><filename>/etc/unixodbc/*</filename></para>
<indexterm zone="unixodbc unixodbc-config">
<primary sortas="e-etc-unixodbc-">/etc/unixodbc/*</primary>
</indexterm>
</sect3>
<sect3><title>Configuration Information</title>
<para>The files in <filename class='directory'>/etc/unixodbc</filename>
are meant to be configured by the system administrator (or the ODBC site
administrator if appropriate privileges are granted to
<filename class='directory'>/etc/unixodbc</filename>). These files
are not meant to be directly edited. The ODBC installer library is
responsible for reading and writing the
<application>unixODBC</application> config files.</para>
<para>Unfortunately, there are no <command>man</command> or
<command>info</command> pages for the various programs available in the
<application>unixODBC</application> package. Along with the information
in the <quote>Short Descriptions</quote> below and the documentation
installed in <filename
class='directory'>/usr/share/doc/unixODBC-&unixodbc-version;</filename>,
there are many <filename>README</filename> files thoughout the source
tree where the use and functionality of the programs can be found.
Additionally, you can use the parameter <option>-?</option> with the
non-GUI tools for syntax and usage information. Lastly, the
<application>unixODBC</application> web site at <ulink
url="http://www.unixodbc.org/"/> has very good information.</para>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>DataManager, DataManagerII, ODBCConfig, dltest, isql, iusql,
odbc_config, odbcinst and odbctest</seg>
<seg>libboundparam.so, libesoobS.so, libgtrtst.so, libmimerS.so,
libnn.so, libodbc.so, libodbccr.so, libodbcdrvcfg1S.so,
libodbcdrvcfg2S.so, libodbcinst.so, libodbcinstQ.so, libodbcminiS.so,
libodbcmyS.so, libodbcnnS.so, libodbcpsql.so, libodbcpsqlS.so,
libodbctxt.so, libodbctxtS.so, liboplodbcS.so, liboraodbcS.so,
libsapdbS.so, libtdsS.so and libtemplate.so</seg>
<seg>/etc/unixodbc and /usr/share/doc/unixODBC-&unixodbc-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="DataManager">
<term><command>DataManager</command></term>
<listitem>
<para>is a graphical program which can be used to browse/explore ODBC
data sources.</para>
<indexterm zone="unixodbc DataManager">
<primary sortas="b-DataManager">DataManager</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="DataManagerII">
<term><command>DataManagerII</command></term>
<listitem>
<para>is an enhanced version of <command>DataManager</command>.</para>
<indexterm zone="unixodbc DataManagerII">
<primary sortas="b-DataManagerII">DataManagerII</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ODBCConfig">
<term><command>ODBCConfig</command></term>
<listitem>
<para>is a graphical program used to make configuration of ODBC data
sources extremely easy.</para>
<indexterm zone="unixodbc ODBCConfig">
<primary sortas="b-ODBCConfig">ODBCConfig</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="dltest">
<term><command>dltest</command></term>
<listitem>
<para>is a utility used to check a share library to see if it can be
loaded and if a given symbol exists in it.</para>
<indexterm zone="unixodbc dltest">
<primary sortas="b-dltest">dltest</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="isql">
<term><command>isql</command></term>
<listitem>
<para>is a utility which can be used to submit SQL to a data source
and to format/output results. It can be used in batch or interactive
mode.</para>
<indexterm zone="unixodbc isql">
<primary sortas="b-isql">isql</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="iusql">
<term><command>iusql</command></term>
<listitem>
<para>provides the same funtionality as the <command>isql</command>
program.</para>
<indexterm zone="unixodbc iusql">
<primary sortas="b-iusql">iusql</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="odbc_config">
<term><command>odbc_config</command></term>
<listitem>
<para>is used to find out details about the installation of
the <application>unixODBC</application> package.</para>
<indexterm zone="unixodbc odbc_config">
<primary sortas="b-odbc_config">odbc_config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="odbcinst">
<term><command>odbcinst</command></term>
<listitem>
<para> is a utility created for install script/RPM writers. It is a
command line interface to key functionality in the
<filename class='libraryfile'>libodbcinst</filename> library. It does
not copy any files (i.e., libraries) but it will modify the ODBC
System Information for the user.</para>
<indexterm zone="unixodbc odbcinst">
<primary sortas="b-odbcinst">odbcinst</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="odbctest">
<term><command>odbctest</command></term>
<listitem>
<para>is a graphical program used to test the ODBC API.</para>
<indexterm zone="unixodbc odbctest">
<primary sortas="b-odbctest">odbctest</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>