Browse files

* Small documentation enhancements and clarifications (pvk)

  • Loading branch information...
1 parent 3a62478 commit 7b39aedb1171efff78745de0f2cba2d6143ff749 @pkleef pkleef committed with iODBC Maintainer Feb 20, 2004
Showing with 133 additions and 115 deletions.
  1. +13 −15 INSTALL
  2. +94 −81 README
  3. +13 −13 README.CVS
  4. +13 −6 README.MACOSX
View
28 INSTALL
@@ -1,5 +1,5 @@
-Copyright 1994, 1995, 1996, 1999, 2000, 2001 Free Software Foundation,
-Inc.
+Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
+Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
@@ -71,8 +71,9 @@ Compilers and Options
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
- You can give `configure' initial values for variables by setting
-them in the environment. You can do that on the command line like this:
+ You can give `configure' initial values for configuration parameters
+by setting variables in the command line or in the environment. Here
+is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
@@ -137,9 +138,10 @@ Specifying the System Type
==========================
There may be some features `configure' cannot figure out
-automatically, but needs to determine by the type of host the package
-will run on. Usually `configure' can figure that out, but if it prints
-a message saying it cannot guess the host type, give it the
+automatically, but needs to determine by the type of machine the package
+will run on. Usually, assuming the package is built to be run on the
+_same_ architectures, `configure' can figure that out, but if it prints
+a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
@@ -151,20 +153,16 @@ where SYSTEM can have one of these forms:
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
+need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the host
-platform (i.e., that on which the generated programs will eventually be
-run) with `--host=TYPE'. In this case, you should also specify the
-build platform with `--build=TYPE', because, in this case, it may not
-be possible to guess the build platform (it sometimes involves
-compiling and running simple test programs, and this can't be done if
-the compiler is a cross compiler).
+platform different from the build platform, you should specify the
+"host" platform (i.e., that on which the generated programs will
+eventually be run) with `--host=TYPE'.
Sharing Defaults
================
View
175 README
@@ -1,14 +1,14 @@
iODBC Driver Manager
-Copyright (C) 1995 by Ke Jin <kejin@empress.com>
-Copyright (C) 1996-2002 by OpenLink Software <mailto:iodbc@openlinksw.com>
+Copyright (C) 1995 by Ke Jin <kejin@empress.com>
+Copyright (C) 1996-2004 by OpenLink Software <iodbc@openlinksw.com>
All Rights Reserved.
1. Introduction
Welcome to the iODBC driver manager maintained by OpenLink Software
- (<http://www.openlinksw.com/>). This kit will provide you with
- everything you need in order to develop ODBC-compliant applications
+ (<http://www.openlinksw.com/>). This kit will provide you with
+ everything you need in order to develop ODBC-compliant applications
under Unix without having to pay royalties to other parties.
This kit consists of a number of parts:
@@ -20,18 +20,18 @@ All Rights Reserved.
as the binary form). You can download the latest version of the
driver manager from <http://www.iodbc.org/>
- o A simple example, odbctest.c, which gives you a command-line
+ o A simple example, iodbctest.c, which gives you a command-line
interface to SQL. You can fit this to your purposes, but at the very
least this is useful for verification of your ODBC installation.
-
+
You can use either part stand-alone, if you wish.
-
+
An ODBC driver is still needed to affect your connection
architecture. You may build a driver with the iODBC components or
obtain an ODBC driver from a commercial vendor. OpenLink Software
produces cross-platform commercial drivers as well as maintaining
- the iODBC distribution: evaluation copies may be obtained via
- download from <http://www.openlinksw.com/>. Any ODBC-compliant
+ the iODBC distribution: evaluation copies may be obtained via
+ download from <http://www.openlinksw.com/>. Any ODBC-compliant
driver will work with the iODBC Driver Manager.
See also the iODBC website, <http://www.iodbc.org/>, for more pointers
@@ -55,27 +55,27 @@ All Rights Reserved.
locations for dynamic link libraries. Most systems use the
environment variable LD_LIBRARY_PATH to this end. Exceptions are
AIX which uses LIBPATH and HP/UX which uses SHLIB_PATH.
-
+
If your system has a C compiler, you can verify the installation
- by compiling the odbctest program. Otherwise, you may have ODBC
+ by compiling the iodbctest program. Otherwise, you may have ODBC
applications installed on your system which you can use.
-
-
+
+
3. Configuration of run-time distribution
-
+
The iODBC driver manager looks for a file ~/.odbc.ini, where the
tilde stands for the user's home directory. This file only contains a
default section where you can select which driver library to use. Copy
the odbc.ini file from the examples directory to ~/.odbc.ini and make
sure the right path and filename is used for your installation.
-
+
A data source is a section (enclosed in square parenthesis), and
the attributes for a data source are given within this section.
The most important attribute to iODBC for each datasource is the Driver
attribute. This must point to the shared library for the ODBC driver
associated with the data source.
-
+
As example, the OpenLink ODBC drivers have a number of attributes
which can be set for a data source. Here is a description (with ODBC
connect string tags between parenthesis):
@@ -151,64 +151,50 @@ All Rights Reserved.
5. iODBC driver manager platform availability
- iODBC driver manager has been ported to following Unix platforms:
+ The iODBC driver manager has been ported to following Unix platforms:
- SunOS 4.1.x Sun Sparc
- HP/UX 9.x, 10.x HP9000 s700/s800
- HP/UX 9.x HP9000 s300/s400
- IBM AIX 3.x, 4.x IBM RS6000, PowerPC
- Sun Solaris 2.x Sun Sparc, PCx86
- SGI Irix SVR4 5.x, 6.x IP12 MIPS, IP22 MIPS
- NCR SVR4 3.x NCR 3435
- UnixWare SVR4.2 1.x, 2.x x86
- DEC Unix(OSF/1) 3.x, 4.x DEC Alpha
- FreeBSD 2.x x86
BSDi BSD/OS 2.x ?
- Linux ELF 1.2.x, 1.3.x x86
- SCO OpenServer 5.x x86
- Max/OS SVR4 1.x Concurrent Maxion 9200 MP
+ DEC Unix(OSF/1) 3.x - 5.x DEC Alpha
DG/UX 5.x Aviion
+ FreeBSD 2.x - 5.x x86
+ HP/UX 9.x - 11.x HP9000 s700/s800
+ HP/UX 9.x HP9000 s300/s400
+ IBM AIX 3.x - 5.x IBM RS6000, PowerPC
+ Linux ELF 1.x, 2.x x86, Itanium, PowerPC
+ Mac OS X 10.x PowerPC
+ Max/OS SVR4 1.x Concurrent Maxion 9200 MP
+ NCR SVR4 3.x NCR 3435
OpenVMS 6.x DEC Alpha
+ SCO OpenServer 5.x x86
+ SGI Irix SVR4 5.x, 6.x IP12 MIPS, IP22 MIPS
+ SunOS 4.1.x Sun Sparc
+ Sun Solaris 2.x Sun Sparc, PCx86
+ UnixWare SVR4.2 1.x, 2.x x86
Windows NT 4.x x86
-
+
As the iODBC driver manager uses autoconf/automake/libtool it should
be portable to most modern UNIX platforms out of the box. However if
you do need to make changes to the code or the configuration files,
we would appreciate you share your changes with the rest of the
- internet community by mailing your patches to iodbc@openlinksw.com
- so we can include them for the next build
+ internet community by mailing your patches to <iodbc@openlinksw.com>
+ so we can include them for the next build.
Porting of iODBC driver manager to some non-UNIX operating systems
- such as Windows family(3.x, 95, NT), OS/2 and Mac is supported but has
- not been compiled and tested recently. Of cause, you need to supply
- a make/build file and a short LibMain for creating the iodbc.dll.
+ such as Windows family(3.x, 95, NT), OS/2 and Mac Classic is
+ supported but has not been compiled and tested recently. Of cause,
+ you need to supply a make/build file and a short LibMain for creating
+ the iodbc.dll.
6. How to build iODBC driver manager:
- MacOS X users should read the separate README.MACOSX document for
+ Mac OS X users should read the separate README.MACOSX document for
more detail of porting on this platform. Otherwise:
step 1. Run configure to adjust to target platform
step 2. Run make
step 3. Run make install
-
- Here is an example:
-
- $ ./configure --prefix=/usr/local --with-iodbc-inidir=/etc
- ...
- ...
- ...
- $ make
- ...
- ...
- ...
- $ su
- # make install
- ...
- ...
- ...
The configure program will examine your system for various compiler
flags, system options etc. In some cases extra flags need to be
@@ -219,32 +205,59 @@ All Rights Reserved.
$ CFLAGS="-Ae -O" ./configure --prefix=/usr/local ..........
- Note that the path of the system wide odbc.ini file is calculated as
+ File Hierarchy
+ --------------
+
+ Note that the path of the system wide odbc.ini file is calculated as
follows (based on flags to ./configure):
- no --prefix default is /usr/local/etc/odbc.ini
+ no --prefix default is /etc/odbc.ini
--prefix=/usr /etc/odbc.ini
--prefix=/xxx/yyy /xxx/yyy/etc/odbc.ini
--sysconfdir=/xxx/yyy /xxx/yyy/odbc.ini
--with-iodbc-inidir=/xxx/yyy /xxx/yyy/odbc.ini
+ If the `--with-layout=' option is set, then the prefix and
+ sysconfdir parameters will be changed accordingly. Currently, this
+ parameter understands values of `gentoo', `redhat', `gnu',
+ `debian' or `opt' (with everything going into /opt/iodbc/). If
+ both are specified, a --prefix argument will overrule a --with-layout.
+
+
+ Example
+ -------
+
+ $ ./configure --prefix=/usr/local --with-iodbc-inidir=/etc
+ ...
+ ...
+ ...
+ $ make
+ ...
+ ...
+ ...
+ $ su
+ # make install
+ ...
+ ...
+ ...
+
7. odbc.ini
Driver manager and drivers use odbc.ini file or connection string
when establishing a data source connection. On Windows, odbc.ini is
- located in Windows directory.
-
+ located in Windows directory.
+
On UNIX, the iODBC driver manager looks for the odbc.ini file in the
following sequence:
- 1. check environment variable ODBCINI
+ 1. check environment variable ODBCINI
2. check $HOME/.odbc.ini
3. check home in /etc/passwd and try .odbc.ini in there
- 4. system wide odbc.ini (settable at configuration time)
+ 4. system-wide odbc.ini (settable at configuration time)
Item 1 is the easiest as most drivers will also look at this variable.
@@ -283,26 +296,28 @@ All Rights Reserved.
Sample = OpenLink Generic ODBC Driver
Virtuoso = Virtuoso
+ [ODBC]
+ TraceFile = /tmp/odbc.trace
+ Trace = 0 ; set to 1 to enable tracing
+
[Sample]
Driver = /usr/local/openlink/lib/oplodbc.so.1
Description = Sample OpenLink DSN
Host = localhost
UserName = openlink
Password = xxxx
- ServerType = Oracle 8
- Database =
+ ServerType = Oracle 8.1.x
+ Database =
FetchBufferSize = 99
ReadOnly = no
- TraceFile = /tmp/odbc.trace
- Trace = 1
[Virtuoso]
Driver = /usr/local/virtuoso/lib/virtodbc.so.1
Address = localhost:1112
Database = Demo
[Myodbc]
- Driver = /home/patrick/src/iODBC/new/myodbc/myodbc.so
+ Driver = /usr/lib/libmyodbc.so
HOST = localhost
[Default]
@@ -315,37 +330,35 @@ All Rights Reserved.
iODBC driver manager traces driver's ODBC call invoked by the driver
manager. Default tracing file is ./odbc.log. Tracing option (i.e.
on/off or optional tracing file name) can be set in odbc.ini file
- (under a data source section) as:
+ under the [ODBC] heading as:
+ [ODBC]
TraceFile = <optional_trace_file>
Trace = ON | On | on | 1 | OFF | Off | off | 0
If <optional_trace_file> is stderr or stdout, i.e.
-
- TraceFile = stderr
-
+
+ TraceFile = stderr
+
or
TraceFile = stdout
the tracing message will go to the terminal screen (if it is available).
- iODBC driver manager allows one to tune on/off tracing on selected
- connection(s). Different connections can share one or use different
- tracing file(s). ODBC calls on connections without tuning tracing
- on will not be traced.
-
-
9. Further Information Sources:
- http://www.iodbc.org
- iODBC project home page.
- Binaries, source, WebCVS, and Discussion Forum.
+ <http://www.iodbc.org/>
+ iODBC project home page.
+ Binaries, source, documentation
+
+ <http://sourceforge.net/projects/iodbc>
+ Source, CVS tree, mailing lists, forums, bug reports
- http://www.openlinksw.com
- OpenLink Software.
- Free non-expiring trials and support for OpenLink's ODBC drivers.
+ <http://www.openlinksw.com/>
+ OpenLink Software.
+ Free trials and support for OpenLink's ODBC drivers.
- http://www.microsoft.com/data/odbc/
+ <http://www.microsoft.com/data/odbc/>
Microsoft's ODBC pages.
View
26 README.CVS
@@ -1,6 +1,6 @@
iODBC Driver Manager
Copyright (C) 1995 by Ke Jin <kejin@empress.com>
-Copyright (C) 1996-2002 by OpenLink Software <iodbc@openlinksw.com>
+Copyright (C) 1996-2004 by OpenLink Software <iodbc@openlinksw.com>
All Rights Reserved.
@@ -9,27 +9,26 @@ Introduction
This document describes how to checkout a copy of the CVS tree for
development purposes. It also lists the packages that need to be
installed prior to generating the necessary scripts and Makefiles to
-build the project.
+build the project.
CVS access is only needed for developers who want to actively track
progress of the iODBC source code and contribute bugfixes or enhancements
to the project. It requires basic knowledge about the general layout
of open source and GNU projects, the use of autoconf and automake etc,
which is beyond the scope of this document. If you have any questions,
-please email us at iodbc@openlinksw.com.
-
+please email us at <iodbc@openlinksw.com>.
CVS Archive Server Access
=========================
-OpenLink currently provides read-only CVS Archive access from one of
-our servers:
+OpenLink currently provides read-only CVS Archive access throught the
+SourceForge.net servers:
- $ cvs -d :pserver:iodbc@www.iodbc.org:/source/CVSROOT login
+$ cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/iodbc login
- CVS password: anonymous
+(The password is blank)
- $ cvs -z3 -d :pserver:iodbc@www.iodbc.org:/source/CVSROOT checkout iODBC
+$ cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/iodbc co iodbc
Package Dependencies
@@ -38,15 +37,13 @@ To generate the configure script and all other build files necessary,
please make sure the following packages and recommended versions are
installed on your system.
-
Package Version From
======== ======= ==================================
autoconf 2.57 ftp://ftp.gnu.org/pub/gnu/autoconf
automake 1.6.3 ftp://ftp.gnu.org/pub/gnu/automake
libtool 1.4.3 ftp://ftp.gnu.org/pub/gnu/libtool
gtk+ 1.2.10 ftp://ftp.gtk.org/pub/gtk/v1.2
-
The above version are used for generating the source distributions with
are currently generated on a standard RedHat 9 installation. Older version
of these packages can sometimes be used, but could cause build problems.
@@ -65,7 +62,7 @@ Generate build files
To generate the configure script and all related build files, use one
of the following commands:
- $ autoreconf -i
+ $ autoreconf --install
or use the supplied script in your CVS checkout directory:
@@ -76,6 +73,9 @@ following command to check out all the options you can use:
$ ./configure --help
+Certain build targets are only enabled when the --enable-maintainer-mode
+flag is added to configure.
+
Please read the files INSTALL and README in this directory for further
information on how to configure the package and install it on your system.
@@ -90,6 +90,6 @@ CVS archive by:
$ cvs -z3 diff -uN > diffs
Patches and contributions can be send to the OpenLink iODBC source
-archive manager at iodbc@openlinksw.com to be included the next
+archive manager at <iodbc@openlinksw.com> to be included the next
distribution. Please provide accompanying documentation on which bugs
are fixed or new features are introduced.
View
19 README.MACOSX
@@ -1,8 +1,16 @@
-Object: how to build iODBC for Mac OS X
+iODBC Driver Manager
+Copyright (C) 1995 by Ke Jin <kejin@empress.com>
+Copyright (C) 1996-2004 by OpenLink Software <iodbc@openlinksw.com>
+All Rights Reserved.
+
+
+
+How to build iODBC for Mac OS X
+===============================
Method 1: Using Project builder
-================================
+-------------------------------
You first need to install the Mac OS X Developer Packages from the
December 2001 package, which can be found at:
@@ -18,7 +26,7 @@ mac/iODBCinst, or execute the following commands from a terminal session:
After building the iODBC frameworks, you have to install them on your
-system in /Library/Frameworks with the command:
+system in /Library/Frameworks with the command:
$ cd mac
$ make install
@@ -28,7 +36,7 @@ Now that you have installed the iODBC frameworks on your system, you are
able to use ODBC applications. Just for testing, you can from now build
the odbctest application that you can find under the samples directory :
- $ cd mac/iODBCtest
+ $ cd mac/iODBCtest
$ pbxbuild
@@ -40,7 +48,7 @@ be able to make a connection.
Method 2: Using configure and make
-===================================
+----------------------------------
The iODBC package can also be build like any other OpenSource package not
using any frameworks.
@@ -51,7 +59,6 @@ following commands:
$ ./configure
$ make
-
To install the header files and libraries in /usr/local, you execute
the following command as root:

0 comments on commit 7b39aed

Please sign in to comment.