caac36
.TH odbcinst 1 "Wed 26 Jun 2013" "version 2.3.1" "unixODBC manual pages"
caac36
caac36
.SH NAME
caac36
odbcinst - An unixODBC tool for manipulating configuration files
caac36
caac36
.SH SYNOPSIS
caac36
.B odbcinst
caac36
.I ACTION OBJECT OPTIONS
caac36
caac36
.SH DESCRIPTION
caac36
.B odbcinst
caac36
is a command line tool which has been created for allowing people who
caac36
are developing the install scripts/RPMs for Drivers to be able to easily
caac36
create/remove entries in odbc.ini and odbcinst.ini. This command line tool is a
caac36
complement to the shared library of the same name (libodbcinst.so). This tool is
caac36
a part of the odbcinst component of unixODBC.
caac36
caac36
.SH OPTIONS
caac36
caac36
.SS ACTIONS
caac36
caac36
.IP -i
caac36
Install (add section to config file) new \fIOBJECT\fR.
caac36
caac36
.IP -u
caac36
Uninstall (remove section from config file) existing \fIOBJECT\fR.
caac36
caac36
.IP -q
caac36
Query the config files and print the options for specified \fIOBJECT\fR.
caac36
caac36
.IP -j
caac36
Prints current configuration of unixODBC, listing (among others) the paths to the
caac36
configuration files.
caac36
caac36
.IP -c
caac36
Calls SQLCreateDataSource
caac36
caac36
.IP -m
caac36
Calls SQLManageDataSources
caac36
caac36
.IP --version
caac36
Prints program version and exits.
caac36
caac36
.SS OBJECTS
caac36
caac36
.IP -d
caac36
The \fIACTION\fR affect drivers (and thus the odbcinst.ini configuration file).
caac36
caac36
.IP -s
caac36
The \fIACTION\fR affect data sources (and thus the user or system odbc.ini
caac36
configuration file).
caac36
caac36
.SS OPTIONS
caac36
caac36
.IP "-f \fIFILE\fR"
caac36
The \fIFILE\fR is template file, describing the configuration of installed
caac36
\fIOBJECT\fR (only valid for the -i \fIACTION\fR).
caac36
caac36
.IP -r
caac36
Same as the -f \fIOPTION\fR, only take the standard input as the template file.
caac36
caac36
.IP "-n \fINAME\fR"
caac36
Specifies the \fINAME\fR of the \fIOBJECT\fR.
caac36
caac36
.IP -v
caac36
Turn off verbose mode. This turns off all information, warning and error
caac36
messages.
caac36
caac36
.IP -l
caac36
The specified data source is system-wide. Has any effect only with the -s
caac36
\fIOBJECT\fR.
caac36
caac36
.IP -h
caac36
The specified data source is user-specific. Has any effect only with the -s
caac36
\fIOBJECT\fR.
caac36
caac36
.SH "RETURN VALUES"
caac36
This command returns zero on success and non-zero value on failure.
caac36
caac36
.SH FILES
caac36
caac36
.I /etc/odbinst.ini
caac36
.RS
caac36
Configuration file containing all the database drivers specifications. See
caac36
.BR odbcinst.ini (5)
caac36
for more details.
caac36
.RE
caac36
caac36
.I /etc/odbc.ini
caac36
.RS
caac36
System-wide data sources specifications. See
caac36
.BR odbc.ini (5)
caac36
for more details.
caac36
.RE
caac36
caac36
.I $HOME/.odbc.ini
caac36
.RS
caac36
User-specific data sources specifications. See
caac36
.BR odbc.ini (5)
caac36
for more details.
caac36
.RE
caac36
caac36
.SH "SEE ALSO"
caac36
.BR odbcinst.ini (5),
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.