diff --git a/src/INSTALL b/src/INSTALL index f6c0b8cf..66cc2c0c 100644 --- a/src/INSTALL +++ b/src/INSTALL @@ -17,9 +17,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or 4.1. Installing a prebuilt copy - 4.2. Building from source + 4.2. Packages needed for external file types - 4.3. Packages needed for external file types + 4.3. Building from source 4.4. Configuration overview @@ -48,11 +48,139 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or also means that you cannot change the versions which are used. After extracting the tar file, you can proceed with installation as if you - had built the package from source. + had built the package from source (that is, just type make install). The + binary trees are built for installation to /usr/local. - The binary trees are built for installation to /usr/local. + You may then need to install external applications to process some file + types that you want indexed (ie: acrobat, postscript ...). See next + section. + + Finally, you may want to have a look at the configuration section. -------------------------------------------------------------------------- - Prev Home Next - Customising the search interface Building from source + Prev Home Next + Customising the search interface Packages needed for external file + types + Link: HOME + Link: UP + Link: PREVIOUS + Link: NEXT + + Recoll user manual + Prev Chapter 4. Installation Next + + -------------------------------------------------------------------------- + + 4.2. Packages needed for external file types + + Recoll uses external applications to index some file types. You need to + install them for the file types that you wish to have indexed (these are + run-time dependencies. None is needed for building Recoll): + + * PDF: pdftotext is part of the Xpdf package. + + * Postscript: pstotext. + + * MS Word: antiword. + + * MS Excel and PowerPoint: catdoc. + + * RTF: unrtf + + * dvi: dvips + + * djvu: DjVuLibre + + * MP3: Recoll will use the id3info command from the id3lib package to + extract tag information. Without it, only the filenames will be + indexed. + + Text, Html, mail folders and Openoffice files are processed internally. + + -------------------------------------------------------------------------- + + Prev Home Next + Installation Up Building from source + Link: HOME + Link: UP + Link: PREVIOUS + Link: NEXT + + Recoll user manual + Prev Chapter 4. Installation Next + + -------------------------------------------------------------------------- + + 4.3. Building from source + +4.3.1. Prerequisites + + At the very least, you will need to download and install the xapian core + package (Recoll development currently uses version 0.9.5), and the qt + runtime and development packages (Recoll development currently uses + version 3.3.5, but any 3.3 version is probably ok). + + You will most probably be able to find a binary package for qt for your + system. You may have to compile Xapian but this is not difficult (if you + are using FreeBSD, there is a port). + + You may also need libiconv. Recoll currently uses version 1.9 (this should + not be critical). On Linux systems, the iconv interface is part of libc + and you should not need to do anything special. + +4.3.2. Building + + Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3), + FreeBSD and Solaris 8. If you build on another system, I would very much + welcome patches. + + Depending on the qt configuration on your system, you may have to set the + QTDIR and QMAKESPECS variables in your environment: + + * QTDIR should point to the directory above the one that holds the qt + include files (ie: qt.h). + + * QMAKESPECS should be set to the name of one of the qt mkspecs + subdirectories (ie: linux-g++). + + On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS + is not needed because there is a default link in mkspecs/. + + The Recoll configure script does a better job of checking these variables + after release 1.1.1. Before this, unexplained errors will occur during + compilation if the environment is not set up. Also, for 1.1.0 the qmake + command should be in your PATH (later releases can also find it in + $QTDIR/bin). + + Normal procedure: + + cd recoll-xxx + configure + make + (practises usual hardship-repelling invocations) + + + There little autoconfiguration. The configure script will mainly link one + of the system-specific files in the mk directory to mk/sysconf. If your + system is not known yet, it will tell you as much, and you may want to + manually copy and modify one of the existing files (the new file name + should be the output of uname -s). + +4.3.3. Installation + + Either type make install or execute recollinstall prefix, in the root of + the source tree. This will copy the commands to prefix/bin and the sample + configuration files, scripts and other shared data to prefix/share/recoll. + + If the installation prefix given to recollinstall is different from what + was specified when executing configure, you will have to set the + RECOLL_DATADIR environment variable to indicate where the shared data is + to be found. + + You can then proceed to configuration. + + -------------------------------------------------------------------------- + + Prev Home Next + Packages needed for external file types Up Configuration overview diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 3cff2b5c..bfe85249 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.18 2006-09-23 13:09:09 dockes Exp $ + $Id: usermanual.sgml,v 1.19 2006-09-23 13:11:17 dockes Exp $ This document introduces full text search notions @@ -928,6 +928,7 @@ linkend="rcl.indexing.config">configuration section. + Packages needed for external file types @@ -987,7 +988,7 @@ processed internally. - + Building from source