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