Switch to unified view

a/src/INSTALL b/src/INSTALL
...
...
37
37
38
    Building
38
    Building
39
39
40
   Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
40
   Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
41
   Solaris 8. If you build on another system, I would very much welcome
41
   Solaris 8. If you build on another system, I would very much welcome
42
   comments and patches.
42
   patches.
43
43
44
   Normal procedure:
44
   Normal procedure:
45
45
46
     * cd recoll-xxx
46
     * cd recoll-xxx
47
     * configure
47
     * configure
48
     * make
48
     * make
49
     * (practise your usual hardship-repelling invocations).
49
     * (practise your usual hardship-repelling invocations).
50
50
51
   There is no real autoconfiguration. The configure script will just link
51
   There little autoconfiguration. The configure script will mainly link one
52
   one of the system-specific files in the mk directory to mk/sysconf. If
52
   of the system-specific files in the mk directory to mk/sysconf. If your
53
   your system is known yet, it will tell you as much, and you may want to
53
   system is not known yet, it will tell you as much, and you may want to
54
   manually copy and modify one of the existing files (the new file name
54
   manually copy and modify one of the existing files (the new file name
55
   should be the output of uname -s).
55
   should be the output of uname -s).
56
57
   You may also need to adjust the recoll.pro file inside the qtgui directory
58
   to fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where
59
   your libs are installed. Then run 'qmake recoll.pro' in there.
60
56
61
  Using binary packages
57
  Using binary packages
62
58
63
   The binary versions are just compressed tar files of a build tree, where
59
   The binary versions are just compressed tar files of a build tree, where
64
   only the useful parts were kept (executables and sample configuration).
60
   only the useful parts were kept (executables and sample configuration).
...
...
75
71
76
    Commands and common files
72
    Commands and common files
77
73
78
   Either type make install or execute recollinstall targetdir, in the root
74
   Either type make install or execute recollinstall targetdir, in the root
79
   of the source tree. This will copy the commands to $targetdir/bin and the
75
   of the source tree. This will copy the commands to $targetdir/bin and the
80
   sample configuration files to $targetdir/share/examples/recoll
76
   sample configuration files, scripts and other shared data to
77
   $targetdir/share/recoll
81
78
82
    Personal configuration
79
    Personal configuration
83
80
84
   Either type make installme in the root of the source tree, or execute
81
   The personal configuration files and the database are kept in the .recoll
85
   recollinstall. This will copy the configuration files to the .recoll
82
   directory in your home. If this directory does not exist when recoll or
86
   directory in your home.
83
   recollindex are started, the directory will be created and the sample
84
   configuration files will be copied. recoll will give you a chance to edit
85
   the configuration file before starting indexation. recollindex will
86
   proceed immediately.
87
87
88
  Configuration
88
  Configuration
89
89
90
   Recoll uses text configuration files. You will have to edit them by hand
90
   Recoll uses text configuration files. You will have to edit them by hand
91
   for now (all hope is not lost that there will be dialogs to build them
91
   for now (there is still some hope for a GUI configuration tool in the
92
   from the GUI in the future).
92
   future).
93
93
94
   The main configuration file is named ~/.recoll/recoll.conf.
94
   The main configuration file is named ~/.recoll/recoll.conf.
95
95
96
   A commented sample was copied to ~/.recoll by the installation. By
96
   The default configuration will index your home directory. If this is not
97
   default, it will index your home directory.
97
   appropriate, use recoll to copy the sample configuration, click Cancel,
98
   and edit the configuration file before restarting the command. This will
99
   start the initial indexation, which may take some time.
98
100
99
   Then start recollindex, and wait for indexing to complete (this may take
101
   You are then ready to try a query, see the user manual for more detail.
100
   some time). When it's done, you can start recoll and try a search. See the
101
   user manual for a little more details
102
102
103
   Depending on what is installed on your system, you may also want to adjust
103
   Depending on what is installed on your system, you may also want to adjust
104
   the external viewers defined in ~/.recoll/mimeconf (ie: html is either
104
   the external viewers defined in ~/.recoll/mimeconf (ie: html is either
105
   previewed internally or displayed using firefox, but you may prefer
105
   previewed internally or displayed using firefox, but you may prefer
106
   mozilla...). Look for the [view] section.
106
   mozilla...). Look for the [view] section.