1odbcinst(1)                  unixODBC manual pages                 odbcinst(1)
2
3
4

NAME

6       odbcinst - A unixODBC utility for managing configuration files
7
8

SYNOPSIS

10       odbcinst ACTION OBJECT OPTIONS
11
12

DESCRIPTION

14       odbcinst  is  a command-line utility allowing users who develop install
15       scripts or packages for ODBC drivers to easily create or remove entries
16       in odbc.ini and odbcinst.ini.
17
18       The  utility  is part of the odbcinst component of unixODBC and comple‐
19       ments the shared library of the same name (libodbcinst).
20
21

OPTIONS

23   ACTIONS
24       -i     Install a new OBJECT (by adding a  section  to  a  configuration
25              file).
26
27
28       -u     Uninstall  an existing OBJECT (by removing a section from a con‐
29              figuration file).
30
31
32       -q     Query ODBC configuration files and print available  options  for
33              the specified OBJECT.
34
35
36       -j     Print  the current configuration of unixODBC, including paths to
37              configuration files.
38
39
40       -c     Call SQLCreateDataSource.
41
42
43       -m     Call SQLManageDataSources.
44
45
46       --version
47              Display the program version.
48
49
50   OBJECTS
51       -d     The specified ACTION affects a driver (and thus the odbcinst.ini
52              configuration file).
53
54
55       -s     The specified ACTION affects a data source (and thus the user or
56              system odbc.ini configuration file).
57
58
59   OPTIONS
60       -f FILE
61              FILE is a template describing the configuration of the installed
62              OBJECT (only valid with the -i ACTION).
63
64
65       -r     Act  in the same way as for the -f OPTION, but take standard in‐
66              put as the template file.
67
68
69       -n NAME
70              Specifies the NAME of the OBJECT.
71
72
73       -v     Disable all information, warning and error messages.
74
75
76       -l     The specified data source is system-wide. This  option  is  only
77              valid when used with the -s OBJECT.
78
79
80       -h     The  specified data source is user-specific. This option is only
81              valid when used with the -s OBJECT.
82
83

RETURN VALUES

85       odbcinst returns zero on success and a non-zero value on failure.
86
87

FILES

89       /etc/odbcinst.ini
90              Configuration file containing all database  driver  definitions.
91              See odbcinst.ini(5) for more information.
92
93       /etc/odbc.ini
94              Configuration file containing system-wide Data Source Name (DSN)
95              definitions. See odbc.ini(5) for more information.
96
97       $HOME/.odbc.ini
98              Configuration file containing  user-specific  Data  Source  Name
99              (DSN) definitions. See odbc.ini(5) for more information.
100
101

SEE ALSO

103       odbcinst.ini(5), odbc.ini(5)
104
105

AUTHORS

107       The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and
108       Nick Gorham <nick@lurcher.org>.
109
110       For a full list of contributors, refer to the AUTHORS file.
111
112

114       unixODBC is licensed under the GNU Lesser General Public  License.  For
115       details about the license, see the COPYING file.
116
117
118
119version 2.3.11                  Sat 09 Jan 2021                    odbcinst(1)
Impressum