tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
dockes
2008-10-13 08:35:34 +00:00
parent 34cd8293ac
commit d910d2bebe
2 changed files with 575 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/INSTALL
+37 -34
View File
@@ -11,23 +11,21 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
--------------------------------------------------------------------------
Chapter 4. Installation
Chapter 5. Installation
Table of Contents
4.1. Installing a prebuilt copy
5.1. Installing a prebuilt copy
4.2. Supporting packages
5.2. Supporting packages
4.3. Building from source
5.3. Building from source
4.4. Configuration overview
5.4. Configuration overview
4.5. The KDE Kicker Recoll applet
5.5. The KDE Kicker Recoll applet
4.6. Extending Recoll
4.1. Installing a prebuilt copy
5.1. Installing a prebuilt copy
Recoll binary packages from the Recoll web site are always linked
statically to the Xapian libraries, and have no other dependencies. You
@@ -36,12 +34,12 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
have a look at the configuration section (but this may not be necessary
for a quick test with default parameters).
4.1.1. Installing through a package system
5.1.1. Installing through a package system
If you use a BSD-type port system or a prebuilt package (RPM or other),
just follow the usual procedure for your system.
4.1.2. Installing a prebuilt Recoll
5.1.2. Installing a prebuilt Recoll
The unpackaged binary versions on the Recoll web site are just compressed
tar files of a build tree, where only the useful parts were kept
@@ -56,23 +54,29 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
--------------------------------------------------------------------------
Prev Home Next
Customizing the search interface Supporting packages
Prev Home Next
API Supporting packages
Link: HOME
Link: UP
Link: PREVIOUS
Link: NEXT
Recoll user manual
Prev Chapter 4. Installation Next
Prev Chapter 5. Installation Next
--------------------------------------------------------------------------
4.2. Supporting packages
5.2. Supporting packages
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):
run-time dependencies. None is needed for building Recoll).
After an indexing pass, the commands that were found missing can be
displayed from the recoll File menu. The list is stored in the missing
text file inside the configuration directory.
A list of common file types which need external commands:
* Openoffice: supported natively, but needs the unzip command to be
installed.
@@ -118,13 +122,13 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Link: NEXT
Recoll user manual
Prev Chapter 4. Installation Next
Prev Chapter 5. Installation Next
--------------------------------------------------------------------------
4.3. Building from source
5.3. Building from source
4.3.1. Prerequisites
5.3.1. Prerequisites
At the very least, you will need to download and install the xapian core
package (Recoll 1.9 normally uses version 1.0.2, but any 0.9 or 1.0.x
@@ -140,7 +144,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
5.3.2. Building
Recoll has been built on Linux (redhat7.3, mandriva 2005/6, Fedora Core
3/4/5/6), FreeBSD 5/6, macosx, and Solaris 8. If you build on another
@@ -178,7 +182,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
manually copy and modify one of the existing files (the new file name
should be the output of uname -s).
4.3.3. Installation
5.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
@@ -201,11 +205,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Link: NEXT
Recoll user manual
Prev Chapter 4. Installation Next
Prev Chapter 5. Installation Next
--------------------------------------------------------------------------
4.4. Configuration overview
5.4. Configuration overview
Most of the parameters specific to the recoll GUI are set through the
Preferences menu and stored in the standard QT place ($HOME/.qt/recollrc).
@@ -263,7 +267,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
White space is used for separation inside lists. List elements with
embedded spaces can be quoted using double-quotes.
4.4.1. Main configuration file
5.4.1. Main configuration file
recoll.conf is the main configuration file. It defines things like what to
index (top directories and things to ignore), and the default character
@@ -467,7 +471,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
cases. A value of 3 would allow more precision and efficiency on
longer words, but the index will be approximately twice as large.
4.4.2. The mimemap file
5.4.2. The mimemap file
mimemap specifies the file name extension to mime type mappings.
@@ -491,7 +495,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
there avoids cluttering the more user-oriented and locally customized
skippedNames.
4.4.3. The mimeconf file
5.4.3. The mimeconf file
mimeconf specifies how the different mime types are handled for indexing,
and which icons are displayed in the recoll result lists.
@@ -503,7 +507,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
recoll in the result lists (the values are the basenames of the png images
inside the iconsdir directory (specified in recoll.conf).
4.4.4. The mimeview file
5.4.4. The mimeview file
mimeview specifies which programs are started when you click on an Edit
link in a result list. Ie: HTML is normally displayed using firefox, but
@@ -524,9 +528,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
user preferences, all mimeview entries will be ignored except the one
labelled application/x-all (which is set to use xdg-open by default).
4.4.5. Examples of configuration adjustments
5.4.5. Examples of configuration adjustments
4.4.5.1. Adding an external viewer for an non-indexed type
5.4.5.1. Adding an external viewer for an non-indexed type
Imagine that you have some kind of file which does not have indexable
content, but for which you would like to have a functional Edit link in
@@ -557,7 +561,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
The entries you add in your personal file override those in the central
configuration, which you do not need to alter
4.4.5.2. Adding indexing support for a new file type
5.4.5.2. Adding indexing support for a new file type
Let us now imagine that the above .blob files actually contain indexable
text and that you know how to extract it with a command line program.
@@ -581,11 +585,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
The rclblob filter should be an executable program or script which exists
inside /usr/[local/]share/recoll/filters. It will be given a file name as
argument and should output the text contents in html format on the
standard output.
argument and should output the text contents on the standard output.
You can find more details about writing a Recoll filter in the section
about writing filters
The filter programming section describes in more detail how to write a
filter.
--------------------------------------------------------------------------