← Back to branch summary

~ubuntu-branches/ubuntu/quantal/recoll/quantal

« back to all changes in this revision

Viewing changes to doc/user/index.html

  • Committer: Package Import Robot
  • Author(s): Kartik Mistry
  • Date: 2012-03-27 12:15:51 UTC
  • mfrom: (1.3.8)
  • Revision ID: package-import@ubuntu.com-20120327121551-nmntidzpehudushy
Tags: 1.17.1-1
* New upstream release.
* Enable Python module resulting into new binary: python-recoll.
* debian/control:
  + Updated Build-Deps: libqtwebkit-dev, python-all-dev.
  + Added python-recoll binary.
  + Updated Standards-Version to 3.9.3
* debian/rules:
  + Build Python module by default.
* debian/recoll.menu, debian/python-recoll.install, debian/recoll.install:
  + Changes for new binary package.
* debian/copyright:
  + Updated to copyright-format 1.0
  + Updated upstream and Debian copyright.
  + Fixed unicode.org/copyright.html URL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/user/index.html
2
2
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
3
<html xmlns="http://www.w3.org/1999/xhtml">
4
4
<head>
5
 
<meta name="generator" content="HTML Tidy, see www.w3.org" />
 
5
<meta name="generator" content=
 
6
"HTML Tidy for FreeBSD (vers 7 December 2008), see www.w3.org" />
6
7
<title>Recoll user manual</title>
7
8
<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79" />
8
9
<link rel="NEXT" title="Introduction" href="rcl.introduction.html" />
9
10
<link rel="STYLESHEET" type="text/css" href="docbook.css" />
10
11
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
11
12
</head>
12
 
<body class="BOOK" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#840084"
13
 
alink="#0000FF">
14
 
<div class="BOOK"><a id="AEN1" name="AEN1"></a>
 
13
<body class="BOOK" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#840084" alink=
 
14
"#0000FF">
 
15
<div class="BOOK"><a name="AEN1" id="AEN1"></a>
15
16
<div class="TITLEPAGE">
16
 
<h1 class="TITLE"><a id="AEN2" name="AEN2">Recoll user manual</a></h1>
17
 
 
18
 
<h3 class="AUTHOR"><a id="AEN4" name="AEN4"></a>Jean-Francois Dockes</h3>
19
 
 
 
17
<h1 class="TITLE"><a name="AEN2" id="AEN2">Recoll user manual</a></h1>
 
18
<h3 class="AUTHOR"><a name="AEN4" id="AEN4"></a>Jean-Francois Dockes</h3>
20
19
<div class="AFFILIATION">
21
20
<div class="ADDRESS">
22
 
<p class="ADDRESS"><code class="EMAIL">&#60;<a
23
 
href="mailto:jfd@recoll.org">jfd@recoll.org</a>&#62;</code></p>
24
 
</div>
25
 
</div>
26
 
 
27
 
<p class="COPYRIGHT">Copyright &copy; 2005-2011 Jean-Francois Dockes</p>
28
 
 
 
21
<p class="ADDRESS"><code class="EMAIL">&lt;<a href=
 
22
"mailto:jfd@recoll.org">jfd@recoll.org</a>&gt;</code></p>
 
23
</div>
 
24
</div>
 
25
<p class="COPYRIGHT">Copyright � 2005-2012 Jean-Francois Dockes</p>
29
26
<div>
30
 
<div class="ABSTRACT"><a id="AEN14" name="AEN14"></a>
 
27
<div class="ABSTRACT"><a name="AEN13" id="AEN13"></a>
31
28
<p>This document introduces full text search notions and describes the installation and
32
 
use of the <b class="APPLICATION">Recoll</b> application. It currently describes <b
33
 
class="APPLICATION">Recoll</b> 1.16.</p>
34
 
</div>
35
 
</div>
36
 
 
37
 
<div class="DOCFORAMTNAVI">[ <a href="./index.html">Split HTML</a> / <a
38
 
href="./book.html">Single HTML</a> ]</div>
39
 
 
40
 
<hr />
41
 
</div>
42
 
 
 
29
use of the <b class="APPLICATION">Recoll</b> application. It currently describes
 
30
<b class="APPLICATION">Recoll</b> 1.17.</p>
 
31
</div>
 
32
</div>
 
33
<div class="DOCFORAMTNAVI">[ <a href="./index.html">Split HTML</a> / <a href=
 
34
"./book.html">Single HTML</a> ]</div>
 
