Indri Documentation

5.6

Installation

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
  3. use make -f Makefile.app to build your application.

Generated on Thu Dec 12 18:10:48 2013 for Indri by  doxygen 1.4.7