- Introduction
- Installation
- Using the Okapi Tools
- Un-installation
- Samples


The Okapi Tools are .NET components. They have been primarily developed to run under the Microsoft implementation of .NET, however some of them should also be able to run under the Mono implementation.

Note that currently, while filters and utilities components should work for the mot part, only one Okapi application is fit to run under Mono: Tikal. Applications such as Rainbow or Olifant use UI features that are not quite ready for use in Mono. Note also that some others tools like Album are Windows-specific are not meant to run on a different system.

The Okapi distribution for Mono is a work in progress.


To install the Okapi components under Mono you need to do the steps described below. The examples assume that you are under a the openSuSE 10.2 distribution of Linux, and are using bash for shell. Commands may be different depending on your Linux distribution, but it should be comparable.

  1. Download the distribution file from http://sourceforge.net/project/showfiles.php?group_id=42949. The name of the distribution file changes for each release, this document uses OkapiMono-R00000 as a generic name.
  2. Copy the distribution file under the directory of your choice. For example /usr/local if you are logged in as root user, or your Home directory (e.g. /home/username) if you have rights only there.
  3. unzip the distribution file:
gunzip OkapiMono-R00000.tar.gz
  1. Now you should have an uncompressed .tar file, you need to un-tar it:
tar xvf OkapiMono-R00000.tar
  1. This will create a sub-directory called OkapiMono in the current directory.
  2. You can delete the .tar file which is no longer needed.

Using the Okapi Tools

To be able to run Okapi tools under Mono, you need to make sure Mono can find the Okapi shared assemblies. The assemblies are located under <prefix>/OkapiMono/Shared/assemblies (where <prefix> is the directory where you un-zipped the distribution file, so for example: /usr/local/OkapiMono/Shared/Assemblies).

To set the variable, do for example:

export MONO_PATH=$MONO_PATH:/usr/local/OkapiMono/Shared/Assemblies

You also need to specify where is the Okapi root directory. Note that if you do not do this and use Tikal, Tikal will set a default root directory. That default root will be the parent directory of the directory where Tikal.exe is located. If you use your own programs with Okapi components, make sure OKAPI_HOME is defined:

export OKAPI_HOME=/usr/local/OkapiMono

You can find more information on the Okapi components and tools here:


To un-install the Okapi for Mono components from your system, simply delete the OkapiMono directory and all its content.


A few samples files comes with the distribution. They are located in the OkapiMono/Shared/Samples/Mono directory.

Both batch files assume that Mono is setup and that the system can find the Okapi assemblies (i.e. the MONO_PATH variable is set).