35
<hr /></div>
43
36
<div class="TOC">
44
37
<dl>
45
38
<dt><b>Table of Contents</b></dt>
46
 
 
47
39
<dt>1. <a href="rcl.introduction.html">Introduction</a></dt>
48
 
 
49
40
<dd>
50
41
<dl>
51
42
<dt>1.1. <a href="rcl.introduction.html#RCL.INTRODUCTION.TRYIT">Giving it a try</a></dt>
52
 
 
53
43
<dt>1.2. <a href="rcl.introduction.search.html">Full text search</a></dt>
54
 
 
55
44
<dt>1.3. <a href="rcl.introduction.recoll.html">Recoll overview</a></dt>
56
45
</dl>
57
46
</dd>
58
 
 
59
47
<dt>2. <a href="rcl.indexing.html">Indexing</a></dt>
60
 
 
61
48
<dd>
62
49
<dl>
63
50
<dt>2.1. <a href="rcl.indexing.html#RCL.INDEXING.INTRODUCTION">Introduction</a></dt>
64
 
 
65
51
<dt>2.2. <a href="rcl.indexing.storage.html">Index storage</a></dt>
66
 
 
67
52
<dd>
68
53
<dl>
69
54
<dt>2.2.1. <a href="rcl.indexing.storage.html#RCL.INDEXING.STORAGE.FORMAT">Xapian index
70
55
formats</a></dt>
71
 
 
72
56
<dt>2.2.2. <a href="rcl.indexing.storage.html#RCL.INDEXING.STORAGE.SECURITY">Security
73
57
aspects</a></dt>
74
58
</dl>
75
59
</dd>
76
 
 
77
60
<dt>2.3. <a href="rcl.indexing.config.html">Indexing configuration</a></dt>
78
 
 
79
61
<dd>
80
62
<dl>
81
63
<dt>2.3.1. <a href="rcl.indexing.config.html#RCL.INDEXING.CONFIG.GUI">The indexing
82
64
configuration GUI</a></dt>
83
65
</dl>
84
66
</dd>
85
 
 
86
67
<dt>2.4. <a href="rcl.indexing.beaglequeue.html">Using Beagle WEB browser
87
68
plugins</a></dt>
88
 
 
89
69
<dt>2.5. <a href="rcl.indexing.periodic.html">Periodic indexing</a></dt>
90
 
 
91
70
<dd>
92
71
<dl>
93
72
<dt>2.5.1. <a href="rcl.indexing.periodic.html#RCL.INDEXING.PERIODIC.EXEC">Running
94
73
indexing</a></dt>
95
 
 
96
 
<dt>2.5.2. <a href="rcl.indexing.periodic.html#RCL.INDEXING.PERIODIC.AUTOMAT">Using <tt
97
 
class="COMMAND">cron</tt> to automate indexing</a></dt>
 
74
<dt>2.5.2. <a href="rcl.indexing.periodic.html#RCL.INDEXING.PERIODIC.AUTOMAT">Using
 
75
<tt class="COMMAND">cron</tt> to automate indexing</a></dt>
98
76
</dl>
99
77
</dd>
100
 
 
101
78
<dt>2.6. <a href="rcl.indexing.monitor.html">Real time indexing</a></dt>
102
 
 
103
79
<dd>
104
80
<dl>
105
81
<dt>2.6.1. <a href="rcl.indexing.monitor.html#RCL.INDEXING.MONITOR.FASTFILES">Slowing
108
84
</dd>
109
85
</dl>
110
86
</dd>
111
 
 
112
87
<dt>3. <a href="rcl.search.html">Searching</a></dt>
113
 
 
114
88
<dd>
115
89
<dl>
116
90
<dt>3.1. <a href="rcl.search.html#RCL.SEARCH.GUI">Searching with the Qt graphical user
117
91
interface</a></dt>
118
 
 
119
92
<dd>
120
93
<dl>
121
94
<dt>3.1.1. <a href="rcl.search.html#RCL.SEARCH.SIMPLE">Simple search</a></dt>
122
 
 
123
95
<dt>3.1.2. <a href="rcl.search.html#RCL.SEARCH.RESLIST">The default result list</a></dt>
124
 
 
125
96
<dt>3.1.3. <a href="rcl.search.html#RCL.SEARCH.RESTABLE">The result table</a></dt>
126
 
 
127
97
<dt>3.1.4. <a href="rcl.search.html#RCL.SEARCH.PREVIEW">The preview window</a></dt>
128
 
 
129
98
<dt>3.1.5. <a href="rcl.search.html#RCL.SEARCH.COMPLEX">Complex/advanced search</a></dt>
130
 
 
131
99
<dt>3.1.6. <a href="rcl.search.html#RCL.SEARCH.TERMEXPLORER">The term explorer
132
100
tool</a></dt>
133
 
 
134
101
<dt>3.1.7. <a href="rcl.search.html#RCL.SEARCH.MULTIDB">Multiple databases</a></dt>
135
 
 
136
102
<dt>3.1.8. <a href="rcl.search.html#RCL.SEARCH.HISTORY">Document history</a></dt>
137
 
 
138
103
<dt>3.1.9. <a href="rcl.search.html#RCL.SEARCH.SORT">Sorting search results and
139
104
collapsing duplicates</a></dt>
140
 
 
141
105
<dt>3.1.10. <a href="rcl.search.html#RCL.SEARCH.TIPS">Search tips, shortcuts</a></dt>
142
 
 
143
106
<dt>3.1.11. <a href="rcl.search.html#RCL.SEARCH.CUSTOM">Customizing the search
144
107
interface</a></dt>
145
108
</dl>
146
109
</dd>
147
 
 
148
110
<dt>3.2. <a href="rcl.searchkio.html">Searching with the KDE KIO slave</a></dt>
149
 
 
150
111
<dd>
151
112
<dl>
152
113
<dt>3.2.1. <a href="rcl.searchkio.html#RCL.SEARCHKIO.INTRO">What's this</a></dt>
153
 
 
154
114
<dt>3.2.2. <a href="rcl.searchkio.html#RCL.SEARCHKIO.SEARCHABLEDOCS">Searchable
155
115
documents</a></dt>
156
116
</dl>
157
117
</dd>
158
 
 
159
118
<dt>3.3. <a href="rcl.search.commandline.html">Searching on the command line</a></dt>
160
 
 
161
119
<dt>3.4. <a href="rcl.search.lang.html">The query language</a></dt>
162
 
 
163
120
<dd>
164
121
<dl>
165
 
