source: general/genutils/unixodbc.xml@ f320fd2

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since f320fd2 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 12 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 9.5 KB
Line 
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 <!ENTITY unixodbc-download-http "https://github.com/lurcher/unixODBC/releases/download/&unixodbc-version;/unixODBC-&unixodbc-version;.tar.gz">
8<!-- <!ENTITY unixodbc-download-ftp "&gentoo-ftp-repo;/unixODBC-&unixodbc-version;.tar.gz">-->
9 <!ENTITY unixodbc-download-http " ">
10 <!ENTITY unixodbc-download-ftp "ftp://ftp.unixodbc.org/pub/unixODBC/unixODBC-&unixodbc-version;.tar.gz">
11 <!ENTITY unixodbc-md5sum "0ff1fdbcb4c3c7dc2357f3fd6ba09169">
12 <!ENTITY unixodbc-size "1.7 MB">
13 <!ENTITY unixodbc-buildsize "28 MB">
14 <!ENTITY unixodbc-time "0.2 SBU (using parallelism=4)">
15]>
16
17<sect1 id="unixodbc" xreflabel="unixODBC-&unixodbc-version;">
18 <?dbhtml filename="unixodbc.html"?>
19
20
21 <title>unixODBC-&unixodbc-version;</title>
22
23 <indexterm zone="unixodbc">
24 <primary sortas="a-unixODBC">unixODBC</primary>
25 </indexterm>
26
27 <sect2 role="package">
28 <title>Introduction to unixODBC</title>
29
30 <para>
31 The <application>unixODBC</application> package is an Open Source
32 ODBC (Open DataBase Connectivity) sub-system and an ODBC SDK for Linux, Mac
33 OSX, and UNIX. ODBC is an open specification for providing application
34 developers with a predictable API with which to access data sources. Data
35 sources include optional SQL Servers and any data source with an ODBC Driver.
36 <application>unixODBC</application> contains the following components used
37 to assist with the manipulation of ODBC data sources: a driver manager, an
38 installer library and command line tool, command line tools to help install
39 a driver and work with SQL, drivers and driver setup libraries.
40 </para>
41
42 &lfs113_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&unixodbc-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&unixodbc-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &unixodbc-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &unixodbc-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &unixodbc-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &unixodbc-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">unixODBC Dependencies</bridgehead>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <ulink url="https://hughestech.com.au/products/msql/">Mini SQL</ulink> and
83 <xref linkend="pth"/>
84 </para>
85
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of unixODBC</title>
90
91 <para>
92 Install <application>unixODBC</application> by running the following
93 commands:
94 </para>
95
96<screen><userinput>./configure --prefix=/usr \
97 --sysconfdir=/etc/unixODBC &amp;&amp;
98make</userinput></screen>
99
100 <para>
101 This package does not come with a test suite.
102 </para>
103
104 <para>
105 Now, as the <systemitem class="username">root</systemitem> user:
106 </para>
107
108<screen role="root"><userinput>make install &amp;&amp;
109
110find doc -name "Makefile*" -delete &amp;&amp;
111chmod 644 doc/{lst,ProgrammerManual/Tutorial}/* &amp;&amp;
112
113install -v -m755 -d /usr/share/doc/unixODBC-&unixodbc-version; &amp;&amp;
114cp -v -R doc/* /usr/share/doc/unixODBC-&unixodbc-version;</userinput></screen>
115
116 </sect2>
117
118 <sect2 role="commands">
119 <title>Command Explanations</title>
120
121 <para>
122 <option>--enable-drivers</option>: This parameter enables building
123 the drivers that were installed by default in previous versions.
124 </para>
125
126 <para>
127 <option>--enable-drivers-conf</option>: This parameter enables
128 building the driver configuration libraries that were installed
129 by default in previous versions.
130 </para>
131
132 </sect2>
133
134 <sect2 role="configuration">
135 <title>Configuring unixODBC</title>
136
137 <sect3 id="unixodbc-config">
138 <title>Config Files</title>
139 <para>
140 <filename>/etc/unixODBC/*</filename>
141 </para>
142
143 <indexterm zone="unixodbc unixodbc-config">
144 <primary sortas="e-etc-unixODBC-">/etc/unixODBC/*</primary>
145 </indexterm>
146 </sect3>
147
148 <sect3><title>Configuration Information</title>
149
150 <para>
151 The files in <filename class='directory'>/etc/unixODBC</filename>
152 are meant to be configured by the system administrator (or the ODBC site
153 administrator if appropriate privileges are granted to
154 <filename class='directory'>/etc/unixODBC</filename>). These files
155 are not meant to be directly edited. The ODBC installer library is
156 responsible for reading and writing the
157 <application>unixODBC</application> config files.
158 </para>
159
160 <para>
161 Unfortunately, there are not many <command>man</command>, or any
162 <command>info</command> pages for the various programs available in the
163 <application>unixODBC</application> package. Along with the information
164 in the <quote>Short Descriptions</quote> below and the documentation
165 installed in <filename
166 class='directory'>/usr/share/doc/unixODBC-&unixodbc-version;</filename>,
167 there are many <filename>README</filename> files throughout the source
168 tree where the use and functionality of the programs can be found.
169 Additionally, you can use the parameter <option>-?</option> for syntax
170 and usage information. Lastly, the <application>unixODBC</application>
171 web site at <ulink url="http://www.unixodbc.org/"/> has very good
172 information.
173 </para>
174
175 </sect3>
176
177 </sect2>
178
179 <sect2 role="content">
180 <title>Contents</title>
181
182 <segmentedlist>
183 <segtitle>Installed Programs</segtitle>
184 <segtitle>Installed Libraries</segtitle>
185 <segtitle>Installed Directories</segtitle>
186
187 <seglistitem>
188 <seg>
189 dltest, isql, iusql, odbc_config, odbcinst, and slencheck
190 </seg>
191 <seg>
192 libodbc.so, libodbccr.so, and libodbcinst.so
193 </seg>
194 <seg>
195 /etc/unixODBC and
196 /usr/share/doc/unixODBC-&unixodbc-version;
197 </seg>
198 </seglistitem>
199 </segmentedlist>
200
201 <variablelist>
202 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
203 <?dbfo list-presentation="list"?>
204 <?dbhtml list-presentation="table"?>
205
206 <varlistentry id="dltest">
207 <term><command>dltest</command></term>
208 <listitem>
209 <para>
210 is a utility used to check a shared library to see if it can be
211 loaded and if a given symbol exists in it
212 </para>
213 <indexterm zone="unixodbc dltest">
214 <primary sortas="b-dltest">dltest</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="isql">
220 <term><command>isql</command></term>
221 <listitem>
222 <para>
223 is a utility which can be used to submit SQL to a data source and
224 to format/output results. It can be used in batch or interactive
225 mode
226 </para>
227 <indexterm zone="unixodbc isql">
228 <primary sortas="b-isql">isql</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="iusql">
234 <term><command>iusql</command></term>
235 <listitem>
236 <para>
237 provides the same functionality as the <command>isql</command>
238 program
239 </para>
240 <indexterm zone="unixodbc iusql">
241 <primary sortas="b-iusql">iusql</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="odbc_config">
247 <term><command>odbc_config</command></term>
248 <listitem>
249 <para>
250 is used to find out details about the installation of
251 the <application>unixODBC</application> package
252 </para>
253 <indexterm zone="unixodbc odbc_config">
254 <primary sortas="b-odbc_config">odbc_config</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="odbcinst">
260 <term><command>odbcinst</command></term>
261 <listitem>
262 <para>
263 is a utility created for install script/RPM writers. It is a
264 command line interface to key functionality in the
265 <filename class="libraryfile">libodbcinst</filename> library. It does
266 not copy any files (i.e., libraries) but it will modify the ODBC
267 System Information for the user
268 </para>
269 <indexterm zone="unixodbc odbcinst">
270 <primary sortas="b-odbcinst">odbcinst</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="slencheck">
276 <term><command>slencheck</command></term>
277 <listitem>
278 <para>
279 is a utility which attempts to check whether an ODBC driver
280 was built with 32-bit or 64-bit SQLLEN types
281 </para>
282 <indexterm zone="unixodbc slencheck">
283 <primary sortas="b-slencheck">slencheck</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288
289 </variablelist>
290
291 </sect2>
292
293</sect1>
Note: See TracBrowser for help on using the repository browser.