Open Source Projects Europe

                        4.1. Installing a prebuilt copy

                        4.1. Installing a prebuilt copy

   Recoll binary installations are always linked statically to the xapian

   Recoll binary installations are always linked statically to the xapian

   libraries, and have no other dependencies. You will only have to check or

   libraries, and have no other dependencies. You will only have to check or

   install supporting applications for the file types that you want to index

   install supporting applications for the file types that you want to index

4.1.1. Installing through a package system

4.1.1. Installing through a package system

   If you use a BSD-type port system or a prebuilt package (RPM or other),

   If you use a BSD-type port system or a prebuilt package (RPM or other),

   just follow the usual procedure, and maybe have a look at the

   just follow the usual procedure, and maybe have a look at the

   Finally, you may want to have a look at the configuration section.

   Finally, you may want to have a look at the configuration section.

   --------------------------------------------------------------------------

   --------------------------------------------------------------------------

   Prev                             Home                                 Next 

   Prev                             Home                                 Next 

                                                                        types 

                                                                        types 

   Link: HOME

   Link: HOME

   Link: UP

   Link: UP

   Link: PREVIOUS

   Link: PREVIOUS

   Link: NEXT

   Link: NEXT

     * dvi: dvips

     * dvi: dvips

     * djvu: DjVuLibre

     * djvu: DjVuLibre

     * MP3: Recoll will use the id3info command from the id3lib package to

     * MP3: Recoll will use the id3info command from the id3lib package to

       extract tag information. Without it, only the filenames will be

       indexed.

       indexed.

   --------------------------------------------------------------------------

   --------------------------------------------------------------------------

   Prev                               Home                               Next 

   Prev                               Home                               Next 

   Installation                        Up                Building from source 

   Installation                        Up                Building from source 

4.3.1. Prerequisites