<dt>3.4.1. <a href="rcl.search.lang.html#AEN1130">Modifiers</a></dt>
 
122
<dt>3.4.1. <a href="rcl.search.lang.html#RCL.SEARCH.LANG.MODIFIERS">Modifiers</a></dt>
166
123
</dl>
167
124
</dd>
168
 
 
169
125
<dt>3.5. <a href="rcl.search.anchorwild.html">Anchored searches and wildcards</a></dt>
170
 
 
171
126
<dd>
172
127
<dl>
173
128
<dt>3.5.1. <a href="rcl.search.anchorwild.html#RCL.SEARCH.WILDCARDS">More about
174
129
wildcards</a></dt>
175
 
 
176
130
<dt>3.5.2. <a href="rcl.search.anchorwild.html#RCL.SEARCH.ANCHOR">Anchored
177
131
searches</a></dt>
178
132
</dl>
179
133
</dd>
180
 
 
181
134
<dt>3.6. <a href="rcl.search.desktop.html">Desktop integration</a></dt>
182
 
 
183
135
<dd>
184
136
<dl>
185
137
<dt>3.6.1. <a href="rcl.search.desktop.html#RCL.SEARCH.SHORTCUT">Hotkeying
186
138
recoll</a></dt>
187
 
 
188
139
<dt>3.6.2. <a href="rcl.search.desktop.html#RCL.KICKER-APPLET">The KDE Kicker Recoll
189
140
applet</a></dt>
190
141
</dl>
191
142
</dd>
192
143
</dl>
193
144
</dd>
194
 
 
195
145
<dt>4. <a href="rcl.program.html">Programming interface</a></dt>
196
 
 
197
146
<dd>
198
147
<dl>
199
148
<dt>4.1. <a href="rcl.program.html#RCL.PROGRAM.FILTERS">Writing a document
200
149
filter</a></dt>
201
 
 
202
150
<dd>
203
151
<dl>
204
 
<dt>4.1.1. <a href="rcl.program.html#RCL.PROGRAM.FILTERS.HTML">Filter HTML
 
152
<dt>4.1.1. <a href="rcl.program.html#RCL.PROGRAM.FILTERS.SIMPLE">Simple filters</a></dt>
 
153
<dt>4.1.2. <a href="rcl.program.html#RCL.PROGRAM.FILTERS.ASSOCIATION">Telling <b class=
 
154
"APPLICATION">Recoll</b> about the filter</a></dt>
 
155
<dt>4.1.3. <a href="rcl.program.html#RCL.PROGRAM.FILTERS.HTML">Filter HTML
205
156
output</a></dt>
206
157
</dl>
207
158
</dd>
208
 
 
209
159
<dt>4.2. <a href="rcl.program.fields.html">Field data processing</a></dt>
210
 
 
211
160
<dt>4.3. <a href="rcl.program.api.html">API</a></dt>
212
 
 
213
161
<dd>
214
162
<dl>
215
163
<dt>4.3.1. <a href="rcl.program.api.html#RCL.PROGRAM.API.ELEMENTS">Interface
216
164
elements</a></dt>
217
 
 
218
165
<dt>4.3.2. <a href="rcl.program.api.html#RCL.PROGRAM.API.PYTHON">Python
219
166
interface</a></dt>
220
167
</dl>
221
168
</dd>
222
169
</dl>
223
170
</dd>
224
 
 
225
171
<dt>5. <a href="rcl.install.html">Installation and configuration</a></dt>
226
 
 
227
172
<dd>
228
173
<dl>
229
174
<dt>5.1. <a href="rcl.install.html#RCL.INSTALL.BINARY">Installing a binary copy</a></dt>
230
 
 
231
175
<dd>
232
176
<dl>
233
177
<dt>5.1.1. <a href="rcl.install.html#RCL.INSTALL.BINARY.PACKAGE">Installing through a
234
178
package system</a></dt>
235
 
 
236
 
