rpms/unixODBC
5
0
Fork 0
Code Issues Pull Requests Releases Activity

Provide man pages created by Jan Stanek

Browse Source
This commit is contained in:
Honza Horák 2013-07-04 13:56:00 +02:00
parent 6665c249a2
commit c4c1b36c0f
5 changed files with 391 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
isql.1 Normal file
View File

@ -0,0 +1,133 @@
\" vim:language en_US.UTF-8:
.TH isql 1 "Tue 25 Jun 2013" "version 2.3.1" "UnixODBC manual pages"
.SH NAME
isql - unixODBC command-line interactive SQL tool
.SH SYNOPSIS
\fBisql\fR \fIDSN\fR [\fIUSER\fR [\fIPASSWORD\fR]] [\fIoptions\fR]
.SH DESCRIPTION
.B isql
is a command line tool which allows the user to execute SQL in batch
or interactively. It has some interesting options such as an option to generate
output wrapped in an HTML table.
.SH ARGUMENTS
.IP \fBDSN\fR
The Data Source Name, which should be used to make connection to the database.
The data source is looked for in the /etc/odbc.ini and $HOME/.odbc.ini files in
that order, with the latter overwriting the former.
.IP \fBUSER\fR
Specifies the database user/role under which the connection should be made.
.IP \fBPASSWORD\fR
Password for the specified \fBUSER\fR.
.SH OPTIONS
.IP \fB-b\fR
Run isql in non-interactive batch mode. In this mode, the isql processes its
standard input, expecting one SQL command per line.
.IP \fB-d\fIDELIMITER\fR
Delimits columns with \fIdelimiter\fR.
.IP \fB-x\fIHEX\fR
Delimits columns with \fIHEX\fR, which is a hexadecimal code of the delimiting
character in the format 0xNN - i.e. 0x09 for the TAB character.
.IP \fB-w\fR
Format the result as HTML table.
.IP \fB-c\fR
Output the names of the columns on the first row. Has any effect only with the
\fB-d\fR or \fB-x\fR options.
.IP \fB-m\fINUM\fR
Limit the column display width to \fINUM\fR characters.
.IP \fB-l\fILOCALE\fR
Sets locale to \fILOCALE\fR.
.IP \fB-q\fR
Wrap the character fields in double quotes.
.IP \fB-3\fR
Use the ODBC 3 calls.
.IP \fB-n\fR
Use the newline processing.
.IP \fB-e\fR
Use the SQLExecDirect instead of Prepare.
.IP \fB-k\fR
Use SQLDriverConnect.
.IP \fB-v\fR
Turn on the verbose mode, where the errors are fully described. Useful for debugging.
.IP \fB--version\fR
Prints the program version and exits.
.SH COMMANDS
This section briefly describes some isql runtime commands.
.B help
.RS
List all tables in the database.
.RE
.B help \fItable\fR
.RS
List all columns in the \fItable\fR.
.RE
.B help help
.RS
List all help options.
.RE
.SH EXAMPLES
.nf
$ isql WebDB MyID MyPWD -w -b < My.sql
.fi
Connects to the WebDB as user MyID with password MyPWD, then execute the
commands in the My.sql file and returns the results wrapped in HTML table.
Each line in My.sql must contain exactly 1 SQL command, except for the last
line, which must be blank (unless the \fB-n\fR option is specified).
.SH FILES
.I /etc/odbc.ini
.RS
System-wide DSN definitions. See
.BR odbc.ini (5)
for details.
.RE
.I $HOME/.odbc.ini
.RS
User-specific DSN definitions. See
.BR odbc.ini (5)
for details.
.RE
.SH SEE ALSO
.BR odbcinst (1),
.BR odbc.ini (5)
.SH AUTHORS
The authors of unixODBC are Peter Harvey <\fIpharvey@codebydesign.com\fR> and
Nick Gorham <\fInick@easysoft.com\fR>. For the full list of contributors see the
AUTHORS file.
.SH COPYRIGHT
unixODBC is licensed under the GNU Lesser General Public License. For details
about the license, see the COPYING file.

25
odbc.ini.5 Normal file
View File

@ -0,0 +1,25 @@
.TH odbc.ini 5 "Thu 27 Jun 2013" "version 2.3.1" "unixODBC manual pages"
.SH NAME
/etc/odbc.ini, $HOME/.odbc.ini - unixODBC data sources configuration
.SH DESCRIPTION
.B /etc/odbc.ini
is text configuration file for the system wide ODBC data sources (i. e. database
connections).
.B $HOME/.odbc.ini
contains the configuration for user-specific data sources.
.SH "SEE ALSO"
.BR odbcinst (1),
.BR isql (1),
.BR odbcinst.ini (5)
.SH AUTHORS
The authors of unixODBC are Peter Harvey <\fIpharvey@codebydesign.com\fR> and
Nick Gorham <\fInick@easysoft.com\fR>. For the full list of contributors see the
AUTHORS file.
.SH COPYRIGHT
unixODBC is licensed under the GNU Lesser General Public License. For details
about the license, see the COPYING file.

114
odbcinst.1 Normal file
View File

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

106
odbcinst.ini.5 Normal file
View File

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

13
unixODBC.spec
View File

@ -11,6 +11,10 @@ Source: http://www.unixODBC.org/%{name}-%{version}.tar.gz
Source1: odbcinst.ini
Source4: conffile.h
Source5: README.fedora
Source6: isql.1
Source7: odbc.ini.5
Source8: odbcinst.1
Source9: odbcinst.ini.5
Patch1: depcomp.patch
Patch6: export-symbols.patch
@ -125,6 +129,13 @@ do
mv -f devel-so-list.x devel-so-list
done
# install man pages that are not part of upstream yet
mkdir -p $RPM_BUILD_ROOT%{_mandir}/man{1,5}
install -m644 %{SOURCE6} $RPM_BUILD_ROOT%{_mandir}/man1/isql.1
install -m644 %{SOURCE7} $RPM_BUILD_ROOT%{_mandir}/man5/odbc.ini.5
install -m644 %{SOURCE8} $RPM_BUILD_ROOT%{_mandir}/man1/odbcinst.1
install -m644 %{SOURCE9} $RPM_BUILD_ROOT%{_mandir}/man5/odbcinst.ini.5
%files -f base-so-list
%doc README COPYING AUTHORS ChangeLog NEWS doc
%doc README.fedora
@ -134,6 +145,7 @@ done
%{_bindir}/dltest
%{_bindir}/iusql
%{_bindir}/odbc_config
%{_mandir}/man*/*
%files devel -f devel-so-list
%{_includedir}/*
@ -144,6 +156,7 @@ done
%changelog
* Thu Jul 4 2013 Honza Horak <hhorak@redhat.com> 2.3.1-6
- Spec file clean-up
- Provide man pages created by Jan Stanek
* Thu Jul 4 2013 Honza Horak <hhorak@redhat.com> 2.3.1-5
- Fix Coverity patch