Blame SOURCES/odbcinst.1

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