Compile and install the Linux Package

In order to install the Linux package, odaba-11.1.0.tar.bz2 (or a higher version) may be downloaded from http://sourceforge.net/p/odaba/ . The package contains the complete documentation and the sources and procedures to build the software.

After unpacking and copying the files to local directories, you have to compile the system. In order to build the basic database libraries and tools, only the base sources need to be build. In order to build the GUI framework and ODABA GUI tools, QT 4 has to be installed as development package. For other dependencies please refer to the INSTALL file in usr/share/doc/odaba

ODABA can be installed on any Linux (Suse, Fedora, Gentoo, Arch). In order to install ODABA, you have to

• unpack the installation file
• compile the source package for your platform
• roll a package and use the facilities provided by your distribution to install

After installing ODABA, menu items for starting ODABA Tools are provided in the applications menu.

Please read the INSTALL file provided with the source package as it contains hints about the dependencies your system has to provide.

In order to unpack the installation file simply call

$ tar xjf odaba-[ version ].tar.bz2

where version is the current version number of the ODABA release (e.g. 11.0.0 ).

The result is the ODABA-source tree in a directory 'odaba-[version]'.

besides the default options that come with the autotools environment (read INSTALL file) there are some options that are worth mentioning:

--enable-gui [default]

--disable-gui

this parameters control the amount of code that is compiled. usually ODABA consists of the database core that provides persistence, servers, interfaces and maintenance tools as well as database utilities that are used for development and management of the schema in a GUI. This GUI is not required in all situations so this is to minimize the build result.

dependent libraries

ODABA makes use of some libraries to implement features. zlib for example is used for compressing databases in order to transfer them over the internet. those libraries are not mandatory to use ODABA therefore their existence enables features.

readline

provides command line history and editing features for the terminal. readline for UNIX is mandatory.

zlib

compresses databases in replication server mode, enables BackupDB, PackDB and UnpackDB to use the zip algorithm to save space and compresses large data blocks in client-server mode.

libzip

used to read and generate OpenDocumentFiles. This feature is useful ODE tools, but they will work without it too, still generating HTML documentation.

libcurl

implements various communication protocols and is used to send emails with the ssmtp protocol. In case the platform does not provide libcurl in a recent version it is still possible to send emails using the unencrypted port 25 or sendmail on UNIX platforms. This feature is useful in ODE tools especially the ticket-tracking feature.

in case the platform that is used to build ODABA does not provide pkg-config it is possible to provide all dependent libraries using variables ( see example )

After unpacking ( unpack ) the installation file one may build the base libraries and tools (ODABA) as well as the GUI framework and GUI tools (ODABA GUI). There is a more detailed guide in share/doc/odaba/INSTALL that also lists the dependencies for common platforms by name.

Compile

In order to build ODABA, you need

g++, libstdc++, readline, libc, libzip, libz

Since ODABA 11.1 autotools are supported. Therefore, configuring build and install of ODABA is now similar to any package you already know by executing

$ ./configure && make && make install

In order to build the ODABA GUI framework, in addition you need

qt4.5 to 4.8

configure will automatically disable features that require libraries not installed on the build-host.

Install

After compilation succeeded install executables:.

$ make install

Depending on the configure parameters this action may require root access to create the directories in the system

The tools need write access to /var/log/odaba and /var/lib/odaba (with configure --prefix=/), which requires that your user is in the 'users' group, which is not the default on every platform. When the start of the tools does not work, try to fix the permissions for /var/lib/odaba and /var/log/odaba so your user can write there.

Consider (e.g. when using a git package) to configure the install prefix with

$ ./configure --prefix=/home/youruser/odaba-[VERSION]

so the process can be restarted without polluting system (the package manager is responsible to change /usr/ !)

all tools then work relative (e.g. ./share/odaba/otool.sh ClassEditor projectxx)

When running into problems:

common reasons for compile errors are:

• different include paths - fix: set eg QtCore_CFLAGS

• different library names - fix: set eg QtCore_LIBS

• missing includes - e.g. some system include is not included as expected - fix: src/#/name/bat/qlib/cppfile, add include

• defect classes - sometimes a class cannot be used on the system (e.g. Windows, only or in development) but is not necessary for the package

It would be nice when you let us know what you fixed for which platform so we can add this to the main line tree.

In order to uninstall ODABA use the package manager of the distribution.

In case the ODE tools have been used some settings may persist in the user configuration (~/.config/run Software-Werkstatt GmbH). The terminal tools (eg OShell also create a .history file in $HOME.