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-10-02 07:50:06 +00:00
parent 0ab0801ab7
commit 4ecba196e6
6 changed files with 135 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/INSTALL
View File

@ -28,7 +28,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
beyond text, html and mail files. beyond text, HTML and mail files.
4.1.1. Installing through a package system 4.1.1. Installing through a package system
@ -60,7 +60,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
-------------------------------------------------------------------------- --------------------------------------------------------------------------
Prev Home Next Prev Home Next
Customising the search interface Packages needed for external file Customizing the search interface Packages needed for external file
types types
Link: HOME Link: HOME
Link: UP Link: UP
@ -93,10 +93,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* 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 extract tag information. Without it, only the file names will be
indexed. indexed.
Text, Html, mail folders and Openoffice files are processed internally. Text, HTML, mail folders and Openoffice files are processed internally.
-------------------------------------------------------------------------- --------------------------------------------------------------------------
@ -118,8 +118,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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 run-time and development packages (Recoll development currently uses
version 3.3.5, but any 3.3 version is probably ok). 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 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
@ -142,7 +142,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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++). sub-directories (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/.
@ -158,10 +158,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
cd recoll-xxx cd recoll-xxx
configure configure
make make
(practises usual hardship-repelling invocations) (practices usual hardship-repelling invocations)
There little autoconfiguration. The configure script will mainly link one There little auto-configuration. 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
@ -217,7 +217,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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.
All configuration files share the same format. For exemple, a short All configuration files share the same format. For example, a short
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.
@ -235,7 +235,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* Section definition ([somedirname]). * Section definition ([somedirname]).
Section lines allow redefining some parameters for a directory subtree. Section lines allow redefining some parameters for a directory sub-tree.
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.
@ -281,8 +281,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
*~ #* bin CVS Cache caughtspam tmp *~ #* bin CVS Cache caughtspam tmp
The list can be redefined for subdirectories, but is only actually The list can be redefined for sub-directories, but is only
changed for the top level ones in topdirs. actually 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).
@ -310,7 +310,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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. redefined for any sub-directory.
indexstemminglanguages indexstemminglanguages
@ -324,7 +324,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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 redefined for any sub-directory. 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.
@ -339,8 +339,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
useful for files with suffixless names, but it will also cause the useful for files with suffix-less names, but it will also cause
indexing of many bogus "text" files. the indexing of many bogus "text" files.
indexallfilenames indexallfilenames
@ -349,7 +349,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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,
independant of mime type. independently of mime type.
idxabsmlen idxabsmlen
@ -382,7 +382,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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. and it can be changed for any sub-directory.
4.4.3. The mimeconf file 4.4.3. The mimeconf file
@ -390,9 +390,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
are a Recoll developper. are a Recoll developers.
You may want to adjust the external viewers defined in (ie: html is either You may want to adjust the external viewers defined in (ie: HTML is either
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.

187
src/README
View File

@ -61,7 +61,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
3.8. Search tips, shortcuts 3.8. Search tips, shortcuts
3.9. Customising the search interface 3.9. Customizing the search interface
4. Installation 4. Installation
@ -123,7 +123,7 @@ 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, in a will return a list of documents where those terms are prominent, in a
similar way to internet search engines. similar way to Internet search engines.
Recoll tries to determine which documents are most relevant to the search Recoll tries to determine which documents are most relevant to the search
terms you provide. Computer algorithms for determining relevance can be terms you provide. Computer algorithms for determining relevance can be
@ -135,11 +135,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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,
different tenses for a verb, or terms derived from the same root or stem different tenses for a verb, or terms derived from the same root or stem
(exemple: floor, floors, floored, floorings...). Recoll will by default (example: floor, floors, floored, flooring...). Recoll will by default
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 accomodate for misspellings or phonetic Stemming, by itself, does not accommodate for misspellings or phonetic
searches. Recoll currently does not support these features. searches. Recoll currently does not support these features.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -159,7 +159,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
that still exist at the place from which they were indexed. (Actually, that still exist at the place from which they were indexed. (Actually,
there is a way to reconstruct a document from the information in the there is a way to reconstruct a document from the information in the
index, but the result is not nice, as all formatting, punctuation and index, but the result is not nice, as all formatting, punctuation and
capitalisation are lost). capitalization are lost).
Recoll stores all internal data in Unicode UTF-8 format, and it can index Recoll stores all internal data in Unicode UTF-8 format, and it can index
files with different character sets, encodings, and languages into the files with different character sets, encodings, and languages into the
@ -167,7 +167,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Stemming depends on the document language. Recoll stores the unstemmed Stemming depends on the document language. Recoll stores the unstemmed
versions of terms and uses auxiliary databases for term expansion. It can versions of terms and uses auxiliary databases for term expansion. It can
switch stemming languages, or add a language, without reindexing. Storing switch stemming languages, or add a language, without re-indexing. Storing
documents in different languages in the same index is possible, and useful documents in different languages in the same index is possible, and useful
in practice, but does introduce possibilities of confusion. Recoll in practice, but does introduce possibilities of confusion. Recoll
currently makes no attempt at automatic language recognition. currently makes no attempt at automatic language recognition.
@ -177,11 +177,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
configuration file. A default configuration is copied into a standard configuration file. A default configuration is copied into a standard
location (usually something like /usr/[local/]share/recoll/examples) location (usually something like /usr/[local/]share/recoll/examples)
during installation. The default parameters from this file may be during installation. The default parameters from this file may be
overriden by values that you set inside your personal configuration, found overridden by values that you set inside your personal configuration,
by default in the .recoll subdirectory of your home directory. The default found by default in the .recoll sub-directory of your home directory. The
configuration will index your home directory with default parameters and default configuration will index your home directory with default
should be sufficient for giving Recoll a try, but you may want to adjust parameters and should be sufficient for giving Recoll a try, but you may
it later. want to adjust it later.
Indexing is started automatically the first time you execute the recoll Indexing is started automatically the first time you execute the recoll
search graphical user interface, or by executing the recollindex command. search graphical user interface, or by executing the recollindex command.
@ -271,7 +271,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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 data directory is by mode of 0700 (access by owner only). As the index data directory is by
default a subdirectory of the configuration directory, this should result default a sub-directory of the configuration directory, this should result
in 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
@ -283,7 +283,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
2.3. The indexing configuration 2.3. The indexing configuration
Values set in the system-wide configuration file (named like Values set in the system-wide configuration file (named like
/usr/[local/]share/recoll/examples/recoll.conf) can be overriden by those /usr/[local/]share/recoll/examples/recoll.conf) can be overridden by those
set in the personal one, named $HOME/.recoll/recoll.conf by default or set in the personal one, named $HOME/.recoll/recoll.conf by default or
$RECOLL_CONFDIR/recoll.conf if RECOLL_CONFDIR is set. $RECOLL_CONFDIR/recoll.conf if RECOLL_CONFDIR is set.
@ -296,7 +296,7 @@ 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 The applications needed to index file types other than text, HTML or email
(ie: pdf, postscript, ms-word...) are described in the external packages (ie: pdf, postscript, ms-word...) are described in the external packages
section section
@ -310,7 +310,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
option to specify the configuration directory to be used. 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 canceled).
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 index in a bad state. This is not a serious problem, sometimes leave the index in a bad state. This is not a serious problem,
@ -370,7 +370,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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/file name).
Hitting ^Tab (Ctrl + Tab) while entering a word in the simple search entry 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 will open a window with possible completions for the word. The completions
@ -418,7 +418,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
3.2.1. The result list right-click menu 3.2.1. The result list right-click menu
Apart from the preview and edit links, you can display a popup menu by Apart from the preview and edit links, you can display a pop-up menu by
right-clicking over a paragraph in the result list. This menu has the right-clicking over a paragraph in the result list. This menu has the
following entries: following entries:
@ -433,7 +433,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* Find similar * Find similar
The Preview and Edit entries do the same thing as the corresponding links. 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 The two following entries will copy either an URL or the file path to the
clipboard, for pasting into another application. clipboard, for pasting into another application.
The Find similar entry will select a number of relevant term from the The Find similar entry will select a number of relevant term from the
@ -468,12 +468,12 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
initiate the search either by typing a / (slash) inside the text area or 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 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 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 next/previous occurrence. You can also type F3 inside the text area to get
to the next occurrence. to the next occurrence.
If you have a search string entered and you use ^Up/^Down to browse the 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 results, the search is initiated for each successive document. If the
string is found, the cursor will be positionned at the first occurrence of string is found, the cursor will be positioned at the first occurrence of
the search string. the search string.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -488,14 +488,14 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
and phrases enclosed in double quotes. and phrases enclosed in double quotes.
Advanced search will let you search for documents of specific mime types Advanced search will let you search for documents of specific mime types
(ie: only text/plain, or text/html or application/pdf etc...). The state (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 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 filter will not be activated at program start-up, but the lists will be in
the restored state). the restored state).
You can also restrict the search results to a subtree of the indexed area. You can also restrict the search results to a sub-tree of the indexed
If you need to do this often, you may think of setting up multiple indexes area. If you need to do this often, you may think of setting up multiple
instead, as the performance will be much better. indexes instead, as the performance will be much better.
Click on the Start Search button in the advanced search dialog, or type Click on the Start Search button in the advanced search dialog, or type
Enter in any text field to start the search. The button in the main window Enter in any text field to start the search. The button in the main window
@ -570,41 +570,47 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
result list, according to specified criteria. The currently available result list, according to specified criteria. The currently available
criteria are date and mime type. criteria are date and mime type.
The sort parameters stay in effect until they are explicitely reset, or The sort parameters stay in effect until they are explicitly reset, or the
the program exits. An activated sort is indicated in the result list program exits. An activated sort is indicated in the result list header.
header.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.8. Search tips, shortcuts 3.8. Search tips, shortcuts
Disabling stem expansion. Entering a capitalized word in any search field
will prevent stem expansion (no search for gardening if you enter Garden
instead of garden). This is the only case where character case should make
a difference for a Recoll search.
Phrases. A phrase can be looked for by enclosing it in double quotes.
Example: "user manual" will look only for occurrences of user immediately
followed by manual. You can use the This exact phrase field of the
advanced search dialog to the same effect. Phrases can be entered along
simple terms in all search entry fields (except This exact phrase).
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 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
Picking up new terms for search from displayed documents. Double-clicking Picking up new terms from result or preview text. Double-clicking on a
on a word in the result list or in a preview window will copy it to the word in the result list or in a preview window will copy it to the simple
simple search entry field. search entry field.
Disabling stem expansion. Entering a capitalized word in any search field
will prevent stem expansion (no search for gardening if you enter Garden
instead of garden). This is the only case where character case should make
a difference for a Recoll search. You can also disable stem expansion or
change the stemming language in the preferences.
Phrases. A phrase can be looked for by enclosing it in double quotes.
Example: "user manual" will look only for occurrences of user immediately
followed by manual. You can use the This exact phrase field of the
advanced search dialog to the same effect. Phrases can be entered along
simple terms in all simple or advanced search entry fields (except This
exact phrase).
Browsing the result list inside a preview window (1.5). Entering
Shift-Down or Shift-Up (Shift + 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.
AutoPhrases (1.5). 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.
Finding related documents. Selecting the Find similar documents entry in Finding related documents. Selecting the Find similar documents entry in
the result list paragraph right-click menu will select a set of the result list paragraph right-click menu will select a set of
@ -612,33 +618,28 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
simple search entry field. You can then possibly edit the list and start a simple search entry field. You can then possibly edit the list and start a
search to 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
looked for, including stem expansion, and boolean operators used, by
clicking on the result list header.
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 abandoned
as it did not seem really useful). Alternatively, you can use the 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.
Query explanation. You can get an exact description of what the query
looked for, including stem expansion, and Boolean operators used, by
clicking on the result list header.
Closing previews. Entering ^W in a tab will close it (and, for the last
tab, close the preview window). Entering Esc will close the preview window
and all its tabs.
Quitting. Entering ^Q almost anywhere will close the application. Quitting. Entering ^Q almost anywhere will close the application.
Closing previews. Entering Esc will close the preview window and all its
tabs. Entering ^W in a tab will close it (and, for the last tab, close the
preview window).
List browsing in preview. Entering Shift-Down or Shift-Up (Shift + 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.9. Customising the search interface 3.9. Customizing the search interface
It is possible to customise some aspects of the search interface by using It is possible to customize some aspects of the search interface by using
Query configuration entry in the Preferences menu. Query configuration entry in the Preferences menu.
There are two tabs in the dialog, dealing with the interface itself, and There are two tabs in the dialog, dealing with the interface itself, and
@ -649,11 +650,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* Number of results in a result page * Number of results in a result page
* Result list font: There is quite a lot of information shown in the * Result list font: There is quite a lot of information shown in the
result list, and you may want to customise the font and/or font size. result list, and you may want to customize the font and/or font size.
The rest of the fonts used by Recoll are determined by your generic QT The rest of the fonts used by Recoll are determined by your generic QT
config (try the qtconfig command. config (try the qtconfig command.
* Html help browser: this will let you chose your preferred browser * HTML help browser: this will let you chose your preferred browser
which will be started from the Help menu to read the user manual. You which will be started from the Help menu to read the user manual. You
can enter a simple name if the command is in your PATH, or browse for can enter a simple name if the command is in your PATH, or browse for
a full pathname. a full pathname.
@ -662,7 +663,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
be turned off. They take quite a lot of space and convey relatively be turned off. They take quite a lot of space and convey relatively
little useful information. little useful information.
* Auto-start simple search on whitespace entry: if this is checked, a * Auto-start simple search on white space entry: if this is checked, a
search will be executed each time you enter a space in the simple search will be executed each time you enter a space in the simple
search input field. This lets you look at the result list as you enter search input field. This lets you look at the result list as you enter
new terms. This is off by default, you may like it or not... new terms. This is off by default, you may like it or not...
@ -683,7 +684,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
the search terms. This can slow down result list display significantly the search terms. This can slow down result list display significantly
for big documents, and you may want to turn it off. for big documents, and you may want to turn it off.
* Replace abstracts from documents: this decides if we should synthetize * Replace abstracts from documents: this decides if we should synthesize
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.
@ -698,11 +699,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
/usr/local/recollglobal/xapiandb). /usr/local/recollglobal/xapiandb).
Once entered, the indexes will appear in the All indexes list, and you can 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 chose which ones you want to use at any moment by transferring them
the Active indexes list. 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 implicitly active. If this is not desirable, you can set up your
configuration so that it indexes, for example, an empty directory. configuration so that it indexes, for example, an empty directory.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -714,7 +715,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
beyond text, html and mail files. beyond text, HTML and mail files.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -770,10 +771,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* 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 extract tag information. Without it, only the file names will be
indexed. indexed.
Text, Html, mail folders and Openoffice files are processed internally. Text, HTML, mail folders and Openoffice files are processed internally.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -783,8 +784,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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 run-time and development packages (Recoll development currently uses
version 3.3.5, but any 3.3 version is probably ok). 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 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
@ -809,7 +810,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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++). sub-directories (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/.
@ -825,10 +826,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
cd recoll-xxx cd recoll-xxx
configure configure
make make
(practises usual hardship-repelling invocations) (practices usual hardship-repelling invocations)
There little autoconfiguration. The configure script will mainly link one There little auto-configuration. 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
@ -875,7 +876,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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.
All configuration files share the same format. For exemple, a short All configuration files share the same format. For example, a short
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.
@ -893,7 +894,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* Section definition ([somedirname]). * Section definition ([somedirname]).
Section lines allow redefining some parameters for a directory subtree. Section lines allow redefining some parameters for a directory sub-tree.
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.
@ -941,8 +942,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
*~ #* bin CVS Cache caughtspam tmp *~ #* bin CVS Cache caughtspam tmp
The list can be redefined for subdirectories, but is only actually The list can be redefined for sub-directories, but is only
changed for the top level ones in topdirs. actually 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).
@ -970,7 +971,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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. redefined for any sub-directory.
indexstemminglanguages indexstemminglanguages
@ -984,7 +985,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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 redefined for any sub-directory. 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.
@ -999,8 +1000,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
useful for files with suffixless names, but it will also cause the useful for files with suffix-less names, but it will also cause
indexing of many bogus "text" files. the indexing of many bogus "text" files.
indexallfilenames indexallfilenames
@ -1009,7 +1010,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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,
independant of mime type. independently of mime type.
idxabsmlen idxabsmlen
@ -1044,7 +1045,7 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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. and it can be changed for any sub-directory.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -1054,9 +1055,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
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
are a Recoll developper. are a Recoll developers.
You may want to adjust the external viewers defined in (ie: html is either You may want to adjust the external viewers defined in (ie: HTML is either
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.

5
website/BUGS.txt
View File

@ -1,5 +1,10 @@
Known bugs in current version and older versions: Known bugs in current version and older versions:
1.5.0
- Under some conditions, recoll startup and exit could be very slow: the
simple search history list had serious problems with non-ascii strings,
whose size sometimes doubled at each program startup/stop.
1.4.2 - 1.5.0 1.4.2 - 1.5.0
- When a mime type has an external viewer defined, but the actual file is - When a mime type has an external viewer defined, but the actual file is
compressed (ie: xxx.txt.gz), recoll will try to start the external viewer compressed (ie: xxx.txt.gz), recoll will try to start the external viewer

5
website/CHANGES.txt
View File

@ -11,6 +11,11 @@ values, and the user ones only for overrides. Your old configuration files
will still work, but, you may want to remove them if they are unmodified, will still work, but, you may want to remove them if they are unmodified,
or keep only the modified parameters. or keep only the modified parameters.
1.5.1
- Fix serious bug with non ascii strings in simple search history
- Improve synthetic abstracts: remove size limitations, handle overlapping
extracts, avoid printing several terms from the same position.
1.5.0 2006-09-20 1.5.0 2006-09-20
- Added support for powerpoint and excel files, with the catdoc package. - Added support for powerpoint and excel files, with the catdoc package.

14
website/download.html
View File

@ -47,21 +47,13 @@
<h3>Source</h3> <h3>Source</h3>
<p>The bleeding edge: 1.5.0: <p>Current version: 1.5.1:
<a href="recoll-1.5.0.tar.gz">recoll-1.5.0.tar.gz</a>. <a href="recoll-1.5.1.tar.gz">recoll-1.5.1.tar.gz</a>.
See the <a href="BUGS.txt">known bugs and issues</a> and <a See the <a href="BUGS.txt">known bugs and issues</a> and <a
href="CHANGES.txt">changes</a>.</p> href="CHANGES.txt">changes</a>.</p>
<p>Previous version, 1.4.3:
<a href="recoll-1.4.3.tar.gz">recoll-1.4.3.tar.gz</a>.
See the <a href="BUGS.txt">known bugs and issues</a> and <a
href="CHANGES.txt">changes</a>. Release 1.4.3 is exactly
1.4.2 with updated ukrainian and russian messages (thanks to
Michael Shigorin). No need to upgrade from 1.4.2 if you
do not need these. </p>
<p>Older recoll releases: <p>Older recoll releases:
<a href="recoll-1.4.2.tar.gz">1.4.2</a>. <a href="recoll-1.4.3.tar.gz">1.4.3</a>.
<a href="recoll-1.3.3.tar.gz">1.3.3</a>. <a href="recoll-1.3.3.tar.gz">1.3.3</a>.
<a href="recoll-1.2.3.tar.gz">1.2.3</a>. <a href="recoll-1.2.3.tar.gz">1.2.3</a>.
<a href="recoll-1.1.0.tar.gz">1.1.0</a>. <a href="recoll-1.1.0.tar.gz">1.1.0</a>.

7
website/index.html
View File

@ -53,6 +53,13 @@
contributors, see the <a class="important" contributors, see the <a class="important"
href="credits.html">Credits</a>.</p> href="credits.html">Credits</a>.</p>
<blockquote>
<p><b><i>Recoll user ?</i></b> Maybe there are still a few useful
tricks that you don't know about. A quick look at
the <a href="usermanual/rcl.search.tips.html">search
tips</a> might prove useful !</p>
</blockquote>
<h2>Features: </h1> <h2>Features: </h1>
<ul> <ul>