Switch to unified view

a/src/INSTALL b/src/INSTALL
...
...
13
13
14
                            Chapter 4. Installation
14
                            Chapter 4. Installation
15
15
16
   Table of Contents
16
   Table of Contents
17
17
18
   4.1. Building from source
18
   4.1. Installing a prebuilt copy
19
19
20
   4.2. Installing a prebuilt copy
20
   4.2. Building from source
21
21
22
   4.3. Packages needed for external file types
22
   4.3. Packages needed for external file types
23
23
24
   4.4. Configuration overview
24
   4.4. Configuration overview
25
25
26
                           4.1. Building from source
26
                        4.1. Installing a prebuilt copy
27
27
28
4.1.1. Prerequisites
28
   Recoll binary installations are always linked statically to the xapian
29
   libraries, and have no other dependencies. You will only have to check or
30
   install supporting applications for the file types that you want to index
31
   beyond text, html and mail files.
29
32
30
   At the very least, you will need to download and install the xapian core
33
4.1.1. Installing through a package system
31
   package (Recoll development currently uses version 0.9.5), and the qt
32
   runtime and development packages (Recoll development currently uses
33
   version 3.3.5, but any 3.3 version is probably ok).
34
34
35
   You will most probably be able to find a binary package for qt for your
35
   If you use a BSD-type port system or a prebuilt package (RPM or other),
36
   system. You may have to compile Xapian but this is not difficult (if you
36
   just follow the usual procedure, and maybe have a look at the
37
   are using FreeBSD, there is a port).
37
   configuration section (but this may not be necessary for a quick test with
38
   default parameters).
38
39
39
   You may also need libiconv. Recoll currently uses version 1.9 (this should
40
4.1.2. Installing a prebuilt Recoll
40
   not be critical). On Linux systems, the iconv interface is part of libc
41
   and you should not need to do anything special.
42
41
43
4.1.2. Building
42
   The unpackaged binary versions are just compressed tar files of a build
43
   tree, where only the useful parts were kept (executables and sample
44
   configuration).
44
45
45
   Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3),
46
   The executable binary files are built with a static link to libxapian and
46
   FreeBSD and Solaris 8. If you build on another system, I would very much
47
   libiconv, to make installation easier (no dependencies). However, this
47
   welcome patches.
48
   also means that you cannot change the versions which are used.
48
49
49
   Depending on the qt configuration on your system, you may have to set the
50
   After extracting the tar file, you can proceed with installation as if you
50
   QTDIR and QMAKESPECS variables in your environment:
51
   had built the package from source.
51
52
52
     * QTDIR should point to the directory above the one that holds the qt
53
   The binary trees are built for installation to /usr/local.
53
       include files (ie: qt.h).
54
55
     * QMAKESPECS should be set to the name of one of the qt mkspecs
56
       subdirectories (ie: linux-g++).
57
58
   On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS
59
   is not needed because there is a default link in mkspecs/.
60
61
   The Recoll configure script does a better job of checking these variables
62
   after release 1.1.1. Before this, unexplained errors will occur during
63
   compilation if the environment is not set up. Also, for 1.1.0 the qmake
64
   command should be in your PATH (later releases can also find it in
65
   $QTDIR/bin).
66
67
   Normal procedure:
68
69
         cd recoll-xxx
70
         configure
71
         make
72
         (practises usual hardship-repelling invocations)
73
     
74
75
   There little autoconfiguration. The configure script will mainly link one
76
   of the system-specific files in the mk directory to mk/sysconf. If your
77
   system is not known yet, it will tell you as much, and you may want to
78
   manually copy and modify one of the existing files (the new file name
79
   should be the output of uname -s).
80
81
4.1.3. Installation
82
83
   Either type make install or execute recollinstall prefix, in the root of
84
   the source tree. This will copy the commands to prefix/bin and the sample
85
   configuration files, scripts and other shared data to prefix/share/recoll.
86
87
   You can then proceed to configuration.
88
54
89
   --------------------------------------------------------------------------
55
   --------------------------------------------------------------------------
90
56
91
   Prev                                  Home                            Next 
57
   Prev                                   Home                           Next 
92
   Customising the search interface                Installing a prebuilt copy 
58
   Customising the search interface                      Building from source