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 2006-09-15 12:36:27 +00:00
parent 581ea87b48
commit 5e82897242
2 changed files with 351 additions and 224 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
src/INSTALL
View File

@ -15,78 +15,44 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Table of Contents Table of Contents
4.1. Building from source 4.1. Installing a prebuilt copy
4.2. Installing a prebuilt copy 4.2. Building from source
4.3. Packages needed for external file types 4.3. Packages needed for external file types
4.4. Configuration overview 4.4. Configuration overview
4.1. Building from source 4.1. Installing a prebuilt copy
4.1.1. Prerequisites Recoll binary installations are always linked statically to the xapian
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
beyond text, html and mail files.
At the very least, you will need to download and install the xapian core 4.1.1. Installing through a package system
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 If you use a BSD-type port system or a prebuilt package (RPM or other),
system. You may have to compile Xapian but this is not difficult (if you just follow the usual procedure, and maybe have a look at the
are using FreeBSD, there is a port). configuration section (but this may not be necessary for a quick test with
default parameters).
You may also need libiconv. Recoll currently uses version 1.9 (this should 4.1.2. Installing a prebuilt Recoll
not be critical). On Linux systems, the iconv interface is part of libc
and you should not need to do anything special.
4.1.2. Building The unpackaged binary versions are just compressed tar files of a build
tree, where only the useful parts were kept (executables and sample
configuration).
Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3), The executable binary files are built with a static link to libxapian and
FreeBSD and Solaris 8. If you build on another system, I would very much libiconv, to make installation easier (no dependencies). However, this
welcome patches. also means that you cannot change the versions which are used.
Depending on the qt configuration on your system, you may have to set the After extracting the tar file, you can proceed with installation as if you
QTDIR and QMAKESPECS variables in your environment: had built the package from source.
* QTDIR should point to the directory above the one that holds the qt The binary trees are built for installation to /usr/local.
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.1.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.
You can then proceed to configuration.
-------------------------------------------------------------------------- --------------------------------------------------------------------------
Prev Home Next Prev Home Next
Customising the search interface Installing a prebuilt copy Customising the search interface Building from source

493
src/README
View File

