Blame SOURCES/odbcinst.ini.5

caac36
.TH odbcinst.ini 5 "Thu 27 Jun 2013" "version 2.3.1" "unixODBC manual pages"
caac36
caac36
.SH NAME
caac36
/etc/odbcinst.ini - An unixODBC drivers configuration
caac36
caac36
.SH DESCRIPTION
caac36
.B /etc/odbcinst.ini
caac36
is a text configuration file for unixODBC drivers. It can be edited by hand,
caac36
but the recommended way to update this file is to use the
caac36
.BR odbcinst (1)
caac36
utility.
caac36
caac36
.SH FILE FORMAT
caac36
The general .ini file format is:
caac36
caac36
.RS
caac36
.nf
caac36
.BI [ SectionName1 ]
caac36
.IB key1 " = " value1
caac36
.IB key2 " = " value2
caac36
.B ...
caac36
caac36
.BI [ SectionName2 ]
caac36
.IB key1 " = " value1
caac36
.IB key2 " = " value2
caac36
.B ...
caac36
.fi
caac36
.RE
caac36
caac36
Each ODBC driver has its own section and can be referred to by the name of its
caac36
section. Recognized configuration keys are:
caac36
caac36
.IP \fBDescription
caac36
A text string briefly describing the driver.
caac36
caac36
.IP \fBDriver
caac36
A filesystem path to the actual driver library.
caac36
caac36
.IP \fBSetup
caac36
A filesystem path to the driver setup library.
caac36
caac36
.IP \fBFileUsage
caac36
.BR odbcinst (1)
caac36
entry, if you edit the configuration file by hand, you have to supply it yourself.
caac36
caac36
.SS TEMPLATE FILES
caac36
The recommended way to manage the drivers is using the
caac36
.BR odbcinst (1)
caac36
utility. You can install the drivers by supplying it with template file, which
caac36
has the same format as this file.
caac36
caac36
.SH EXAMPLES
caac36
An example of the actual PostgreSQL driver:
caac36
caac36
.RS
caac36
.nf
caac36
[PostgreSQL]
caac36
Description = PostgreSQL driver for GNU/Linux
caac36
Driver      = /usr/lib/psqlodbcw.so
caac36
Setup       = /usr/lib/libodbcpsqlS.so
caac36
FileUsage   = 1
caac36
.fi
caac36
.RE
caac36
caac36
By specifying the driver like that, you can then reference it in the
caac36
.BR odbc.ini (5)
caac36
as follows:
caac36
caac36
.RS
caac36
.nf
caac36
...
caac36
Driver = PostgreSQL
caac36
...
caac36
.fi
caac36
.RE
caac36
caac36
The recommended way to add that driver is by creating template file containg:
caac36
caac36
.RS
caac36
.nf
caac36
[PostgreSQL]
caac36
Description = PostgreSQL driver for GNU/Linux
caac36
Driver      = /usr/lib/psqlodbcw.so
caac36
Setup       = /usr/lib/libodbcpsqlS.so
caac36
.fi
caac36
.RE
caac36
caac36
and call the 
caac36
.BR odbcinst (1):
caac36
caac36
.RS
caac36
.BI "# odbcinst -i -d -f " template.ini
caac36
.RE
caac36
caac36
.SH "SEE ALSO"
caac36
.BR odbcinst (1),
caac36
.BR odbc.ini (5)
caac36
caac36
.SH AUTHORS
caac36
The authors of unixODBC are Peter Harvey <\fIpharvey@codebydesign.com\fR> and
caac36
Nick Gorham <\fInick@easysoft.com\fR>. For the full list of contributors see the
caac36
AUTHORS file.
caac36
caac36
.SH COPYRIGHT
caac36
unixODBC is licensed under the GNU Lesser General Public License. For details
caac36
about the license, see the COPYING file.