Indri Documentation

5.2

Installation

• To configure indri
  1. go to top level indri directory.
  2. run configure to generate MakeDefns and Makefile.app. configure accepts following arguments:
     • --prefix=<install-directory> Specifies the base directory for installation. Default is /usr/local.
     • --enable-assert Enable assert statements in the code. Default is disabled.
     • --enable-java compiles and installs the swig generated java wrappers. Default is disabled.
     • --enable-php compiles and installs the swig generated php wrappers. Default is disabled.
     • --enable-csharp compiles and installs the swig generated C# wrappers. Default is disabled.
     • --with-javahome= Path to JAVAHOME for compiling the swig generated shared library.
     • --with-php-config= Path to php-config binary. Only required if php-config is not on the path.
     • --with-swig= Path to swig binary. Only required if the wrapper interfaces are changed.
     • --with-site-seed=<hostname> Hostname to use as the seed for building a site search index.

• To make the indri library and applications
  1. go to top level indri directory.
  2. configure indri
  3. run make (or gmake)

• To clean the indri source tree (remove everything but the source)
  1. go to top level indri directory.
  2. run make clean (or gmake clean)

• To install the indri library and applications.
  1. go to top level indri directory.
  2. configure indri
  3. run make (or gmake)
  4. run make install (or gmake install)

The indri include files will be installed in <install-directory>/include/indri and <install-directory>/include/lemur. The indri library will be installed in <install-directory>/lib/libindri.a, and the applications will be installed in <install-directory>/bin.

Documentation will be installed in <install-directory>/share/indri/doc. The file index.html points into the doxygen generated documentation. The file <install-directory>/share/indri/IndriQueryLanguage.html provides a more complete description of the indri query language.

If configured with --enable-java, documentation for the Indri JNI will be installed in <install-directory>/share/indri/JNIdoc. The file index.html points into the javadoc generated documentation.

If configured with --enable-java, the shared library will be installed in <install-directory>/lib/libindri_jni.so and the java class files will be installed in <install-directory>/share/indri/indri.jar. You will need to add <install-directory>/lib to your LD_LIBRARY_PATH and add <install-directory>/share/indri/indri.jar to your CLASSPATH to use the JNI interface to indri.

Two additional jar files are installed. RetUI.jar provides a basic document retrieval GUI for interactive queries. IndexUI.jar provides a basic collection indexing GUI for building an indri repository. Both are installed in <install-directory>/share/indri and can be run with

java -jar <jarfilename>

If configured with --enable-php, the shared library will be installed in <install-directory>/lib/libindri_php.so. You will need to manually install it in the correct extensions directory for your php configuration.

If configured with --enable-csharp, the shared library will be installed in <install-directory>/lib/libindri_csharp.so. The C# wrapper classes assembly will be installed in <install-directory>/lib/IndriCsharp.dll This assembly should be referenced by your C# program.

Programming with the indri library

To build an application using the indri library:

1. follow the instructions above for installing indri.
2. Copy <install-directory>/share/indri/Makefile.app to the directory with your application's source code. Edit the file and fill in values for
   • APP -- name for your application. Source should be in .cpp
   • OBJ -- list of additional object files needed to build your application.
3. use make -f Makefile.app to build your application.

---