Blame SOURCES/odbcinst.ini.5

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