lsm/mdbtools
1
0
Fork 0
mirror of https://github.com/mdbtools/mdbtools.git synced 2025-04-05 20:31:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Remove out of date documentation

Browse Source 
The HTML docs have not been updated in 10+ years. The README and man
pages should suffice for now.
This commit is contained in:
Evan Miller 2020-12-04 09:14:12 -05:00
parent 0ba59e6f23
commit 0444e0a67e
9 changed files with 4 additions and 1413 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.travis.yml
View File

@ -10,7 +10,6 @@ jobs:
packages:
- libiodbc2-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr --disable-glib"
- compiler: clang
@ -21,7 +20,6 @@ jobs:
- libiodbc2-dev
- libglib2.0-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr --enable-glib"
- compiler: clang
@ -31,7 +29,6 @@ jobs:
packages:
- unixodbc-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr --disable-glib"
- compiler: clang
@ -42,7 +39,6 @@ jobs:
- unixodbc-dev
- libglib2.0-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr --enable-glib"
- compiler: gcc
@ -52,7 +48,6 @@ jobs:
packages:
- libiodbc2-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr --disable-glib"
- compiler: gcc
@ -62,7 +57,6 @@ jobs:
packages:
- unixodbc-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr --disable-glib"
- compiler: gcc-10
@ -75,7 +69,6 @@ jobs:
- gcc-10
- libiodbc2-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr --disable-glib"
- compiler: gcc-10
@ -88,7 +81,6 @@ jobs:
- gcc-10
- unixodbc-dev
- gawk
- gtk-doc-tools
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr --disable-glib"
- compiler: clang
@ -100,7 +92,6 @@ jobs:
- libiodbc
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr/local/opt --disable-glib"
- YACC="/usr/local/opt/bison/bin/bison"
@ -114,7 +105,6 @@ jobs:
- glib
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr/local/opt --enable-glib"
- YACC="/usr/local/opt/bison/bin/bison"
@ -127,7 +117,6 @@ jobs:
- unixodbc
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr/local/opt --disable-glib"
- YACC="/usr/local/opt/bison/bin/bison"
@ -141,7 +130,6 @@ jobs:
- glib
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr/local/opt --enable-glib"
- YACC="/usr/local/opt/bison/bin/bison"
@ -154,7 +142,6 @@ jobs:
- libiodbc
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-iodbc=/usr/local/opt --disable-glib"
- YACC="/usr/local/opt/bison/bin/bison"
@ -167,7 +154,6 @@ jobs:
- unixodbc
- bison
- gawk
- gtk-doc
env:
- CONFIGURE_FLAGS="--with-unixodbc=/usr/local/opt --disable-glib"
- YACC="/usr/local/opt/bison/bin/bison"

9
README.md
View File