4.3.1. Prerequisites

   At the very least, you will need to download and install the xapian core

   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

   package (Recoll development currently uses version 0.9.5), and the qt

   runtime and development packages (Recoll development currently uses

   You will most probably be able to find a binary package for qt for your

   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

   system. You may have to compile Xapian but this is not difficult (if you

   are using FreeBSD, there is a port).

   are using FreeBSD, there is a port).

     * QTDIR should point to the directory above the one that holds the qt

     * QTDIR should point to the directory above the one that holds the qt

       include files (ie: qt.h).

       include files (ie: qt.h).

     * QMAKESPECS should be set to the name of one of the qt mkspecs

     * 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

   On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS

   is not needed because there is a default link in mkspecs/.

   is not needed because there is a default link in mkspecs/.

   The Recoll configure script does a better job of checking these variables

   The Recoll configure script does a better job of checking these variables

   Normal procedure:

   Normal procedure:

         cd recoll-xxx

         cd recoll-xxx

         configure

         configure

         make

         make

   There little autoconfiguration. The configure script will mainly link one

   of the system-specific files in the mk directory to mk/sysconf. If your

   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

   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

   manually copy and modify one of the existing files (the new file name

   should be the output of uname -s).

   should be the output of uname -s).

   edit them by hand for now (there is still some hope for a GUI

   edit them by hand for now (there is still some hope for a GUI

   configuration tool in the future). The most accurate documentation for the

   configuration tool in the future). The most accurate documentation for the

   configuration parameters is given by comments inside the default files,

   configuration parameters is given by comments inside the default files,

   and we will just give a general overview here.

   and we will just give a general overview here.

   extract of the main configuration file might look as follows:

   extract of the main configuration file might look as follows:

         # Space-separated list of directories to index.

         # Space-separated list of directories to index.

         topdirs =  ~/docs /usr/share/doc

         topdirs =  ~/docs /usr/share/doc

     * Parameter affectation (name = value).

     * Parameter affectation (name = value).

     * Section definition ([somedirname]).

     * Section definition ([somedirname]).

   Section lines allow redefining some parameters for a directory subtree.

   Some of the parameters used for indexing are looked up hierarchically from

   Some of the parameters used for indexing are looked up hierarchically from

   the more to the less specific. Not all parameters can be meaningfully

   the more to the less specific. Not all parameters can be meaningfully

   redefined, this is specified for each in the next section.

   redefined, this is specified for each in the next section.

   The tilde character (~) is expanded in file names to the name of the

   The tilde character (~) is expanded in file names to the name of the

           directories that should be completely ignored. The list defined in

           directories that should be completely ignored. The list defined in

           the default file is:

           the default file is:

 *~ #* bin CVS  Cache caughtspam  tmp

 *~ #* bin CVS  Cache caughtspam  tmp

           changed for the top level ones in topdirs.

           The top-level directories are not affected by this list (that is,

           The top-level directories are not affected by this list (that is,

           a directory in topdirs might match and would still be indexed).

           a directory in topdirs might match and would still be indexed).

           The list in the default configuration does not exclude hidden

           The list in the default configuration does not exclude hidden

   filtersdir

   filtersdir

           A directory to search for the external filter scripts used to

           A directory to search for the external filter scripts used to

           index some types of files. The value should not be changed, except

           index some types of files. The value should not be changed, except

           if you want to modify one of the default scripts. The value can be

           if you want to modify one of the default scripts. The value can be

           redefined for any subdirectory.

   indexstemminglanguages

   indexstemminglanguages

           A list of languages for which the stem expansion databases will be

           A list of languages for which the stem expansion databases will be

           built. See recollindex(1) for possible values. You can add a stem

           built. See recollindex(1) for possible values. You can add a stem

   defaultcharset

   defaultcharset

           The name of the character set used for files that do not contain a

           The name of the character set used for files that do not contain a

           character set definition (ie: plain text files). This can be

           character set definition (ie: plain text files). This can be

           redefined for any subdirectory. If it is not set at all, the

           character set used is the one defined by the nls environment

           character set used is the one defined by the nls environment

           (LC_ALL, LC_CTYPE, LANG), or iso8859-1 if nothing is set.

           (LC_ALL, LC_CTYPE, LANG), or iso8859-1 if nothing is set.

   guesscharset

   guesscharset

   usesystemfilecommand

   usesystemfilecommand

           Decide if we use the file -i system command as a final step for

           Decide if we use the file -i system command as a final step for

           determining the mime type for a file (the main procedure uses

           determining the mime type for a file (the main procedure uses

           suffix associations as defined in the mimemap file). This can be

           suffix associations as defined in the mimemap file). This can be

           indexing of many bogus "text" files.

   indexallfilenames

   indexallfilenames

           Recoll indexes file names in a special section of the database to

           Recoll indexes file names in a special section of the database to

           allow specific file names searches using wild cards. This

           allow specific file names searches using wild cards. This

           parameter decides if file name indexing is performed only for

           parameter decides if file name indexing is performed only for

           files with mime types that would qualify them for full text

           files with mime types that would qualify them for full text

           indexing, or for all files inside the selected subtrees,

           indexing, or for all files inside the selected subtrees,

   idxabsmlen

   idxabsmlen

           Recoll stores an abstract for each indexed file inside the

           Recoll stores an abstract for each indexed file inside the

           database. This is so that they can be displayed inside the result

           database. This is so that they can be displayed inside the result

   mimemap also has a recoll_noindex variable which is a list of suffixes.

   mimemap also has a recoll_noindex variable which is a list of suffixes.

   Matching files will be skipped (avoids unnecessary decompressions or file

   Matching files will be skipped (avoids unnecessary decompressions or file

   executions). This is partially redundant with skippedNames in the main

   executions). This is partially redundant with skippedNames in the main

   configuration file, with two differences: it will not affect directories,

   configuration file, with two differences: it will not affect directories,

   and it can be changed for any subdirectory.

4.4.3. The mimeconf file

4.4.3. The mimeconf file

   mimeconf specifies how the different mime types are handled for indexing,

   mimeconf specifies how the different mime types are handled for indexing,

   and for display.

   and for display.

   Changing the indexing parameters is probably not a good idea except if you

   Changing the indexing parameters is probably not a good idea except if you

   previewed internally or displayed using firefox, but you may prefer

   previewed internally or displayed using firefox, but you may prefer

   mozilla, your openoffice.org program might be named oofice instead of

   mozilla, your openoffice.org program might be named oofice instead of

   openoffice ...). Look for the [view] section.

   openoffice ...). Look for the [view] section.

   You can also change the icons which are displayed by recoll in the result

   You can also change the icons which are displayed by recoll in the result