@ -45,35 +45,39 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
3.1. Simple search 3.1. Simple search
3.2. Complex/advanced search 3.2. The result list
3.3. Multiple databases 3.2.1. The result list right-click menu
3.4. Document history 3.3. The preview window
3.5. Result list sorting 3.4. Complex/advanced search
3.6. Additional result list functionality 3.5. Multiple databases
3.7. Search tips, shortcuts 3.6. Document history
3.8. Customising the search interface 3.7. Sorting search results
3.8. Search tips, shortcuts
3.9. Customising the search interface
4. Installation 4. Installation
4.1. Building from source 4.1. Installing a prebuilt copy
4.1.1. Prerequisites 4.1.1. Installing through a package system
4.1.2. Building 4.1.2. Installing a prebuilt Recoll
4.1.3. Installation 4.2. Building from source
4.2. Installing a prebuilt copy 4.2.1. Prerequisites
4.2.1. Installing through a package system 4.2.2. Building
4.2.2. Installing a prebuilt Recoll 4.2.3. Installation
4.3. Packages needed for external file types 4.3. Packages needed for external file types
@ -93,14 +97,15 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
If you do not like reading manuals (who does?) and would like to give If you do not like reading manuals (who does?) and would like to give
Recoll a try, just perform installation and start the recoll user Recoll a try, just perform installation and start the recoll user
interface, which will index your home directory and let you search it interface, which will index your home directory by default, allowing you
right after. to search immediately after indexing completes.
Do not do this if your home has a huge number of documents and you do not Do not do this if your home directory contains a huge number of documents
want to wait or are very short on disk space. In this case, you may want and you do not want to wait or are very short on disk space. In this case,
to edit the configuration file first to restrict the indexed area. you may want to edit the configuration file first to restrict the indexed
area.
Also be aware that you will need to install the appropriate supporting Also be aware that you may need to install the appropriate supporting
applications for document types that need them (for example antiword for applications for document types that need them (for example antiword for
ms-word files). ms-word files).
@ -117,15 +122,15 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
You do not need to remember in what file or email message you stored a You do not need to remember in what file or email message you stored a
given piece of information. You just ask for related terms, and the tool given piece of information. You just ask for related terms, and the tool
will return a list of documents where those terms are prominent. will return a list of documents where those terms are prominent, in a
similar way to internet search engines.
This mode of operation has been made very familiar by internet search Recoll tries to determine which documents are most relevant to the search
engines. terms you provide. Computer algorithms for determining relevance can be
very complex, and in general are inferior to the power of the human mind
The notion of relevance is a difficult one, as only you, the user, to rapidly determine relevance. The quality of relevance guessing by the
actually know which documents are relevant to your search, and the search tool is probably the most important element for a search
application can only try a guess. The quality of this guess is probably application.
the most important element for a search application.
In many cases, you are looking for all the forms of a word, not for a In many cases, you are looking for all the forms of a word, not for a
specific form or spelling. These different forms may include plurals, specific form or spelling. These different forms may include plurals,
@ -134,8 +139,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
expand queries to all such related terms (words that reduce to the same expand queries to all such related terms (words that reduce to the same
stem). This expansion can be disabled at search time. stem). This expansion can be disabled at search time.
Stemming, by itself, does not provide for misspellings or phonetic Stemming, by itself, does not accomodate for misspellings or phonetic
searches. Recoll currently does not support these. searches. Recoll currently does not support these features.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -202,12 +207,12 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
have a nightly indexing run programmed into your cron file. have a nightly indexing run programmed into your cron file.
+------------------------------------------------------------------------+ +------------------------------------------------------------------------+
| Side note: there is nothing in Recoll and Xapian that would prevent | | There is nothing in Recoll and Xapian that would prevent interfacing |
| interfacing with a real time file modification monitor, but this would | | with a real time file modification monitor, but this would tend to |
| tend to consume significant system resources for dubious gain, because | | consume significant system resources for dubious gain, because you |
| you rarely need a full text search to find documents you just | | rarely need a full text search to find documents you just modified. |
| modified. recollindex -i can be used to add individual files to the | | recollindex -i can be used to add individual files to the index if you |
| index if you want to play with this, see the manual page. | | want to play with this, see the manual page. |
+------------------------------------------------------------------------+ +------------------------------------------------------------------------+
Recoll knows about quite a few different document types. The parameters Recoll knows about quite a few different document types. The parameters
@ -223,6 +228,14 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Without further configuration, Recoll will index all appropriate files Without further configuration, Recoll will index all appropriate files
from your home directory, with a reasonable set of defaults. from your home directory, with a reasonable set of defaults.
In some cases, it may be interesting to index different areas of the file
system to separate databases. You can do this by using multiple
configuration directories, each indexing a file system area to a specific
database. You would use the RECOLL_CONFDIR environment variable or the -c
confdir option to recollindex to indicate which configuration to process.
The recoll search program can use any selection of the existing databases
for each search, this is configurable inside the user interface.
---------------------------------------------------------------------- ----------------------------------------------------------------------
2.2. Index storage 2.2. Index storage
@ -244,8 +257,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
means that it will be quite typical nowadays (2006), that even a big index means that it will be quite typical nowadays (2006), that even a big index
will be negligible against the total amount of data on the computer. will be negligible against the total amount of data on the computer.
The index data directory only contains data that will be rebuilt by an The index data directory (xapiandb) only contains data that will be
index run, so that it can be destroyed safely. rebuilt by an index run, and it can always be destroyed safely.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -257,12 +270,13 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
restricted. restricted.
As of version 1.4, Recoll will create the configuration directory with a As of version 1.4, Recoll will create the configuration directory with a
mode of 0700 (access by owner only). As the index directory is by default mode of 0700 (access by owner only). As the index data directory is by
a subdirectory of the configuration directory, this should result in default a subdirectory of the configuration directory, this should result
appropriate protection. in appropriate protection.
If you use another setup, you should think of the kind of protection you If you use another setup, you should think of the kind of protection you
need for your index, and set the directory access modes appropriately. need for your index, and set the directory and files access modes
appropriately.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -282,23 +296,28 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
The configuration is also documented inside the installation chapter of The configuration is also documented inside the installation chapter of
this document, or in the recoll.conf(5) man page. this document, or in the recoll.conf(5) man page.
The applications needed to index file types other than text, html or email
(ie: pdf, postscript, ms-word...) are described in the external packages
section
---------------------------------------------------------------------- ----------------------------------------------------------------------
2.4. Starting indexing 2.4. Starting indexing
Indexing is performed either by the recollindex program, or by the Indexing is performed either by the recollindex program, or by the
indexing thread inside the recoll program (use the File menu). indexing thread inside the recoll program (use the File menu). Both
programs will use of the RECOLL_CONFDIR variable or accept a -c confdir
option to specify the configuration directory to be used.
If the recoll program finds no index when it starts, it will automatically If the recoll program finds no index when it starts, it will automatically
start indexing (except if cancelled). start indexing (except if cancelled).
It is best to avoid interrupting the indexing process, as this may It is best to avoid interrupting the indexing process, as this may
sometimes leave the database in a bad state. This is not a serious sometimes leave the index in a bad state. This is not a serious problem,
problem, as you then just need to clear everything and restart the as you then just need to clear everything and restart the indexing: the
indexing: the index files are normally stored in the index files are normally stored in the $HOME/.recoll/xapiandb directory,
$HOME/.recoll/xapiandb directory, which you can just delete if needed. which you can just delete if needed. Alternatively, you can start
Alternatively, you can start recollindex -z, which will reset the database recollindex with option -z, which will reset the database before indexing.
before indexing.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -339,23 +358,45 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
be returned. File name will specifically look for file names, and allows be returned. File name will specifically look for file names, and allows
using wildcards (*, ? , []). using wildcards (*, ? , []).
You can search for exact phrases (adjacent words in a given order) by
enclosing the input inside double quotes. Ex: "virtual reality".
Character case has no influence on search, except that you can disable
stem expansion for any term by capitalizing it. Ie: a search for floor
will also normally look for flooring, floored, etc., but a search for
Floor will only look for floor, in any character case (stemming can also
be disabled globally in the preferences).
Recoll remembers the last few searches that you performed. You can use the Recoll remembers the last few searches that you performed. You can use the
simple search text entry widget (a combobox) to recall them (click on the simple search text entry widget (a combobox) to recall them (click on the
thing at the right of the text field). Please note, however, that only the thing at the right of the text field). Please note, however, that only the
search texts are remembered, not the mode (all/any/filename). search texts are remembered, not the mode (all/any/filename).
Hitting ^Tab (Ctrl + Tab) while entering a word in the simple search entry
will open a window with possible completions for the word. The completions
are extracted from the database.
Double-clicking on a word in the result list or a preview window will
insert it into the simple search entry field.
You can use the Tools / Advanced search dialog for more complex searches. You can use the Tools / Advanced search dialog for more complex searches.
----------------------------------------------------------------------
3.2. The result list
After starting a search, a list of results will instantly be displayed in After starting a search, a list of results will instantly be displayed in
the main list window. Clicking on the Preview link for an entry will open the main list window.
an internal preview window for the document. Clicking the Edit link will
attempt to start an external viewer (have a look at the mimeconf
configuration file to see how these are configured).
By default, the document list is presented in order of relevance (how well By default, the document list is presented in order of relevance (how well
the system estimates that the document matches the query). You can specify the system estimates that the document matches the query). You can specify
a different ordering by using the Tools / Sort parameters dialog. a different ordering by using the Tools / Sort parameters dialog.
Clicking on the Preview link for an entry will open an internal preview
window for the document. Clicking the Edit link will attempt to start an
external viewer (have a look at the mimeconf configuration file to see how
these are configured).
The Preview and Edit edit links may not be present for all entries, The Preview and Edit edit links may not be present for all entries,
meaning that Recoll has no configured way to preview a given file type meaning that Recoll has no configured way to preview a given file type
(which was indexed by name only), or no configured external viewer for the (which was indexed by name only), or no configured external viewer for the
@ -366,53 +407,152 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
see the query actually performed, after stem expansion and other see the query actually performed, after stem expansion and other
processing. processing.
Double-clicking on any word inside the result list or a preview window
will insert it into the simple search text.
The result list is divided into pages (the size of which you can change in
the preferences). Use the arrow buttons in the toolbar or the links at the
bottom of the page to browse the results.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.2. Complex/advanced search 3.2.1. The result list right-click menu
Apart from the preview and edit links, you can display a popup menu by
right-clicking over a paragraph in the result list. This menu has the
following entries:
* Preview
* Edit
* Copy File Name
* Copy Url
* Find similar
The Preview and Edit entries do the same thing as the corresponding links.
The two following entries will copy either an url or the file path to the
clipboard, for pasting into another application.
The Find similar entry will select a number of relevant term from the
current document and enter them into the simple search field. You can then
start a simple search, with a good chance of finding documents related to
the current result.
----------------------------------------------------------------------
3.3. The preview window
The preview window opens when you first click a Preview link inside the
result list.
Subsequent preview requests for a given search open new tabs in the
existing window.
Starting another search and requesting a preview will create a new preview
window. The old one stays open until you close it.
You can close a preview tab by typing ^W (Ctrl + W) in the window. Closing
the last tab for a window will also close the window.
Of course you can also close a preview window by using the window manager
button in the top of the frame.
You can display successive or previous documents from the result list
inside a preview tab by typing Ctrl+Down or Ctrl+Up (Down and Up are the
arrow keys).
The preview tabs have an internal incremental search function. You
initiate the search either by typing a / (slash) inside the text area or
by clicking into the Search for: text field and entering the search
string. You can then use the Next and Previous buttons to find the
next/previous occurence. You can also type F3 inside the text area to get
to the next occurrence.
If you have a search string entered and you use ^Up/^Down to browse the
results, the search is initiated for each successive document. If the
string is found, the cursor will be positionned at the first occurrence of
the search string.
----------------------------------------------------------------------
3.4. Complex/advanced search
The advanced search dialog has fields that will allow a more refined The advanced search dialog has fields that will allow a more refined
search, looking for documents with all given words, a given exact phrase, search, looking for documents with all given elements, a given exact
none of the given words, or a given file name (with wildcard expansion). phrase, none of the given elements, or a given file name (with wildcard
All relevant fields will be combined by an implicit AND clause. expansion). All relevant fields will be combined by an implicit AND
clause. All fields except "Exact phrase" can accept a mix of single words
and phrases enclosed in double quotes.
It will let you search for documents of specific mime types (ie: only Advanced search will let you search for documents of specific mime types
text/plain, or text/html or application/pdf etc...) (ie: only text/plain, or text/html or application/pdf etc...). The state
of the file type selection can be saved as the default (the file type
filter will not be activated at program startup, but the lists will be in
the restored state).
It will let you restrict the search results to a subtree of the indexed You can also restrict the search results to a subtree of the indexed area.
area. If you need to do this often, you may think of setting up multiple indexes
instead, as the performance will be much better.
Click on the Start Search button in the advanced search dialog to start Click on the Start Search button in the advanced search dialog, or type
the search. The button in the main window always performs a simple search. Enter in any text field to start the search. The button in the main window
always performs a simple search.
Click on the Show query details link at the top of the result page to see Click on the Show query details link at the top of the result page to see
the query expansion. the query expansion.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.3. Multiple databases 3.5. Multiple databases
Your Recoll configuration always defines a main index. This is what gets Multiple Recoll databases or indexes can be created by using several
updated, for example, when you execute recollindex. configuration directories which are usually set to index different areas
of the file system. A specific index can be selected for updating or
searching, using the RECOLL_CONFDIR environment variable or the -c option
to recoll and recollindex.
You can use the search configuration tool to define additional databases A recollindex program instance can only update one specific index.
to be searched. These databases can be made active or inactive at any
moment.
The typical use of this feature is for a system administrator to set up a A recoll program instance is also associated with a specific index, which
central index, that you may choose to search, or not, in addition to your is the one to be updated by its indexing thread, but it can use any number
personal data. Of course, there are other possibilities. of Recoll indexes for searching. The external indexes can be selected
through the external indexes tab in the preferences dialog.
The main index (defined by your personal configuration) is always active. Index selection is performed in two phases. A set of all usable indexes
must first be defined, and then the subset of indexes to be used for
searching. Of course, these parameters are retained across program
executions (there are kept separately for each Recoll configuration). The
set of all indexes is usually quite stable, while the active ones might
typically be adjusted quite frequently.
The list of searchable databases may also be defined by the The main index (defined by RECOLL_CONFDIR) is always active. If this is
RECOLL_EXTRA_DBS environment variable. This should hold a colon-separated undesirable, you can set up your base configuration to index an empty
list of index directories, ie: directory.
As building the set of all indexes can be a little tedious when done
through the user interface, you can use the RECOLL_EXTRA_DBS environment
variable to provide an initial set. This might typically be set up by a
system administrator so that every user does not have to do it. The
variable should define a colon-separated list of index directories, ie:
export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db
A typical usage scenario for the multiple index feature would be for a
system administrator to set up a central index for shared data, that you
may choose to search, or not, in addition to your personal data. Of
course, there are other possibilities. There are many cases where you know
the subset of files that you want to be searched for a given query, and
where restricting the query will much improve the precision of the
results. This can also be performed with the directory filter in advanced
search, but multiple indexes will have much better performance and may be
worth the trouble.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.4. Document history 3.6. Document history
Documents that you actually view (with the internal preview or an external Documents that you actually view (with the internal preview or an external
tool) are entered into the document history, which is remembered. You can tool) are entered into the document history, which is remembered. You can
@ -420,7 +560,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.5. Result list sorting 3.7. Sorting search results
The documents in a result list are normally sorted in order of relevance. The documents in a result list are normally sorted in order of relevance.
It is possible to specify different sort parameters by using the Sort It is possible to specify different sort parameters by using the Sort
@ -436,34 +576,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.6. Additional result list functionality 3.8. Search tips, shortcuts
Apart from the preview and edit links, you can display a popup menu by
right-clicking over a paragraph in the result list. This menu has the
following entries:
* Preview
* Edit
* Copy File Name
* Copy Url
* More like this
The Preview and Edit entries do the same thing as the corresponding links.
The two following entries will copy either an url or the file path to the
clipboard, for pasting into another application.
The More like this entry will select a number of relevant term from the
current document and enter them into the simple search field. You can then
start a simple search, with a good chance of finding documents related to
the current result.
----------------------------------------------------------------------
3.7. Search tips, shortcuts
Disabling stem expansion. Entering a capitalized word in any search field Disabling stem expansion. Entering a capitalized word in any search field
will prevent stem expansion (no search for gardening if you enter Garden will prevent stem expansion (no search for gardening if you enter Garden
@ -473,9 +586,18 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Phrases. A phrase can be looked for by enclosing it in double quotes. Phrases. A phrase can be looked for by enclosing it in double quotes.
Example: "user manual" will look only for occurrences of user immediately Example: "user manual" will look only for occurrences of user immediately
followed by manual. You can use the This exact phrase field of the followed by manual. You can use the This exact phrase field of the
advanced search dialog to the same effect. advanced search dialog to the same effect. Phrases can be entered along
simple terms in all search entry fields (except This exact phrase).
Term completion. Typing ^TAB (Control+Tab) in the simple search entry AutoPhrases. This option can be set in the preferences dialog. If it is
set, a phrase will be automatically built and added to simple searches
when looking for Any terms. This will not change radically the results,
but will give a relevance boost to the results where the search terms
appear as a phrase. Ie: searching for virtual reality will still find all
documents where either virtual or reality or both appear, but those which
contain virtual reality should appear sooner in the list.
Term completion. Typing ^TAB (Control + Tab) in the simple search entry
field while entering a word will either complete the current word if its field while entering a word will either complete the current word if its
beginning matches a unique term in the index, or open a window to propose beginning matches a unique term in the index, or open a window to propose
a list of completions a list of completions
@ -484,11 +606,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
on a word in the result list or in a preview window will copy it to the on a word in the result list or in a preview window will copy it to the
simple search entry field. simple search entry field.
Finding related documents. Selecting the More like this entry in the Finding related documents. Selecting the Find similar documents entry in
result list paragraph right-click menu will select a set of "interesting" the result list paragraph right-click menu will select a set of
terms from the current result, and insert them into the simple search "interesting" terms from the current result, and insert them into the
entry field. You can then possibly edit the list and start a search to simple search entry field. You can then possibly edit the list and start a
find documents which may be apparented to the current result. search to find documents which may be apparented to the current result.
Query explanation. You can get an exact description of what the query Query explanation. You can get an exact description of what the query
looked for, including stem expansion, and boolean operators used, by looked for, including stem expansion, and boolean operators used, by
@ -497,18 +619,24 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
File names. File names are added as terms during indexing, and you can File names. File names are added as terms during indexing, and you can
specify them as ordinary terms in normal search fields (Recoll used to specify them as ordinary terms in normal search fields (Recoll used to
index all directories in the file path as terms. This has been abandonned index all directories in the file path as terms. This has been abandonned
as it did not seem really useful). Alternatively, you can use specific as it did not seem really useful). Alternatively, you can use the specific
file name search which will only look for file names and can use wildcard file name search which will only look for file names and can use wildcard
expansion. expansion.
Quitting. Entering ^Q almost anywhere will close the application. Quitting. Entering ^Q almost anywhere will close the application.
Closing previews. Entering ^W in a preview tab will close it (and, for the Closing previews. Entering Esc will close the preview window and all its
last tab, close the preview window). tabs. Entering ^W in a tab will close it (and, for the last tab, close the
preview window).
List browsing in preview. Entering ^Down or ^Up (Ctrl + an arrow key) in a
preview window will display the next or the previous document from the
result list. Any secondary search currently active will be executed on the
new document.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.8. Customising the search interface 3.9. Customising the search interface
It is possible to customise some aspects of the search interface by using It is possible to customise some aspects of the search interface by using
Query configuration entry in the Preferences menu. Query configuration entry in the Preferences menu.
@ -559,15 +687,19 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
and display an abstract in place of an explicit abstract found within and display an abstract in place of an explicit abstract found within
the document itself. the document itself.
Extra databases: * Synthetic abstract size: adjust to taste...
This panel will let you browse for additional databases that you may want * Synthetic abstract context words: how many words should be displayed
to search. Extra databases are designated by their database directory (ie: around each term occurrence.
/home/someothergui/.recoll/xapiandb, /usr/local/recollglobal/xapiandb).
Once entered, the databases will appear in the All extra databases list, External indexes: This panel will let you browse for additional indexes
and you can chose which ones you want to use at any moment by tranferring that you may want to search. External indexes are designated by their
them to/from the Active extra databases list. database directory (ie: /home/someothergui/.recoll/xapiandb,
/usr/local/recollglobal/xapiandb).
Once entered, the indexes will appear in the All indexes list, and you can
chose which ones you want to use at any moment by tranferring them to/from
the Active indexes list.
Your main database (the one the current configuration indexes to), is Your main database (the one the current configuration indexes to), is
always implicitely active. If this is not desirable, you can set up your always implicitely active. If this is not desirable, you can set up your
@ -577,9 +709,44 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Chapter 4. Installation Chapter 4. Installation
4.1. Building from source 4.1. Installing a prebuilt copy
4.1.1. Prerequisites Recoll binary installations are always linked statically to the xapian
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
beyond text, html and mail files.
----------------------------------------------------------------------
4.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, and maybe have a look at the
configuration section (but this may not be necessary for a quick test with
default parameters).
----------------------------------------------------------------------
4.1.2. Installing a prebuilt Recoll
The unpackaged binary versions are just compressed tar files of a build
tree, where only the useful parts were kept (executables and sample
configuration).
The executable binary files are built with a static link to libxapian and
libiconv, to make installation easier (no dependencies). However, this
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.
The binary trees are built for installation to /usr/local.
----------------------------------------------------------------------
4.2. Building from source
4.2.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
@ -596,7 +763,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
---------------------------------------------------------------------- ----------------------------------------------------------------------
4.1.2. Building 4.2.2. Building
Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3), 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 FreeBSD and Solaris 8. If you build on another system, I would very much
@ -636,41 +803,21 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
---------------------------------------------------------------------- ----------------------------------------------------------------------
4.1.3. Installation 4.2.3. Installation
Either type make install or execute recollinstall prefix, in the root of 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 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. 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. You can then proceed to configuration.
---------------------------------------------------------------------- ----------------------------------------------------------------------
4.2. Installing a prebuilt copy
4.2.1. Installing through a package system
If you are lucky enough to be using a port system or a prebuilt package
(RPM or other), just follow the usual procedure, and have a look at the
configuration section.
----------------------------------------------------------------------
4.2.2. Installing a prebuilt Recoll
The unpackaged binary versions are just compressed tar files of a build
tree, where only the useful parts were kept (executables and sample
configuration).
The executable binary files are built with a static link to libxapian and
libiconv, to make installation easier (no dependencies). However, this
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.
----------------------------------------------------------------------
4.3. Packages needed for external file types 4.3. Packages needed for external file types
Recoll uses external applications to index some file types. You need to Recoll uses external applications to index some file types. You need to
@ -683,6 +830,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* MS Word: antiword. * MS Word: antiword.
* MS Excel and PowerPoint: catdoc.
* RTF: unrtf * RTF: unrtf
* dvi: dvips * dvi: dvips
@ -701,9 +850,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
There are two sets of configuration files. The system-wide files are kept There are two sets of configuration files. The system-wide files are kept
in a directory named like /usr/[local/]share/recoll/examples, they define in a directory named like /usr/[local/]share/recoll/examples, they define
default values for the system. A parallel set of files exists in the default values for the system. A parallel set of files exists by default
.recoll directory in your home (this can be changed with the in the .recoll directory in your home. This directory can be changed with
RECOLL_CONFDIR environment variable. the RECOLL_CONFDIR environment variable or the -c option parameter to
recoll and recollindex.
If the .recoll directory does not exist when recoll or recollindex are If the .recoll directory does not exist when recoll or recollindex are
started, it will be created with a set of empty configuration files. started, it will be created with a set of empty configuration files.
@ -771,6 +921,13 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
inside the indexed trees. If an entry in the topdirs list is a inside the indexed trees. If an entry in the topdirs list is a
symbolic link, indexing will not start and will generate an error. symbolic link, indexing will not start and will generate an error.
dbdir
The name of the Xapian data directory. It will be created if
needed when the index is initialized. If this is not an absolute
path, it will be interpreted relative to the configuration
directory.
skippedNames skippedNames
A space-separated list of patterns for names of files or A space-separated list of patterns for names of files or
@ -818,16 +975,6 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
-s, but it will be deleted during the next indexing. Only -s, but it will be deleted during the next indexing. Only
languages listed in the configuration file are permanent. languages listed in the configuration file are permanent.
iconsdir
The name of the directory where recoll result list icons are
stored. You can change this if you want different images.
dbdir
The name of the Xapian data directory. It will be created if
needed when the index is initialized.
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
@ -859,6 +1006,20 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
indexing, or for all files inside the selected subtrees, indexing, or for all files inside the selected subtrees,
independant of mime type. independant of mime type.
idxabsmlen
Recoll stores an abstract for each indexed file inside the
database. This is so that they can be displayed inside the result
lists without decoding the original file. This parameter defines
the size of the stored abstract (which can come from an actual
section or just be the beginning of the text). The default value
is 250.
iconsdir
The name of the directory where recoll result list icons are
stored. You can change this if you want different images.
---------------------------------------------------------------------- ----------------------------------------------------------------------
4.4.2. The mimemap file 4.4.2. The mimemap file