|
a/src/README |
|
b/src/README |
|
... |
|
... |
| 56 |
|
56 |
|
| 57 |
Things hopefully coming in the not too far future (especially with some
|
57 |
Things hopefully coming in the not too far future (especially with some
|
| 58 |
help):
|
58 |
help):
|
| 59 |
|
59 |
|
| 60 |
* Support for the more advanced Xapian concepts like relevance feedback.
|
60 |
* Support for the more advanced Xapian concepts like relevance feedback.
|
| 61 |
* An interactive configuration tool. You need to edit files by hand for
|
61 |
* An interactive configuration tool.
|
| 62 |
now.
|
62 |
* Rpms or other kinds of packages.
|
| 63 |
* Packages, rpm or other. It's all tar files currently.
|
|
|
| 64 |
* A more polished user interface with online help and better
|
63 |
* A more polished user interface with online help and better
|
| 65 |
documentation.
|
64 |
documentation.
|
| 66 |
* Translations for the user interface.
|
65 |
* More translations for the user interface.
|
| 67 |
* A few more filters for less common file types.
|
66 |
* A few more filters for less common file types.
|
| 68 |
* An history tool for queries and documents.
|
|
|
| 69 |
* Integration with the KDE desktop.
|
67 |
* Integration with the KDE desktop.
|
| 70 |
|
68 |
|
| 71 |
I very much welcome suggestions or (gasp) code.
|
69 |
I very much welcome suggestions or (gasp) code.
|
| 72 |
|
70 |
|
| 73 |
In hope that this can be useful to somebody, it already is for me.
|
71 |
In hope that this can be useful to somebody, it already is for me.
|
|
... |
|
... |
| 101 |
* Credits
|
99 |
* Credits
|
| 102 |
* Downloads
|
100 |
* Downloads
|
| 103 |
* Installation
|
101 |
* Installation
|
| 104 |
* User manual
|
102 |
* User manual
|
| 105 |
|
103 |
|
|
|
104 |
Introduction: full text search.
|
|
|
105 |
|
|
|
106 |
A full text search program will let you search for data by specifying the
|
|
|
107 |
terms that you think appear in the content you are looking for.
|
|
|
108 |
|
|
|
109 |
You do not need to remember in what file or email message you stored a
|
|
|
110 |
given piece of information. You just ask for related terms, and the tool
|
|
|
111 |
will return a list of documents where those terms are prominent.
|
|
|
112 |
|
|
|
113 |
In addition, the tool will automatically expand your search to terms
|
|
|
114 |
related to the ones you specified. Ie: a search for floor will also look
|
|
|
115 |
for floors, flooring etc. With Recoll you can disable this expansion when
|
|
|
116 |
entering the query.
|
|
|
117 |
|
|
|
118 |
Recoll, like most such search tools, works by remembering where terms
|
|
|
119 |
appear in your document files. The acquisition process is called
|
|
|
120 |
indexation. The resulting database can be big (roughly the size of the
|
|
|
121 |
original documents in practise). This used to be a big issue, but it is
|
|
|
122 |
probably not any more, now that text documents are tiny blots among the
|
|
|
123 |
sea of multimedia data, especially for a personal system.
|
|
|
124 |
|
|
|
125 |
Recoll is not a document archive. It can only display data from files that
|
|
|
126 |
still exist where they lived when they were indexed.
|
|
|
127 |
|
| 106 |
Using Recoll
|
128 |
Using Recoll
|
| 107 |
|
129 |
|
| 108 |
Indexation
|
130 |
Indexation
|
| 109 |
|
131 |
|
| 110 |
By default, Recoll will index your home directory. If you want to change
|
132 |
By default, Recoll will index your home directory. If you want to change
|
| 111 |
this, you need to edit the configuration file ($HOME/.recoll/recoll.conf).
|
133 |
this, you need to edit the configuration file ($HOME/.recoll/recoll.conf).
|
| 112 |
Follow the comments in the file to adjust the parameters.
|
134 |
Follow the comments in the file to adjust the parameters.
|
| 113 |
|
135 |
|
| 114 |
Indexing is performed either by the recollindex program, or by the
|
136 |
Indexation is performed either by starting the recollindex program, or the
|
| 115 |
indexing thread inside the recoll program (use the File menu).
|
137 |
indexing thread inside the recoll program (use the File menu).
|
|
|
138 |
|
|
|
139 |
It is best to avoid interrupting the indexation process, as this can leave
|
|
|
140 |
the database in a bad state. This is not a serious problem, as you then
|
|
|
141 |
just need to clear everything and restart the indexation. The database
|
|
|
142 |
files are stored in the $RECOLL_CONFDIR/xapiandb directory, which you can
|
|
|
143 |
just delete when needed.
|
| 116 |
|
144 |
|
| 117 |
Simple search
|
145 |
Simple search
|
| 118 |
|
146 |
|
| 119 |
Enter search term(s) in the text field at the top left. Clicking the
|
147 |
Start the recoll program, then enter search term(s) in the text field at
|
| 120 |
Search button or hitting the Enter key will start a search. By default,
|
148 |
the top left of the window. Clicking the Search button or hitting the
|
| 121 |
this will look for documents with any of the terms (the ones with more
|
149 |
Enter key will start a search. By default, this will look for documents
|
| 122 |
terms will get better scores). Use the Advanced search dialog for other
|
150 |
with any of the terms (the ones with more terms will get better scores).
|
| 123 |
kinds of searches
|
151 |
Use the Advanced search dialog for other kinds of searches
|
| 124 |
|
152 |
|
| 125 |
A list of results will be displayed in the main list window. Clicking on
|
153 |
A list of results will be displayed in the main list window. Clicking on
|
| 126 |
an entry will open an internal preview window for the document.
|
154 |
an entry will open an internal preview window for the document.
|
| 127 |
Double-clicking will attempt to start an external viewer (have a look at
|
155 |
Double-clicking will attempt to start an external viewer (have a look at
|
| 128 |
the ~/.recoll/mimeconf file to see how these are configured).
|
156 |
the ~/.recoll/mimeconf file to see how these are configured).
|
| 129 |
|
157 |
|
|
|
158 |
Documents that you actually view (with the internal preview or an external
|
|
|
159 |
tool) are entered into the document history, which is remembered. You can
|
|
|
160 |
display the history list by using the Tools / Doc History menu entry.
|
|
|
161 |
|
| 130 |
Search tips, shortcuts
|
162 |
Search tips, shortcuts
|
| 131 |
|
163 |
|
| 132 |
Entering a capitalized word in any search field will prevent stem
|
164 |
Entering a capitalized word in any search field will prevent stem
|
| 133 |
expansion (example: Recoll will not look for gardening if you enter Garden
|
165 |
expansion (example: Recoll will not look for gardening if you enter Garden
|
| 134 |
instead of garden).
|
166 |
instead of garden). This is the only case where character case will make a
|
|
|
167 |
difference for a Recoll search.
|
| 135 |
|
168 |
|
| 136 |
A phrase can be looked for by enclosing it in double quotes. Example:
|
169 |
A phrase can be looked for by enclosing it in double quotes. Example:
|
| 137 |
"user manual" will look only for occurrences of user immediately followed
|
170 |
"user manual" will look only for occurrences of user immediately followed
|
| 138 |
by manual.
|
171 |
by manual.
|
| 139 |
|
172 |
|