|
a/src/README |
|
b/src/README |
| 1 |
|
1 |
|
| 2 |
A more complete version of this document can be found at http://www.recoll.org
|
2 |
A more complete version of this document can be found at http://www.recoll.org
|
| 3 |
|
3 |
|
| 4 |
|
4 |
|
|
|
5 |
* Home
|
|
|
6 |
* Screenshots
|
|
|
7 |
* Credits
|
|
|
8 |
* Downloads
|
|
|
9 |
* Installation
|
|
|
10 |
* User manual
|
|
|
11 |
|
|
|
12 |
Credits
|
|
|
13 |
|
|
|
14 |
Recoll borrows (steals?) heavily from the following projects. I tried to
|
|
|
15 |
include the relevant copyright attributions with the code. Any omission is
|
|
|
16 |
unintentional and will be fixed as soon as notified.
|
|
|
17 |
|
|
|
18 |
* Xapian: The database module (core) is used unmodified, and quite a lot
|
|
|
19 |
of code has been borrowed from Omega, the web-based search application
|
|
|
20 |
(ie: the html parser, plus miscellaneous bits and ideas).
|
|
|
21 |
* Estraier: Miscellaneous pieces of code and ideas, especially for
|
|
|
22 |
charset handling, and code from external filters.
|
|
|
23 |
* Unac: for accent removal. This is a relatively small package, not that
|
|
|
24 |
easy to find, it has been integrated almost unmodified in the Recoll
|
|
|
25 |
package.
|
|
|
26 |
* Iconv, for character set conversion.
|
|
|
27 |
* Binc IMAP for MIME parsing code.
|
|
|
28 |
* I fear the rest of the bugs to be mostly mine:
|
|
|
29 |
jean-francois.dockes@wanadoo.fr
|
|
|
30 |
* Home
|
|
|
31 |
* Screenshots
|
|
|
32 |
* Credits
|
|
|
33 |
* Downloads
|
|
|
34 |
* Installation
|
|
|
35 |
* User manual
|
|
|
36 |
|
|
|
37 |
Using Recoll
|
|
|
38 |
|
|
|
39 |
Indexation
|
|
|
40 |
|
|
|
41 |
By default, Recoll will index your home directory. If you want to change
|
|
|
42 |
this, you need to edit the configuration file ($HOME/.recoll/recoll.conf).
|
|
|
43 |
Follow the comments in the file to adjust the parameters.
|
|
|
44 |
|
|
|
45 |
Indexing is performed either by starting the recollindex program, or by
|
|
|
46 |
the indexing thread inside the recoll program (use the File menu).
|
|
|
47 |
|
|
|
48 |
Simple search
|
|
|
49 |
|
|
|
50 |
Enter search term(s) in the text field at the top left. Clicking the
|
|
|
51 |
Search button or hitting the Enter key will start a search. By default,
|
|
|
52 |
this will look for documents with any of the terms (the ones with more
|
|
|
53 |
terms will get better scores). Use the Advanced search dialog for other
|
|
|
54 |
kinds of searches
|
|
|
55 |
|
|
|
56 |
A list of results will be displayed in the main list window. Clicking on
|
|
|
57 |
an entry will open an internal preview window for the document.
|
|
|
58 |
Double-clicking will attempt to start an external viewer (have a look at
|
|
|
59 |
the ~/.recoll/mimeconf file to see how these are configured).
|
|
|
60 |
|
|
|
61 |
Search tips, shortcuts
|
|
|
62 |
|
|
|
63 |
Entering a capitalized word in any search field will prevent stem
|
|
|
64 |
expansion (example: Recoll will not look for gardening if you enter Garden
|
|
|
65 |
instead of garden).
|
|
|
66 |
|
|
|
67 |
A phrase can be looked for by enclosing it in double quotes. Example:
|
|
|
68 |
"user manual" will look only for occurrences of user immediately followed
|
|
|
69 |
by manual.
|
|
|
70 |
|
|
|
71 |
Entering ^Q almost anywhere will close the application.
|
|
|
72 |
|
|
|
73 |
Entering ^W in a preview tab will close it (and, for the last tab, close
|
|
|
74 |
the preview window).
|
|
|
75 |
|
|
|
76 |
Complex/advanced search
|
|
|
77 |
|
|
|
78 |
The advanced search dialog has fields that will allow a more refined
|
|
|
79 |
search, looking for documents with all given words, a given exact phrase,
|
|
|
80 |
or none of the given words (all fields may be combined by a default AND
|
|
|
81 |
clause).
|
|
|
82 |
|
|
|
83 |
It will let you search for documents of specific mime types (ie: only
|
|
|
84 |
text/plain, or text/html or application/pdf etc...)
|
|
|
85 |
|
|
|
86 |
It will let you restrict the search results to a subtree of the indexed
|
|
|
87 |
area.
|
|
|
88 |
|
|
|
89 |
In other respects, it works as the simple search.
|