Manual pages for executables

Jan StanÄ›k <[email protected]> Tue, 18 Feb 2014 10:17:25 +0100
Newsgroups gmane.comp.db.unixodbc.devel
Organization Red Hat
Message-ID <[email protected]>
This is a multi-part message in MIME format.
--------------070006040601020500080606
Content-Type: text/plain; charset=ISO-8859-2
Content-Transfer-Encoding: 7bit

Hello,
I have created manual pages for undocumented executables iusql (which is
added to isql man page and linked to it), dltest and odbc_config.

As an attachment, I send the man pages plus the patch to isql.1.

Best regards,
Jan

-- 
Jan Stanek - Red Hat Associate Developer Engineer - Databases Team

--------------070006040601020500080606
Content-Type: application/x-troff-man;
 name="dltest.1"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
 filename="dltest.1"

.TH dltest 1 "Thu 13 Feb 2014" "version 2.3.2" "UnixODBC manual pages"
.SH NAME
dltest \- A simple library symbol test

.SH SYNOPSIS
.B dltest
.R [
.I library symbol
.R ]

.SH DESCRIPTION
.B dltest
is simple test of occurence of the
.I symbol
in the
.IR library .
The
.I library
must be a full (with path) file name of the shared object, in which the search for
.I symbol
should be performed.

Without any parameters, dltest print short help message.

.SH EXAMPLES
To determine if the symbol
.B printf
is found in the
.IR libc-2\.18\.so :

.RS
$ dltest /usr/lib/libc-2.18.so printf
.RE

.SH AUTHORS
The authors of unixODBC are
.MT [email protected]
Peter Harvey
.ME
and
.MT [email protected]
Nick Gorham
.ME .
For the full list of contributors see the
.I AUTHORS
file.

.SH COPYRIGHT
unixODBC is licensed under the GNU Lesser General Public License. For details
about the license, see the
.I COPYING
file.

--------------070006040601020500080606
Content-Type: application/x-troff-man;
 name="iusql.1"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
 filename="iusql.1"

.so man1/isql.1

--------------070006040601020500080606
Content-Type: application/x-troff-man;
 name="odbc_config.1"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
 filename="odbc_config.1"

.TH odbc_config 1 "Thu 13 Feb 2014" "version 2.3.2" "UnixODBC manual pages"

.SH NAME
odbc_config \- get compile options for compiling unixODBC client

.SH SYNOPSIS
.SY odbc_config
.OP \-\-prefix
.OP \-\-exec-prefix
.OP \-\-include-prefix
.OP \-\-lib-prefix
.OP \-\-bin-prefix
.OP \-\-version
.OP \-\-libs
.OP \-\-static-libs
.OP \-\-libtool-libs
.OP \-\-cflags
.OP \-\-odbcversion
.OP \-\-odbcini
.OP \-\-odbcinstini
.OP \-\-header
.OP \-\-ulen
.YS

.SH DESCRIPTION
.B odbc_config
provides built-in options, specified at build time of the unixODBC suite, which
are useful for building unixODBC clients and similar programs.

.SH OPTIONS
.B
.IP \-\-prefix
Prefix for architecture-independent file tree.

.B
.IP \-\-exec-prefix
Prefix for architecture-dependent file tree.

.B
.IP \-\-include-prefix
Directory with C header files for unixODBC.

.B
.IP \-\-lib-prefix
Directory with object code (.so) libraries.

.B
.IP \-\-bin-prefix
Location of user executables.

.B
.IP \-\-version
unixODBC version.

.B
.IP \-\-libs
Compiler flags for linking dynamic libraries.

.B
.IP \-\-static-libs
Absolute file name of static unixODBC library.

.B
.IP \-\-libtool-libs
Absolute file name of libtool unixODBC library.

.B
.IP \-\-cflags
Compiler flags to find include files and critical compiler flags and defines used
when compiling the libodbc library.

.B
.IP \-\-odbcversion
Version of the ODBC specification used by the unixODBC.

.B
.IP \-\-odbcini
Absolute file name of the system-wide DSN configuration file
.IR odbc.ini .

.B
.IP \-\-odbcinstini
Absolute file name of the driver configuration file
.IR odbcinst.ini .

.B
.IP \-\-header
Definitions of used C preprocessor constants. It is suitable to be piped into
C header file.

.B
.IP \-\-ulen
Compiler flag for defining
.IR SIZEOF_SQLULEN .

.SH SEE ALSO
.BR odbcinst.ini (5),
.BR odbc.ini (5)

.SH AUTHORS
The authors of unixODBC are
.MT [email protected]
Peter Harvey
.ME
and
.MT [email protected]
Nick Gorham
.ME .
For the full list of contributors see the
.I AUTHORS
file.

.SH COPYRIGHT
unixODBC is licensed under the GNU Lesser General Public License. For details
about the license, see the
.I COPYING
file.

--------------070006040601020500080606
Content-Type: text/x-patch;
 name="unixODBC-isql.1.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
 filename="unixODBC-isql.1.patch"

--- unixODBC-2.3.2/man/isql.1	2013-07-04 15:32:06.000000000 +0200
+++ unixODBC-2.3.2/man/isql.1.new	2014-02-18 10:06:43.913129715 +0100
@@ -1,8 +1,7 @@
-\" vim:language en_US.UTF-8:
 .TH isql 1 "Tue 25 Jun 2013" "version 2.3.2" "UnixODBC manual pages"
 
 .SH NAME
-isql - unixODBC command-line interactive SQL tool
+isql, iusql \- unixODBC command-line interactive SQL tool
 
 .SH SYNOPSIS
 \fBisql\fR \fIDSN\fR [\fIUSER\fR [\fIPASSWORD\fR]] [\fIoptions\fR] 
@@ -13,6 +12,9 @@
 or interactively. It has some interesting options such as an option to generate
 output wrapped in an HTML table.
 
+.B iusql
+is the same tool with built-in Unicode support.
+
 .SH ARGUMENTS
 
 .IP \fBDSN\fR

--------------070006040601020500080606
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
unixODBC-dev mailing list
[email protected]
http://mailman.unixodbc.org/mailman/listinfo/unixodbc-dev

--------------070006040601020500080606--