<dt>5.1.2. <a href="rcl.install.html#RCL.INSTALL.BINARY.RCL">Installing a prebuilt <b
237
 
class="APPLICATION">Recoll</b></a></dt>
 
179
<dt>5.1.2. <a href="rcl.install.html#RCL.INSTALL.BINARY.RCL">Installing a prebuilt
 
180
<b class="APPLICATION">Recoll</b></a></dt>
238
181
</dl>
239
182
</dd>
240
 
 
241
183
<dt>5.2. <a href="rcl.install.external.html">Supporting packages</a></dt>
242
 
 
243
184
<dt>5.3. <a href="rcl.install.building.html">Building from source</a></dt>
244
 
 
245
185
<dd>
246
186
<dl>
247
 
<dt>5.3.1. <a
248
 
href="rcl.install.building.html#RCL.INSTALL.BUILDING.PREREQS">Prerequisites</a></dt>
249
 
 
250
 
<dt>5.3.2. <a
251
 
href="rcl.install.building.html#RCL.INSTALL.BUILDING.BUILD">Building</a></dt>
252
 
 
253
 
<dt>5.3.3. <a
254
 
href="rcl.install.building.html#RCL.INSTALL.BUILDING.INSTALL">Installation</a></dt>
 
187
<dt>5.3.1. <a href=
 
188
"rcl.install.building.html#RCL.INSTALL.BUILDING.PREREQS">Prerequisites</a></dt>
 
189
<dt>5.3.2. <a href=
 
190
"rcl.install.building.html#RCL.INSTALL.BUILDING.BUILD">Building</a></dt>
 
191
<dt>5.3.3. <a href=
 
192
"rcl.install.building.html#RCL.INSTALL.BUILDING.INSTALL">Installation</a></dt>
255
193
</dl>
256
194
</dd>
257
 
 
258
195
<dt>5.4. <a href="rcl.install.config.html">Configuration overview</a></dt>
259
 
 
260
196
<dd>
261
197
<dl>
262
198
<dt>5.4.1. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.RECOLLCONF">Main
263
199
configuration file</a></dt>
264
 
 
265
200
<dt>5.4.2. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.FIELDS">The fields
266
201
file</a></dt>
267
 
 
268
202
<dt>5.4.3. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.MIMEMAP">The mimemap
269
203
file</a></dt>
270
 
 
271
204
<dt>5.4.4. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.MIMECONF">The mimeconf
272
205
file</a></dt>
273
 
 
274
206
<dt>5.4.5. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.MIMEVIEW">The mimeview
275
207
file</a></dt>
276
 
 
277
208
<dt>5.4.6. <a href="rcl.install.config.html#RCL.INSTALL.CONFIG.EXAMPLES">Examples of
278
209
configuration adjustments</a></dt>
279
210
</dl>
283
214
</dl>
284
215
</div>
285
216
</div>
286
 
 
287
217
<div class="NAVFOOTER">
288
 
<hr align="LEFT" width="100%" />
 
218
<hr align="left" width="100%" />
289
219
<table summary="Footer navigation table" width="100%" border="0" cellpadding="0"
290
220
cellspacing="0">
291
221
<tr>
292
 
<td width="33%" align="left" valign="top">&nbsp;</td>
293
 
<td width="34%" align="center" valign="top">&nbsp;</td>
294
 
<td width="33%" align="right" valign="top"><a href="rcl.introduction.html"
295
 
accesskey="N">Next</a></td>
 
222
<td width="33%" align="left" valign="top">�</td>
 
223
<td width="34%" align="center" valign="top">�</td>
 
224
<td width="33%" align="right" valign="top"><a href="rcl.introduction.html" accesskey=
 
225
"N">Next</a></td>
296
226
</tr>
297
 
 
298
227
<tr>
299
 
<td width="33%" align="left" valign="top">&nbsp;</td>
300
 
<td width="34%" align="center" valign="top">&nbsp;</td>
 
228
<td width="33%" align="left" valign="top">�</td>
 
229
<td width="34%" align="center" valign="top">�</td>
301
230
<td width="33%" align="right" valign="top">Introduction</td>
302
231
</tr>
303
232
</table>
304
233
</div>
305
234
</body>
306
235
</html>
307