@ -77,9 +77,6 @@ If you want to build the ODBC driver, you'll need `unixodbc-dev` (version
If you want to build man pages, you'll need
[GNU awk](https://www.gnu.org/software/gawk/).
If you want to generate the html version of the docbook, you'll need
[openjade](http://openjade.sourceforge.net) and basic dsl catalogs.
# Installation
@ -103,13 +100,9 @@ brew install mdbtools
$ autoreconf -i -f
```
If you want to build the html version of the docbook documentation, you need to
set the environment variable `DOCBOOK_DSL` to the modular dsl translation file.
For example, before configure, you need something like:
Then:
```bash
$ export DOCBOOK_DSL=/usr/share/sgml/docbook/stylesheet/dsssl/modular/html/docbook.dsl
$ ./configure
```

46
configure.ac
View File

@ -224,37 +224,6 @@ AM_CONDITIONAL(FAKE_GLIB, test "x$enable_glib" != "xyes")
AC_SUBST([OPTDIRS])
AC_CONFIG_FILES([src/Makefile])
##################################################
# Check for gtk-doc.
##################################################
AC_ARG_WITH(html-dir,
AS_HELP_STRING([--with-html-dir=PATH], [path to installed docs]))
if test "x$with_html_dir" = "x" ; then
HTML_DIR='${datadir}/gtk-doc/html'
else
HTML_DIR=$with_html_dir
fi
AC_SUBST(HTML_DIR)
PKG_CHECK_EXISTS([gtk-doc >= 1.0], GTKDOC=true, GTKDOC=false)
dnl Let people disable the gtk-doc stuff.
AC_ARG_ENABLE(gtk-doc, AS_HELP_STRING([--enable-gtk-doc], [use gtk-doc to build documentation [default=auto]]), enable_gtk_doc="$enableval", enable_gtk_doc=auto)
if test x$enable_gtk_doc = xauto ; then
if test x$GTKDOC = xtrue ; then
enable_gtk_doc=yes
else
enable_gtk_doc=no
fi
fi
AM_CONDITIONAL(ENABLE_GTK_DOC, test x$enable_gtk_doc = xyes)
##################################################
# Check for txt2man
##################################################
@ -290,14 +259,6 @@ fi
AC_SUBST([BASH_COMPLETION_DIR])
AM_CONDITIONAL([ENABLE_BASH_COMPLETION],[test "x$with_bash_completion_dir" != "xno"])
##################################################
# Check for docbook
##################################################
AM_CONDITIONAL(ENABLE_DOCBOOK, test -n "$DOCBOOK_DSL")
localedir=${datadir}/locale
AC_SUBST(localedir)
AC_CONFIG_FILES([
libmdb.pc
libmdbsql.pc
@ -314,7 +275,6 @@ doc/Makefile
mdbtools.spec
include/mdbver.h])
AC_OUTPUT
dnl doc/reference/libmdb/Makefile])
##################################################
# Print summary
@ -334,12 +294,8 @@ if test x$HAVE_ODBC = xtrue; then summary=${bold_green}enabled; else summary=${b
AC_MSG_NOTICE([ ODBC : ${summary}${reset}])
if test x$enable_glib = xyes; then summary=${bold_green}enabled; else summary=${bold_red}disabled; fi
AC_MSG_NOTICE([ GLib : ${summary}${reset}])
if test x$enable_gtk_doc = xyes; then summary=${bold_green}enabled; else summary=${bold_red}disabled; fi
AC_MSG_NOTICE([ Gtk doc : ${summary}${reset}])
if test x$enable_man = xyes; then summary=${bold_green}enabled; else summary=${bold_red}disabled; fi
AC_MSG_NOTICE([ man : ${summary}${reset}])
if test -n "$DOCBOOK_DSL"; then summary=${bold_green}enabled; else summary=${bold_red}disabled; fi
AC_MSG_NOTICE([ html docbook : ${summary}${reset}])
AC_MSG_NOTICE([ man pages : ${summary}${reset}])
if test "x$with_bash_completion_dir" != "xno"; then summary=${bold_green}enabled; else summary=${bold_red}disabled; fi
AC_MSG_NOTICE([ bash-completion : ${summary}${reset}])
AC_MSG_NOTICE([])

22
doc/Makefile.am
View File

@ -9,29 +9,11 @@ if ENABLE_MAN
mdb-array.1 mdb-header.1 mdb-hexdump.1 mdb-parsecsv.1 mdb-prop.1 mdb-import.1 \
mdb-count.1 mdb-json.1 mdb-queries.1
endif
if ENABLE_DOCBOOK
dist_man_MANS += install.tgz
endif
CLEANFILES = ${dist_man_MANS} install install.tgz
CLEANFILES = ${dist_man_MANS}
EXTRA_DIST = mdb-tables.txt mdb-ver.txt mdb-export.txt mdb-schema.txt mdb-sql.txt \
mdb-array.txt mdb-header.txt mdb-hexdump.txt mdb-parsecsv.txt mdb-prop.txt mdb-import.txt \
mdb-count.txt mdb-json.txt mdb-queries.txt \
faq.html install.sgml txt2man
txt2man
.txt.1:
$(TXT2MAN) -t $* -r "$(PRODUCT) $(VERSION)" -s 1 -v "Executable programs or shell commands" $(srcdir)/$< > $@
# Converting DocBook to HTML (several small files)
# http://www.freebsd.org/tutorials/docproj-primer/x3132.html#AEN3140
install.tgz: $(srcdir)/install.sgml
rm -rf html
mkdir html
cd html && \
openjade -d ${DOCBOOK_DSL} -t sgml ../install.sgml
[ -f html/book1.htm ]
ln -s book1.htm html/index.html
[ -L install ] || ln -s html install
tar zcf install.tgz install/*
clean-local:
-rm -rf html

108
doc/faq.html
View File

@ -1,108 +0,0 @@
<html><head>
<title>The MDB Tools FAQ (Frequently Asked Questions)</title></head>
<body bgcolor="white">
<p align="center">
</p><h1>The MDB Tools FAQ</h1>
<p></p>
<dl><dt>
1. General Questions</dt><dd>
<a href="#mdb">1.1 What is an MDB</a>
</dd><dd>
<a href="#what">1.2 What does MDB Tools do</a>
</dd><dd>
<a href="#tools">1.3 What are the tools in MDB Tools</a>
</dd><dd>
<a href="#license">1.4 What license is MDB Tools under</a>
</dd><dd>
<a href="#versions">1.5 What Jet Databases does MDB Tools support?</a>
</dd><dd>
<a href="#roadmap">1.6 Is there a road map</a>
</dd><dd>
<a href="#install">1.7 How do I install</a>
</dd><dd>
<a href="#bug">1.8 I've found a bug</a>
</dd><dd>
<a href="#help">1.9 How do I help?</a>
</dd><dd>
<a href="#postcards">1.10 What's this postcard thing?</a>
</dd><dd>
<a href="#writing">1.11 When will MDB Tools support writing?</a>
</dd></dl>
<hr size="1">
<h2>General Questions</h2>
<dl><a name="mdb"></a><dt><b>1.1 What is an MDB</b></dt><dd>
MDB databases are files produced by the Microsoft 'Jet' database engine. They are used in a variety of Microsoft products such as Money, Project, IIS, and Exchange as well as Accpac's Simply Accounting and Fog Creek's CityDesk, but most importantly, it is used as the format for Microsoft Access databases.
</dd></dl>
<dl><a name="what"></a><dt><b>1.2 What does MDB Tools do</b></dt><dd>
MDB Tools is an open source suite of libraries and utilities to read (and soon write) MDB database files.
</dd></dl>
<dl><a name="tools"></a><dt><b>1.3 What are the tools in MDB Tools</b></dt><dd>
MDB Tools includes
<ul>
<li> LibMDB, a library for accessing MDB files. </li>
<li> MDB Utilities, a set of command line utilities to extract schema and data.</li>
<li> MDBSQL, a SQL engine layered on top of LibMDB.</li>
<li> MDB ODBC driver, a ODBC driver - requires unixODBC driver manager.</li>
<li> gmdb2, a graphical interface including SQL query tool and file debugger.</li>
</ul>
</dd></dl>
<dl><a name="license"></a><dt><b>1.4 What license is MDB Tools under</b></dt><dd>
The libraries in MDB Tools (libmdb, libmdbsql, and libmdbodbc) are licensed under the LGPL. The remainder of the software is license under the GPL.
</dd></dl>
<dl><a name="versions"></a><dt><b>1.5 What Jet Databases does MDB Tools support?</b></dt><dd>
MDB Tools supports Jet version 3.0 and 4.0 databases. It does not, and probably never will support Jet 2.0. I'm looking into adding support for MSDE databases, and if anyone wants to send some sample databases in that format, I'd be very interested.
</dd></dl>
<dl><a name="roadmap"></a><dt><b>1.6 Is there a roadmap?</b></dt><dd>
<p>Roughly, the plan moving forward looks like this.
<ul>
<li>Add index scan capability to libmdb and the SQL engine with a query plan generator.</li>
<li>Add support for adding rows to existing tables and an mdb-import tool.</li>
<li>Add full write support to libmdb and libmdbsql.</li>
<li>Extract queries, table properties, VBA script, forms.</li>
<li>mdb-check database consistency checker and recovery tool.</li>
<li>Add joins.</li>
<li>Ability to add tables.</li>
</ul>
<p>
Of course these are my personal goals, and the direction of the project depends on contributors and feature requests from users.
</p>
</dd></dl>
<dl><a name="install"></a><dt><b>1.7 How do I install</b></dt><dd>
<p>
Consult the <a href="https://raw.github.com/brianb/mdbtools/master/INSTALL">installation guide</a> for details.
</p>
</dd></dl>
<dl><a name="bug"></a><dt><b>1.8 I've found a bug</b></dt><dd>
<p>
Post it to the sourceforge project page so it gets tracked and send a note to the list so we can work it out. I may request details about or a copy of your database. Any database sent will be kept confidential.
</dd></dl>
<dl><a name="help"></a><dt><b>1.9 How do I help?</b></dt><dd>
<p>
Join the mailing list, it's very low traffic at the time of this writing.
</p>
<p>
If you are a programmer, start with the debugger in gmdb2 to get a feel for the database layout. Read the HACKING file included in the distribution.
</p>
<p>
We are currently looking for corrupted Access databases to help with developing recovery tools. If you have them, I will even extract the usable data from them for you for free. ;-)
</p>
</dd></dl>
<dl><a name="postcards"></a><dt><b>1.10 What's this postcard thing?</b></dt><dd>
I, like many free software others, enjoy getting postcards from where users live. If you're a happy MDB Tools user (or even a disgruntled one, doesn't really matter) and want to drop me a postcard with a picture of the place you live, email <a href="mailto:brian@nospam.bruns.com">me</a> for my snail-mail address. Come on, you know you want to!
</dd></dl>
<dl><a name="writing"></a><dt><b>1.11 When will MDB Tools support writing?</b></dt><dd>
Writing to MDB files is a quite a bit more complicated than simply reading. Some preliminary support is available in the CVS version, this includes under-the-covers things like building rows, adding rows to tables, tracing the index chain to the row, and some work on index writes. These are the nuts and bolts of write support; the big thing left is the allocation of new pages and splitting full pages on inserts. When will this be done? I don't commit to timelines, but the next release (0.7) will have some usable, though not complete, write support.
</dd></dl>
</body></html>

873
doc/install.sgml
View File

@ -1,873 +0,0 @@
<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
]>
<book>
<bookinfo>
<date>$Date: 2005/09/07 23:27:43 $</date>
<releaseinfo>$Revision: 1.7 $</releaseinfo>
<title><productname>MDB Tools</productname> Installation Guide</title>
<subtitle>A Guide to Installing and Configuring <productname>MDB Tools</productname></subtitle>
<author>
<firstname>Brian</firstname>
<surname>Bruns</surname>
</author>
<copyright>
<year>2003</year>
<holder>Brian Bruns</holder>
</copyright>
<legalnotice><para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled <link linkend="gfdl">GNU
Free Documentation License</link>.</para>
</legalnotice>
</bookinfo>
<toc></toc>
<!-- ////////////////// CHAPTER /////////////////////// -->
<preface><title>About this Guide</title>
<para>
This guide is intended to provide help with installing and configuring the <productname>MDB Tools</productname> suite of programs. It is a work in progress and the author will happily accept new material, clarifications, or other enhancements in any format. Patches to the original DocBook format can be uploaded to the SourceForge patch area under the <ulink url="http://www.sourceforge.net/projects/mdbtools">MDB Tools project page</ulink>. Changes in plain text and other formats can be submitted directly to the mailing list or the author.
</para>
<para>
A few technical notes. This guide is written in SGML DocBook format, specifications for which are found in the <ulink url="http://www.docbook.org/tdg/en/html/docbook.html">DocBook book</ulink>. It was converted to HTML with <ulink url="http://openjade.sourceforge.net">OpenJade</ulink>.
The document you are reading is version
$Revision: 1.7 $
, dated
$Date: 2005/09/07 23:27:43 $ (CVS control number $Id: install.sgml,v 1.7 2005/09/07 23:27:43 brianb Exp $). The most recent version can be found on the <productname>MDB Tools</productname>
<ulink url="http://mdbtools.sourceforge.net/userguide/">web site</ulink>.
</para>
</preface>
<chapter id="what">
<title>What is <productname>MDB Tools</productname>?</title>
<para>
<productname>MDB Tools</productname> is a suite of libraries and programs to facilitate the use of Microsoft Access databases, also known as Jet databases after the Microsoft's Jet Database Engine or as MDB databases after the .mdb extension used by the file containing the database.
</para>
<para>
<productname>MDB Tools</productname>is open source software (also known as free software if you prefer) which means source code is provided under a license which allows you as a user to modify and redistribute the software. In particular, the libraries that come with <productname>MDB Tools</productname> are licensed under the Gnu LGPL (Lesser General Public License) and the utility programs, graphical interface, and miscellania are licensed under the Gnu GPL (General Public License). More information about these licenses can be found in the <filename>COPYING.LIB</filename> and <filename>COPYING</filename> files distributed with <productname>MDB Tools</productname> or from the <ulink url="http://www.gnu.org">Gnu site</ulink>.
</para>
<para>
</para>
</chapter>
<chapter id="components">
<title>Components of the <productname>MDB Tools</productname> Suite</title>
<para>
<productname>MDB Tools</productname> is composed of three libraries, a set of command line utilities and a graphical interface.
</para>
<sect1 id="libmdb">
<title>LibMDB</title>
<para>
libmdb is the lowest level library. It handles the details of reading from and writing to the MDB file format. Atop this library sits all the other functionality of <productname>MDB Tools</productname>.
</para>
<para>
A complete description of libmdb will be available in the forthcoming <productname>MDB Tools</productname> Programmer's Guide. For now you can look at the utility programs for a general idea of how to use the API, it's fairly straightforward.
</para>
</sect1>
<sect1 id="utilities">
<title>Command Line Utilities</title>
<para>
<productname>MDB Tools</productname> comes with a set of command line utilties that allow mdb files to be used in shell scripting, extraction to another database, and similar functions. Each program is documented in its man page. A brief synopsis follows.
<table>
<title>MDB Utilities</title>
<tgroup cols="2">
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>mdb-tables</entry>
<entry>list tables in the specified file</entry>
</row>
<row>
<entry>mdb-schema</entry>
<entry>generate schema DDL for the specified file</entry>
</row>
<row>
<entry>mdb-export</entry>
<entry>generate CSV style output for a table</entry>
</row>
<row>
<entry>mdb-ver</entry>
<entry>display the version of the specified file</entry>
</row>
<row>
<entry>mdb-header</entry>
<entry>support for using MDB data in C</entry>
</row>
<row>
<entry>mdb-parsecsv</entry>
<entry>support for using MDB data in C</entry>
</row>
<row>
<entry>mdb-sql</entry>
<entry>command line SQL query tool</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</sect1>
<sect1 id="libmdbsql">
<title>LibMDBSQL (the SQL Engine)</title>
<para>
LibMDBSQL is an SQL engine which provides a subset of the SQL query language to access MDB databases. It is used with the ODBC driver, by the mdb-sql utility, and by the query window in gmdb2.
</para>
<para>
For a description of the supported SQL, see the mdb-sql man page.
</para>
</sect1>
<sect1 id="libmdbodbc">
<title>LibMDBODBC</title>
<para>
LibMDBODBC is an ODBC driver that works with the unixODBC driver manager to allow MDB Tools to work with such programs as PHP and Perl (via DBD::ODBC). At the time of this writing, the breadth of coverage for the driver is rather limited. If you have specific problems with it, please contact the list and they can most likely be resolved.
</para>
<para>
The ODBC driver relies on LibMDB and LibMDBSQL.
</para>
</sect1>
<sect1 id="gmdb2">
<title>Gmdb2</title>
<para>
Gmdb2 is a graphical interface to the functionality of MDB Tools. Its interface resembles that of access with a tabbed interface to each of the object types in the database (tables, queries, forms, etc...). Additonally, it sports an SQL Query window, and a file debugger useful for developers or anybody interested in examining the dark secrets of the MDB file format.
</para>
<para>
For information on how to use gmdb2, see the manual under the Help menu.
</para>
</sect1>
</chapter>
<chapter id="requirements">
<title>Requirements</title>
<para>
<productname>MDB Tools</productname> like most packages has some requirements for libraries and such on your system. Most of them are optional and will turn off certain features if not present.
</para>
<sect1 id="reqtable">
<title>Requirements Matrix</title>
<para>
The following matrix lists all requirements and which features they affect. An X in the major feature categories (SQL, ODBC, gmdb2) means these features will be turned off if the prequisite is not found.
</para>
<table>
<title>Prerequisites</title>
<tgroup cols="6">
<thead>
<row>
<entry>Name</entry>
<entry>SQL</entry>
<entry>ODBC</entry>
<entry>gmdb2</entry>
<entry>Source</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry>glib 2.0</entry>
<entry>X</entry>
<entry>X</entry>
<entry>X</entry>
<entry><ulink url="http://www.gtk.org">www.gtk.org</ulink></entry>
<entry>Absolutely required, will not install without</entry>
</row>
<row>
<entry>readline</entry>
<entry></entry>
<entry></entry>
<entry></entry>
<entry><ulink url="http://cnswww.cns.cwru.edu/~chet/readline/rltop.html">http://cnswww.cns.cwru.edu/~chet/readline/rltop.html</ulink></entry>
<entry>Supports history in mdb-sql, will compile without history if not found.</entry>
</row>
<row>
<entry>bison/yacc</entry>
<entry>X</entry>
<entry>X</entry>
<entry></entry>
<entry><ulink url="http://www.gnu.org/software/bison/bison.html">www.gnu.org</ulink></entry>
<entry>gmdb2 will not have a SQL window and mdb-sql will be stubbed out.</entry>
</row>
<row>
<entry>flex</entry>
<entry>X</entry>
<entry>X</entry>
<entry></entry>
<entry><ulink url="http://www.gnu.org/software/flex/flex.html">www.gnu.org</ulink></entry>
<entry>gmdb2 will not have a SQL window and mdb-sql will be stubbed out.</entry>
</row>
<row>
<entry>unixODBC</entry>
<entry></entry>
<entry>X</entry>
<entry></entry>
<entry><ulink url="http://www.unixodbc.com">www.unixodbc.com</ulink></entry>
<entry></entry>
</row>
<row>
<entry>Gnome 2.0</entry>
<entry></entry>
<entry></entry>
<entry>X</entry>
<entry><ulink url="http://www.gnome.org">www.gnome.org</ulink></entry>
<entry></entry>
</row>
<row>
<entry>libglade</entry>
<entry></entry>
<entry></entry>
<entry>X</entry>
<entry><ulink url="http://www.gnome.org">www.gnome.org</ulink></entry>
<entry></entry>
</row>
<row>
<entry>wordexp</entry>
<entry></entry>
<entry></entry>
<entry></entry>
<entry></entry>
<entry>Part of the OS, without it ~ expansion in SQL engine will be disabled</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
</chapter>
<chapter id="installopts">
<title>Installation Options</title>
<para>
<productname>MDB Tools</productname> call be installed from binaries or by compiling the source package.
</para>
<sect1 id="rpm">
<title>RPMs</title>
<para>
RPMs are made available for major releases (not including pre-release or release candidates). The RPM packages are split up along feature boundaries with a core package, a development package, an ODBC package, and a graphical package. To install, simply log in as root and run the following.
<screen>
<prompt>$ </prompt><userinput>rpm -i mdbtools-0.5-1.rpm</userinput>
<prompt>$ </prompt><userinput>rpm -i mdbtools-devel-0.5-1.rpm</userinput>
<prompt>$ </prompt><userinput>rpm -i mdbtools-odbc-0.5-1.rpm</userinput>
<prompt>$ </prompt><userinput>rpm -i mdbtools-gui-0.5-1.rpm</userinput>
</screen>
</para>
</sect1>
<sect1 id="otherpkg">
<title>Other Binary Packages</title>
<para>
Packages for other systems (debian, bsd ports, etc...) may be available, check with your OS vendor.
</para>
</sect1>
<sect1 id="source">
<title>Source</title>
<para>
If none of the binary options are available to you, or if you prefer, you can configure and compile from the source packages. The next chapter will demonstrate that.
</para>
</sect1>
</chapter>
<chapter id="srcinstall">
<title>Installing from Source</title>
<para>
There are three basic steps to installing from source
</para>
<orderedlist>
<listitem><para>configuring</para></listitem>
<listitem><para>building</para></listitem>
<listitem><para>installing</para></listitem>
</orderedlist>
<sect1 id="tarcfg">
<title>Configuring from the tarball</title>
<para>
If you are installing a release or snapshot tarball follow these steps. These steps assume the tarballs name is <filename>mdbtools-0.5.tgz</filename>.
<screen>
<prompt>$ </prompt><userinput>zcat mdbtools-0.5.tgz | tar xvf -</userinput>
<prompt>$ </prompt><userinput>cd mdbtools-0.5</userinput>
<prompt>$ </prompt><userinput>./configure</userinput>
</screen>
If you want to include ODBC support, use the --with-unixodbc argument with the location you installed it to (<filename>/usr/local</filename> by default).
<screen>
<prompt>$ </prompt><userinput>zcat mdbtools-0.5.tgz | tar xvf -</userinput>
<prompt>$ </prompt><userinput>cd mdbtools-0.5</userinput>
<prompt>$ </prompt><userinput>./configure --with-unixodbc=/usr/local</userinput>
</screen>
</para>
</sect1>
<sect1 id="cvscfg">
<title>Configuring from CVS</title>
<para>
If you are looking for the very latest code you can check out it out of CVS and compile. The configure step uses the <filename>autogen.sh</filename> script so it's a bit different.
<screen>
<prompt>$ </prompt><userinput>cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mdbtools login</userinput>
<prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mdbtools co</userinput>
<prompt>$ </prompt><userinput>cd mdbtools</userinput>
<prompt>$ </prompt><userinput>./autogen.sh --with-unixodbc=/usr/local</userinput>
</screen>
Again, if you don't want ODBC support remove the --with-unixodbc flag.
</para>
</sect1>
<sect1 id="build">
<title>Building</title>
<para>
Once you are finished configuring simply type <command>make</command> to build.
<screen>
<prompt>$ </prompt><userinput>make</userinput>
</screen>
</para>
</sect1>
<sect1 id="install">
<title>Installing</title>
<para>
To install, sign in as root and type <command>make install</command>
<screen>
<prompt>$ </prompt><userinput>su -</userinput>
<prompt># </prompt><userinput>make install</userinput>
</screen>
</para>
</sect1>
</chapter>
<chapter id="postinstall">
<title>Post Install Configuration</title>
<para>
There are a couple of things that can be configured in the package.
</para>
<sect1 id="mdbpath">
<title>MDBPATH</title>
<para>
If you store your MDB files together in directories you can use the MDBPATH environment variable to have <productname>MDB Tools</productname> search the path similiar to PATH, MANPATH, LD_LIBRARY_PATH (or LIBPATH), etc... Like those, the : (colon) is used as a separator.
</para>
<para>
If you run sh, ksh, or bash
<screen>
<prompt>$ </prompt><userinput>MDBPATH=/home/myuser/mdbfiles:/data/mdbfiles ; export MDBPATH</userinput>
</screen>
If you run csh or tcsh
<screen>
<prompt>$ </prompt><userinput>setenv MDBPATH /home/myuser/mdbfiles:/data/mdbfiles</userinput>
</screen>
This will cause <productname>MDB Tools</productname> to first attempt to open the file using the filename or path provided (current directory or absolute path), then to walk through each entry in the MDBPATH file looking for it. It will stop at the first match.
</para>
<para>
The MDBPATH variable affects all utilities and any program calling mdb_open().
</para>
</sect1>
<sect1 id="iconv">
<title>Character set encoding</title>
<para>
Jet 4 databases are encoded using UCS2-LE (Unicode 2 byte little endian) encoding. MDB Tools will convert these values using the "iconv" standard to UTF-8 by default. If your terminal or other output uses an encoding other than UTF-8 you can override the default behaviour by setting the MDBICONV to the desired character set.
</para>
<para>
For sh, ksh, or bash
<screen>
<prompt>$ </prompt><userinput>MDBICONV=ISO_8859-1 ; export MDBICONV</userinput>
</screen>
Or for csh or tcsh
<screen>
<prompt>$ </prompt><userinput>setenv MDBICONV ISO_8859-1</userinput>
</screen>
</para>
<para>
To view a list of possible character sets, you can run the <command>iconv --list</command> command on most Linux systems. Otherwise, consult your vendors documentation.
</para>
<para>
Jet 3 databases use the character set of the machine on which they were created. For US-English systems this will be cp1252 which is assumed by MDB Tools as the default. To use a file generated with another version of Access, set the MDB_JET3_CHARSET environment variable.
</para>
</sect1>
<sect1 id="odbcini">
<title>ODBC</title>
<para>
In order to use ODBC you must place an entry in the <filename>odbcinst.ini</filename> file.
</para>
<example>
<title><filename>odbcinst.ini</filename> file</title>
<programlisting>
[MDBTools]
Description = MDBTools Driver
Driver = /usr/local/lib/libmdbodbc.so
Setup = /usr/local/lib/libmdbodbc.so
FileUsage = 1
</programlisting>
</example>
<para>
You will also need an entry in <filename>odbc.ini</filename> for each DSN.
</para>
<example>
<title><filename>odbc.ini</filename> file</title>
<programlisting>
[Northwind]
Description = Northwind Sample Database
Driver = MDBTools
Database = /data/mdbfiles/Northwind.mdb
</programlisting>
</example>
<para>
Consult the unixODBC documentation for full details.
</para>
</sect1>
</chapter>
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- sect1>
<title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
<blockquote id="fsf-copyright">
<para>Copyright (C) 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.</para>
</blockquote>
<sect1 id="gfdl-0">
<title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook,
or other written document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or
noncommercially. Secondarily, this License preserves for the
author and publisher a way to get credit for their work, while not
being considered responsible for modifications made by
others.</para>
<para>This License is a kind of "copyleft", which means that
derivative works of the document must themselves be free in the
same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.</para>
<para>We have designed this License in order to use it for manuals
for free software, because free software needs free documentation:
a free program should come with manuals providing the same
freedoms that the software does. But this License is not limited
to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a
printed book. We recommend this License principally for works
whose purpose is instruction or reference.</para>
</sect1>
<sect1 id="gfdl-1">
<title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. The "Document",
below, refers to any such manual or work. Any member of the
public is a licensee, and is addressed as "you".</para>
<para>A "Modified Version" of the Document means any work
containing the Document or a portion of it, either copied
verbatim, or with modifications and/or translated into another
language.</para>
<para>A "Secondary Section" is a named appendix or a front-matter
section of the Document that deals exclusively with the
relationship of the publishers or authors of the Document to the
Document's overall subject (or to related matters) and contains
nothing that could fall directly within that overall subject.
(For example, if the Document is in part a textbook of
mathematics, a Secondary Section may not explain any mathematics.)
The relationship could be a matter of historical connection with
the subject or with related matters, or of legal, commercial,
philosophical, ethical or political position regarding
them.</para>
<para>The "Invariant Sections" are certain Secondary Sections
whose titles are designated, as being those of Invariant Sections,
in the notice that says that the Document is released under this
License.</para>
<para>The "Cover Texts" are certain short passages of text that
are listed, as Front-Cover Texts or Back-Cover Texts, in the
notice that says that the Document is released under this
License.</para>
<para>A "Transparent" copy of the Document means a
machine-readable copy, represented in a format whose specification
is available to the general public, whose contents can be viewed
and edited directly and straightforwardly with generic text
editors or (for images composed of pixels) generic paint programs
or (for drawings) some widely available drawing editor, and that
is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format
whose markup has been designed to thwart or discourage subsequent
modification by readers is not Transparent. A copy that is not
"Transparent" is called "Opaque".</para>
<para>Examples of suitable formats for Transparent copies include
plain ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available DTD, and
standard-conforming simple HTML designed for human modification.
Opaque formats include PostScript, PDF, proprietary formats that
can be read and edited only by proprietary word processors, SGML
or XML for which the DTD and/or processing tools are not generally
available, and the machine-generated HTML produced by some word
processors for output purposes only.</para>
<para>The "Title Page" means, for a printed book, the title page
itself, plus such following pages as are needed to hold, legibly,
the material this License requires to appear in the title page.
For works in formats which do not have any title page as such,
"Title Page" means the text near the most prominent appearance of
the work's title, preceding the beginning of the body of the
text.</para>
</sect1>
<sect1 id="gfdl-2">
<title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium,
either commercially or noncommercially, provided that this
License, the copyright notices, and the license notice saying this
License applies to the Document are reproduced in all copies, and
that you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or
distribute. However, you may accept compensation in exchange for
copies. If you distribute a large enough number of copies you
must also follow the conditions in section 3.</para>
<para>You may also lend copies, under the same conditions stated
above, and you may publicly display copies.</para>
</sect1>
<sect1 id="gfdl-3">
<title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more
than 100, and the Document's license notice requires Cover Texts,
you must enclose the copies in covers that carry, clearly and
legibly, all these Cover Texts: Front-Cover Texts on the front
cover, and Back-Cover Texts on the back cover. Both covers must
also clearly and legibly identify you as the publisher of these
copies. The front cover must present the full title with all
words of the title equally prominent and visible. You may add
other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim
copying in other respects.</para>
<para>If the required texts for either cover are too voluminous to
fit legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto
adjacent pages.</para>
<para>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a
machine-readable Transparent copy along with each Opaque copy, or
state in or with each Opaque copy a publicly-accessible
computer-network location containing a complete Transparent copy
of the Document, free of added material, which the general
network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the
latter option, you must take reasonably prudent steps, when you
begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you
distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.</para>
<para>It is requested, but not required, that you contact the
authors of the Document well before redistributing any large
number of copies, to give them a chance to provide you with an
updated version of the Document.</para>
</sect1>
<sect1 id="gfdl-4">
<title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the
Document under the conditions of sections 2 and 3 above, provided
that you release the Modified Version under precisely this
License, with the Modified Version filling the role of the
Document, thus licensing distribution and modification of the
Modified Version to whoever possesses a copy of it. In addition,
you must do these things in the Modified Version:</para>
<orderedlist numeration="upperalpha">
<listitem><para>Use in the Title Page
(and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if
there were any, be listed in the History section of the
Document). You may use the same title as a previous version if
the original publisher of that version gives permission.</para>
</listitem>
<listitem><para>List on the Title Page,
as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version,
together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than
five).</para>
</listitem>
<listitem><para>State on the Title page
the name of the publisher of the Modified Version, as the
publisher.</para>
</listitem>
<listitem><para>Preserve all the
copyright notices of the Document.</para>
</listitem>
<listitem><para>Add an appropriate
copyright notice for your modifications adjacent to the other
copyright notices.</para>
</listitem>
<listitem><para>Include, immediately
after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this
License, in the form shown in the Addendum below.</para>
</listitem>
<listitem><para>Preserve in that license
notice the full lists of Invariant Sections and required Cover
Texts given in the Document's license notice.</para>
</listitem>
<listitem><para>Include an unaltered
copy of this License.</para>
</listitem>
<listitem><para>Preserve the section
entitled "History", and its title, and add to it an item stating
at least the title, year, new authors, and publisher of the
Modified Version as given on the Title Page. If there is no
section entitled "History" in the Document, create one stating
the title, year, authors, and publisher of the Document as given
on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.</para>
</listitem>
<listitem><para>Preserve the network
location, if any, given in the Document for public access to a
Transparent copy of the Document, and likewise the network
locations given in the Document for previous versions it was
based on. These may be placed in the "History" section. You
may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.</para>
</listitem>
<listitem><para>In any section entitled
"Acknowledgements" or "Dedications", preserve the section's
title, and preserve in the section all the substance and tone of
each of the contributor acknowledgements and/or dedications
given therein.</para>
</listitem>
<listitem><para>Preserve all the
Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not
considered part of the section titles.</para>
</listitem>
<listitem><para>Delete any section
entitled "Endorsements". Such a section may not be included in
the Modified Version.</para>
</listitem>
<listitem><para>Do not retitle any
existing section as "Endorsements" or to conflict in title with
any Invariant Section.</para>
</listitem>
</orderedlist>
<para>If the Modified Version includes new front-matter sections
or appendices that qualify as Secondary Sections and contain no
material copied from the Document, you may at your option
designate some or all of these sections as invariant. To do this,
add their titles to the list of Invariant Sections in the Modified
Version's license notice. These titles must be distinct from any
other section titles.</para>
<para>You may add a section entitled "Endorsements", provided it
contains nothing but endorsements of your Modified Version by
various parties--for example, statements of peer review or that
the text has been approved by an organization as the authoritative
definition of a standard.</para>
<para>You may add a passage of up to five words as a Front-Cover
Text, and a passage of up to 25 words as a Back-Cover Text, to the
end of the list of Cover Texts in the Modified Version. Only one
passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the
Document already includes a cover text for the same cover,
previously added by you or by arrangement made by the same entity
you are acting on behalf of, you may not add another; but you may
replace the old one, on explicit permission from the previous
publisher that added the old one.</para>
<para>The author(s) and publisher(s) of the Document do not by
this License give permission to use their names for publicity for
or to assert or imply endorsement of any Modified Version.</para>
</sect1>
<sect1 id="gfdl-5">
<title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released
under this License, under the terms defined in section 4 above for
modified versions, provided that you include in the combination
all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your
combined work in its license notice.</para>
<para>The combined work need only contain one copy of this
License, and multiple identical Invariant Sections may be replaced
with a single copy. If there are multiple Invariant Sections with
the same name but different contents, make the title of each such
section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section
titles in the list of Invariant Sections in the license notice of
the combined work.</para>
<para>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section
entitled "History"; likewise combine any sections entitled
"Acknowledgements", and any sections entitled "Dedications". You
must delete all sections entitled "Endorsements."</para>
</sect1>
<sect1 id="gfdl-6">
<title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and
other documents released under this License, and replace the
individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of
the documents in all other respects.</para>
<para>You may extract a single document from such a collection,
and distribute it individually under this License, provided you
insert a copy of this License into the extracted document, and
follow this License in all other respects regarding verbatim
copying of that document.</para>
</sect1>
<sect1 id="gfdl-7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of
a storage or distribution medium, does not as a whole count as a
Modified Version of the Document, provided no compilation
copyright is claimed for the compilation. Such a compilation is
called an "aggregate", and this License does not apply to the
other self-contained works thus compiled with the Document, on
account of their being thus compiled, if they are not themselves
derivative works of the Document.</para>
<para>If the Cover Text requirement of section 3 is applicable to
these copies of the Document, then if the Document is less than
one quarter of the entire aggregate, the Document's Cover Texts
may be placed on covers that surround only the Document within the
aggregate. Otherwise they must appear on covers around the whole
aggregate.</para>
</sect1>
<sect1 id="gfdl-8">
<title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section
4. Replacing Invariant Sections with translations requires
special permission from their copyright holders, but you may
include translations of some or all Invariant Sections in addition
to the original versions of these Invariant Sections. You may
include a translation of this License provided that you also
include the original English version of this License. In case of
a disagreement between the translation and the original English
version of this License, the original English version will
prevail.</para>
</sect1>
<sect1 id="gfdl-9">
<title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the
Document except as expressly provided for under this License. Any
other attempt to copy, modify, sublicense or distribute the
Document is void, and will automatically terminate your rights
under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses
terminated so long as such parties remain in full
compliance.</para>
</sect1>
<sect1 id="gfdl-10">
<title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised
versions of the GNU Free Documentation License from time to time.
Such new versions will be similar in spirit to the present
version, but may differ in detail to address new problems or
concerns. See <ulink
url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
<para>Each version of the License is given a distinguishing
version number. If the Document specifies that a particular
numbered version of this License "or any later version" applies to
it, you have the option of following the terms and conditions
either of that specified version or of any later version that has
been published (not as a draft) by the Free Software Foundation.
If the Document does not specify a version number of this License,
you may choose any version ever published (not as a draft) by the
Free Software Foundation.</para>
</sect1>
<sect1 id="gfdl-11">
<title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include
a copy of the License in the document and put the following
copyright and license notices just after the title page:</para>
<blockquote id="sample-copyright"><para>
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
</para></blockquote>
<para>If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you have
no Front-Cover Texts, write "no Front-Cover Texts" instead of
"Front-Cover Texts being LIST"; likewise for Back-Cover
Texts.</para>
<para>If your document contains nontrivial examples of program
code, we recommend releasing these examples in parallel under your
choice of free software license, such as the GNU General Public
License, to permit their use in free software.</para>
</sect1>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-parent-document: ("referenz.sgml" "appendix")
sgml-exposed-tags:nil
sgml-local-ecat-files:nil
sgml-local-catalogs: CATALOG
sgml-validate-command: "nsgmls -s referenz.sgml"
ispell-skip-sgml: t
End:
-->
</book>

190
doc/reference/libmdb/Makefile.am
View File

@ -1,190 +0,0 @@
## Process this file with automake to produce Makefile.in
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.
# The name of the module, e.g. 'glib'.
DOC_MODULE=libmdb
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/src/libmdb
DOC_HEADER_DIR=$(top_srcdir)/include
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
SCANOBJ_OPTIONS=
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=
# Used for dependencies.
HFILE_GLOB=
CFILE_GLOB=
# Header files to ignore when scanning.
IGNORE_HFILES=
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files =
# Other files to distribute.
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS =
GTKDOC_LIBS =
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
# If you need to override some of the declarations, place them in the
# $(DOC_MODULE)-overrides.txt file and uncomment the second line here.
DOC_OVERRIDES =
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
###########################################################################
# Everything below here is generic and you shouldn't need to change it.
###########################################################################
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
EXTRA_DIST = \
$(content_files) \
$(extra_files) \
$(HTML_IMAGES) \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).types \
$(DOC_MODULE)-sections.txt \
$(DOC_OVERRIDES)
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
SCANOBJ_FILES = \
$(DOC_MODULE).args \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).interfaces \
$(DOC_MODULE).prerequisites \
$(DOC_MODULE).signals
if ENABLE_GTK_DOC
all-local: html-build.stamp
#### scan ####
scan-build.stamp: $(HFILE_GLOB)
@echo '*** Scanning header files ***'
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj $(SCANOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
else \
cd $(srcdir) ; \
for i in $(SCANOBJ_FILES) ; do \
test -f $$i || touch $$i ; \
done \
fi
cd $(srcdir) && \
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_HEADER_DIR) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@true
#### templates ####
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
@echo '*** Rebuilding template files ***'
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
touch tmpl-build.stamp
tmpl.stamp: tmpl-build.stamp
@true
#### sgml ####
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
@echo '*** Building SGML ***'
cd $(srcdir) && \
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
@true
#### html ####
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
@echo '*** Building HTML ***'
test -d $(srcdir)/html || mkdir $(srcdir)/html
cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@echo '-- Fixing Crossreferences'
cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
touch html-build.stamp
endif
##############
clean-local:
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
fi)
#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
@echo "*** gtk-doc must be installed and enabled in order to make dist"
@false
endif
dist-hook: dist-check-gtkdoc dist-hook-local
mkdir $(distdir)/tmpl
mkdir $(distdir)/sgml
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/html/index.sgml $(distdir)/html
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
images=$(HTML_IMAGES) ; \
for i in $$images ; do \
cp $(srcdir)/$$i $(distdir)/html ; \
done
.PHONY : dist-hook-local

13
doc/reference/libmdb/libmdb-docs.sgml
View File

@ -1,13 +0,0 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY libmdb-mdbtools SYSTEM "sgml/mdbtools.sgml">
]>
<book id="index">
<bookinfo>
<title>LibMDB Reference Manual</title>
</bookinfo>
<chapter>
<title>LibMDB Function List</title>
&libmdb-mdbtools;
</chapter>
</book>

142
doc/reference/libmdb/libmdb-sections.txt
View File

@ -1,142 +0,0 @@
<SECTION>
<FILE>mdbtools</FILE>
MDB_DEBUG
MDB_PGSIZE
MDB_MAX_OBJ_NAME
MDB_MAX_COLS
MDB_MAX_IDX_COLS
MDB_CATALOG_PG
MDB_MEMO_OVERHEAD
MDB_BIND_SIZE
MdbStrategy
mdb_is_logical_op
mdb_is_relational_op
IS_JET4
IS_JET3
mdb_backends
MdbBackendType
MdbBackend
MdbStatistics
MdbFile
MdbFormatConstants
MdbHandle
MdbCatalogEntry
MdbProperties
MdbColumn
mdbsargtree
MdbIndexPage
MDB_MAX_INDEX_DEPTH
MdbIndexChain
MdbTableDef
MdbColumnProp
MdbField
MdbSarg
<SUBSECTION>
mdb_init
mdb_open
mdb_close
mdb_clone_handle
mdb_exit
<SUBSECTION>
mdb_read_catalog
mdb_dump_catalog
mdb_free_catalog
<SUBSECTION>
mdb_read_table
mdb_rewind_table
mdb_table_dump
mdb_free_tabledef
<SUBSECTION>
mdb_read_columns
mdb_get_objtype_string
mdb_bind_column_by_name
mdb_data_dump
mdb_bind_column
mdb_fetch_row
mdb_is_fixed_col
mdb_col_to_string
mdb_find_end_of_row
mdb_col_fixed_size
mdb_col_disp_size
mdb_ole_read_next
mdb_ole_read
mdb_set_date_fmt
mdb_read_row
mdb_get_coltype_string
mdb_coltype_takes_length
mdb_init_backends
mdb_register_backend
mdb_remove_backends
mdb_set_default_backend
mdb_get_relationships
mdb_sql_walk_tree
mdb_find_indexable_sargs
mdb_add_sarg_by_name
<SUBSECTION>
mdb_read_indices
mdb_index_dump
mdb_index_scan_free
mdb_index_find_next_on_page
mdb_index_find_next
mdb_index_hash_text
mdb_index_scan_init
mdb_index_find_row
<SUBSECTION>
mdb_stats_on
mdb_stats_off
mdb_dump_stats
<SUBSECTION>
mdb_like_cmp
mdb_crack_row
mdb_add_row_to_pg
mdb_update_index
mdb_pack_row
mdb_replace_row
mdb_pg_get_freespace
mdb_update_row
mdb_new_data_pg
mdb_map_find_next_freepage
<SUBSECTION>
mdb_read_props_list
mdb_free_props
mdb_read_props
<SUBSECTION>
mdb_create_temp_table
mdb_temp_table_add_col
mdb_fill_temp_col
mdb_fill_temp_field
<SUBSECTION>
mdb_get_option
mdb_debug
<SUBSECTION>
mdb_unicode2ascii
mdb_ascii2unicode
<SUBSECTION Private>
mdb_test_string
mdb_test_int
mdb_add_sarg
buffer_dump
mdb_read_pg
mdb_read_alt_pg
mdb_get_byte
mdb_get_int16
mdb_get_int32
mdb_get_int32_msb
mdb_get_single
mdb_get_double
mdb_pg_get_byte
mdb_pg_get_int16
mdb_pg_get_int32
mdb_pg_get_single
mdb_pg_get_double
mdb_swap_pgbuf
mdb_index_swap_n
mdb_test_sargs
mdb_test_sarg
read_pg_if_16
read_pg_if_32
read_pg_if
read_pg_if_n
mdb_alloc_tabledef
</SECTION>