1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY xapian-download-http
|
---|
8 | "https://oligarchy.co.uk/xapian/&xapian-version;/xapian-core-&xapian-version;.tar.xz">
|
---|
9 | <!ENTITY xapian-download-ftp " ">
|
---|
10 | <!ENTITY xapian-md5sum "973fe094231c50a76c68f8f29fce4a27">
|
---|
11 | <!ENTITY xapian-size "3.1 MB">
|
---|
12 | <!ENTITY xapian-buildsize "146 MB (add 169 MB for tests)">
|
---|
13 | <!ENTITY xapian-time "0.5 SBU (add 11 SBU for tests; both using parallelism=4)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="xapian" xreflabel="xapian-&xapian-version;">
|
---|
17 | <?dbhtml filename="xapian.html"?>
|
---|
18 |
|
---|
19 |
|
---|
20 | <title>Xapian-&xapian-version;</title>
|
---|
21 |
|
---|
22 | <indexterm zone="xapian">
|
---|
23 | <primary sortas="a-xapian">xapian</primary>
|
---|
24 | </indexterm>
|
---|
25 |
|
---|
26 | <sect2 role="package">
|
---|
27 | <title>Introduction to xapian</title>
|
---|
28 |
|
---|
29 | <para>
|
---|
30 | Xapian is an open source search engine library.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&xapian-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&xapian-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &xapian-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &xapian-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &xapian-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &xapian-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">Xapian Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
72 | <para role="optional">
|
---|
73 | <xref linkend="valgrind"/> (for tests)
|
---|
74 | </para>
|
---|
75 |
|
---|
76 |
|
---|
77 | </sect2>
|
---|
78 |
|
---|
79 | <sect2 role="installation">
|
---|
80 | <title>Installation of Xapian</title>
|
---|
81 | <!-- Interesting footnote - SSE support is only enabled on i686.
|
---|
82 | There seems to be some trickery involved in that. It's not essential
|
---|
83 | to operation on x86_64 though, so look into it at the next version of
|
---|
84 | xapian. -->
|
---|
85 |
|
---|
86 | <para>
|
---|
87 | Install <application>Xapian</application> by
|
---|
88 | running the following commands:
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | <screen><userinput>./configure --prefix=/usr \
|
---|
92 | --disable-static \
|
---|
93 | --docdir=/usr/share/doc/xapian-core-&xapian-version; &&
|
---|
94 | make</userinput></screen>
|
---|
95 |
|
---|
96 | <para>
|
---|
97 | <!--
|
---|
98 | The regression tests are not recommended. On a fast (3.2 GHz i7)
|
---|
99 | system they took over five hours and two of four tests (the valgrind
|
---|
100 | tests) failed. To run the test suite anyway,
|
---|
101 | issue: <command>make check</command>.
|
---|
102 | The tests with 1.4.15 took under an hour, at 34 SBU total. Marking
|
---|
103 | the test suite as usable again. I had four passes and 0 failures:
|
---|
104 | PASS: apitest
|
---|
105 | PASS: internaltest
|
---|
106 | PASS: stemtest
|
---|
107 | PASS: unittest
|
---|
108 | I did have Valgrind installed too. -renodr -->
|
---|
109 | To run the test suite, issue: <command>make check</command>.
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
117 |
|
---|
118 | </sect2>
|
---|
119 |
|
---|
120 | <sect2 role="content">
|
---|
121 | <title>Contents</title>
|
---|
122 |
|
---|
123 | <segmentedlist>
|
---|
124 | <segtitle>Installed Programs</segtitle>
|
---|
125 | <segtitle>Installed Libraries</segtitle>
|
---|
126 | <segtitle>Installed Directories</segtitle>
|
---|
127 |
|
---|
128 | <seglistitem>
|
---|
129 | <seg>
|
---|
130 | copydatabase, quest, simpleexpand, simpleindex, simplesearch,
|
---|
131 | xapian-check, xapian-compact, xapian-config,
|
---|
132 | xapian-delve, xapian-metadata, xapian-pos, xapian-progsrv,
|
---|
133 | xapian-replicate, xapian-replicate-server and xapian-tcpsrv
|
---|
134 | </seg>
|
---|
135 | <seg>
|
---|
136 | libxapian.so
|
---|
137 | </seg>
|
---|
138 | <seg>
|
---|
139 | /usr/include/xapian,
|
---|
140 | /usr/lib/cmake/xapian,
|
---|
141 | /usr/share/doc/xapian-core-&xapian-version;, and
|
---|
142 | /usr/share/xapian-core
|
---|
143 | </seg>
|
---|
144 | </seglistitem>
|
---|
145 | </segmentedlist>
|
---|
146 |
|
---|
147 | <variablelist>
|
---|
148 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
149 | <?dbfo list-presentation="list"?>
|
---|
150 | <?dbhtml list-presentation="table"?>
|
---|
151 |
|
---|
152 | <varlistentry id="copydatabase">
|
---|
153 | <term><command>copydatabase</command></term>
|
---|
154 | <listitem>
|
---|
155 | <para>
|
---|
156 | performs a document-by-document copy of one or more
|
---|
157 | <application>Xapian</application> databases
|
---|
158 | </para>
|
---|
159 | <indexterm zone="xapian copydatabase">
|
---|
160 | <primary sortas="b-copydatabase">copydatabase</primary>
|
---|
161 | </indexterm>
|
---|
162 | </listitem>
|
---|
163 | </varlistentry>
|
---|
164 |
|
---|
165 | <varlistentry id="quest">
|
---|
166 | <term><command>quest</command></term>
|
---|
167 | <listitem>
|
---|
168 | <para>
|
---|
169 | is a command line tool to search through a database
|
---|
170 | </para>
|
---|
171 | <indexterm zone="xapian quest">
|
---|
172 | <primary sortas="b-quest">quest</primary>
|
---|
173 | </indexterm>
|
---|
174 | </listitem>
|
---|
175 | </varlistentry>
|
---|
176 |
|
---|
177 | <varlistentry id="simpleexpand">
|
---|
178 | <term><command>simpleexpand</command></term>
|
---|
179 | <listitem>
|
---|
180 | <para>
|
---|
181 | is a simple example program demonstrating query expansion
|
---|
182 | </para>
|
---|
183 | <indexterm zone="xapian simpleexpand">
|
---|
184 | <primary sortas="b-simpleexpand">simpleexpand</primary>
|
---|
185 | </indexterm>
|
---|
186 | </listitem>
|
---|
187 | </varlistentry>
|
---|
188 |
|
---|
189 | <varlistentry id="simpleindex">
|
---|
190 | <term><command>simpleindex</command></term>
|
---|
191 | <listitem>
|
---|
192 | <para>
|
---|
193 | indexes each paragraph of a text file as a
|
---|
194 | <application>Xapian</application> document
|
---|
195 | </para>
|
---|
196 | <indexterm zone="xapian simpleindex">
|
---|
197 | <primary sortas="b-simpleindex">simpleindex</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | <varlistentry id="simplesearch">
|
---|
203 | <term><command>simplesearch</command></term>
|
---|
204 | <listitem>
|
---|
205 | <para>
|
---|
206 | is a simple command line search utility
|
---|
207 | </para>
|
---|
208 | <indexterm zone="xapian simplesearch">
|
---|
209 | <primary sortas="b-simplesearch">simplesearch</primary>
|
---|
210 | </indexterm>
|
---|
211 | </listitem>
|
---|
212 | </varlistentry>
|
---|
213 |
|
---|
214 | <varlistentry id="xapian-check">
|
---|
215 | <term><command>xapian-check</command></term>
|
---|
216 | <listitem>
|
---|
217 | <para>
|
---|
218 | checks the consistency of a database or table
|
---|
219 | </para>
|
---|
220 | <indexterm zone="xapian xapian-check">
|
---|
221 | <primary sortas="b-xapian-check">xapian-check</primary>
|
---|
222 | </indexterm>
|
---|
223 | </listitem>
|
---|
224 | </varlistentry>
|
---|
225 |
|
---|
226 | <!--
|
---|
227 | <varlistentry id="xapian-chert-update">
|
---|
228 | <term><command>xapian-chert-update</command></term>
|
---|
229 | <listitem>
|
---|
230 | <para>
|
---|
231 | update a chert database to the new format keys.
|
---|
232 | </para>
|
---|
233 | <indexterm zone="xapian xapian-chert-update">
|
---|
234 | <primary sortas="b-xapian-chert-update">xapian-chert-update</primary>
|
---|
235 | </indexterm>
|
---|
236 | </listitem>
|
---|
237 | </varlistentry>
|
---|
238 | No longer installed in 1.4.15. - renodr
|
---|
239 | -->
|
---|
240 |
|
---|
241 | <varlistentry id="xapian-compact">
|
---|
242 | <term><command>xapian-compact</command></term>
|
---|
243 | <listitem>
|
---|
244 | <para>
|
---|
245 | compacts a database, or merges and compacts several databases
|
---|
246 | </para>
|
---|
247 | <indexterm zone="xapian xapian-compact">
|
---|
248 | <primary sortas="b-xapian-compact">xapian-compact</primary>
|
---|
249 | </indexterm>
|
---|
250 | </listitem>
|
---|
251 | </varlistentry>
|
---|
252 |
|
---|
253 | <varlistentry id="xapian-config">
|
---|
254 | <term><command>xapian-config</command></term>
|
---|
255 | <listitem>
|
---|
256 | <para>
|
---|
257 | reports information about the installed version of xapian
|
---|
258 | </para>
|
---|
259 | <indexterm zone="xapian xapian-config">
|
---|
260 | <primary sortas="b-xapian-config">xapian-config</primary>
|
---|
261 | </indexterm>
|
---|
262 | </listitem>
|
---|
263 | </varlistentry>
|
---|
264 |
|
---|
265 | <varlistentry id="xapian-delve">
|
---|
266 | <term><command>xapian-delve</command></term>
|
---|
267 | <listitem>
|
---|
268 | <para>
|
---|
269 | inspects the contents of a <application>Xapian</application>
|
---|
270 | database
|
---|
271 | </para>
|
---|
272 | <indexterm zone="xapian xapian-delve">
|
---|
273 | <primary sortas="b-xapian-delve">xapian-delve</primary>
|
---|
274 | </indexterm>
|
---|
275 | </listitem>
|
---|
276 | </varlistentry>
|
---|
277 |
|
---|
278 | <varlistentry id="xapian-metadata">
|
---|
279 | <term><command>xapian-metadata</command></term>
|
---|
280 | <listitem>
|
---|
281 | <para>
|
---|
282 | reads and writes user metadata
|
---|
283 | </para>
|
---|
284 | <indexterm zone="xapian xapian-metadata">
|
---|
285 | <primary sortas="b-xapian-metadata">xapian-metadata</primary>
|
---|
286 | </indexterm>
|
---|
287 | </listitem>
|
---|
288 | </varlistentry>
|
---|
289 |
|
---|
290 | <varlistentry id="xapian-pos">
|
---|
291 | <term><command>xapian-pos</command></term>
|
---|
292 | <listitem>
|
---|
293 | <para>
|
---|
294 | inspects the contents of a flint table for development or debugging
|
---|
295 | </para>
|
---|
296 | <indexterm zone="xapian xapian-pos">
|
---|
297 | <primary sortas="b-xapian-pos">xapian-pos</primary>
|
---|
298 | </indexterm>
|
---|
299 | </listitem>
|
---|
300 | </varlistentry>
|
---|
301 |
|
---|
302 | <varlistentry id="xapian-progsrv">
|
---|
303 | <term><command>xapian-progsrv</command></term>
|
---|
304 | <listitem>
|
---|
305 | <para>
|
---|
306 | is a remote server for use with <application>ProgClient</application>
|
---|
307 | </para>
|
---|
308 | <indexterm zone="xapian xapian-progsrv">
|
---|
309 | <primary sortas="b-xapian-progsrv">xapian-progsrv</primary>
|
---|
310 | </indexterm>
|
---|
311 | </listitem>
|
---|
312 | </varlistentry>
|
---|
313 |
|
---|
314 | <varlistentry id="xapian-replicate">
|
---|
315 | <term><command>xapian-replicate</command></term>
|
---|
316 | <listitem>
|
---|
317 | <para>
|
---|
318 | replicates a database from a master server to a local copy
|
---|
319 | </para>
|
---|
320 | <indexterm zone="xapian xapian-replicate">
|
---|
321 | <primary sortas="b-xapian-replicate">xapian-replicate</primary>
|
---|
322 | </indexterm>
|
---|
323 | </listitem>
|
---|
324 | </varlistentry>
|
---|
325 |
|
---|
326 | <varlistentry id="xapian-replicate-server">
|
---|
327 | <term><command>xapian-replicate-server</command></term>
|
---|
328 | <listitem>
|
---|
329 | <para>
|
---|
330 | services database replication requests from clients
|
---|
331 | </para>
|
---|
332 | <indexterm zone="xapian xapian-replicate-server">
|
---|
333 | <primary sortas="b-xapian-replicate-server">xapian-replicate-server</primary>
|
---|
334 | </indexterm>
|
---|
335 | </listitem>
|
---|
336 | </varlistentry>
|
---|
337 |
|
---|
338 | <varlistentry id="xapian-tcpsrv">
|
---|
339 | <term><command>xapian-tcpsrv</command></term>
|
---|
340 | <listitem>
|
---|
341 | <para>
|
---|
342 | is the TCP daemon for use with <application>Xapian</application>'s
|
---|
343 | remote backend
|
---|
344 | </para>
|
---|
345 | <indexterm zone="xapian xapian-tcpsrv">
|
---|
346 | <primary sortas="b-xapian-tcpsrv">xapian-tcpsrv</primary>
|
---|
347 | </indexterm>
|
---|
348 | </listitem>
|
---|
349 | </varlistentry>
|
---|
350 |
|
---|
351 | </variablelist>
|
---|
352 |
|
---|
353 | </sect2>
|
---|
354 |
|
---|
355 | </sect1>
|
---|