source: general/genlib/xapian.xml@ 13d0d6f

10.0 10.1 11.0 7.10 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 13d0d6f was 13d0d6f, checked in by Fernando de Oliveira <fernando@…>, 6 years ago
  • Update to firefox-43.0.3.
  • Update to audacious-3.7.1, audacious-plugins-3.7.1.
  • Update to xapian-core-1.2.22.
  • Update to wireshark-2.0.1.
  • Update to doxygen-1.8.11.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16772 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 10.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 "http://oligarchy.co.uk/xapian/&xapian-version;/xapian-core-&xapian-version;.tar.xz">
9 <!ENTITY xapian-download-ftp " ">
10 <!ENTITY xapian-md5sum "09c59290aa8f6b4ea73c3788636e44a5">
11 <!ENTITY xapian-size "3.1 MB">
12 <!ENTITY xapian-buildsize "189 MB (additional 128 MB for tests)">
13 <!ENTITY xapian-time "1.2 SBU (additional 20 SBU for tests)">
14]>
15
16<sect1 id="xapian" xreflabel="xapian-&xapian-version;">
17 <?dbhtml filename="xapian.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Xapian-&xapian-version;</title>
25
26 <indexterm zone="xapian">
27 <primary sortas="a-xapian">xapian</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to xapian</title>
32
33 <para>
34 Xapian is an open source search engine library.
35 </para>
36
37 &lfs78_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download (HTTP): <ulink url="&xapian-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&xapian-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &xapian-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &xapian-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &xapian-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &xapian-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">Xapian Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Optional</bridgehead>
64 <para role="optional">
65 <xref linkend="valgrind"/>
66 </para>
67
68 <para condition="html" role="usernotes">User Notes:
69 <ulink url="&blfs-wiki;/xapian"/></para>
70
71 </sect2>
72
73 <sect2 role="installation">
74 <title>Installation of Xapian</title>
75
76 <para>Install <application>Xapian</application> by
77 running the following commands:</para>
78
79<screen><userinput>./configure --prefix=/usr --disable-static \
80 --docdir=/usr/share/doc/xapian-core-&xapian-version; &amp;&amp;
81make</userinput></screen>
82
83
84
85
86 <para>
87 To run the test suite, issue: <command>make check</command>.
88 </para>
89
90 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
91
92<screen role="root"><userinput>make install</userinput></screen>
93
94 </sect2>
95
96 <sect2 role="content">
97 <title>Contents</title>
98
99 <segmentedlist>
100 <segtitle>Installed Programs</segtitle>
101 <segtitle>Installed Libraries</segtitle>
102 <segtitle>Installed Directories</segtitle>
103
104 <seglistitem>
105 <seg>
106 copydatabase, delve, quest, simpleexpand, simpleindex, simplesearch,
107 xapian-check, xapian-chert-update, xapian-compact, xapian-config,
108 xapian-inspect, xapian-metadata, xapian-progsrv, xapian-replicate,
109 xapian-replicate-server and xapian-tcpsrv
110 </seg>
111 <seg>
112 libxapian.so
113 </seg>
114 <seg>
115 /usr/include/xapian,
116 /usr/lib/cmake/xapian, and
117 /usr/share/doc/xapian-core-&xapian-version;
118 </seg>
119 </seglistitem>
120 </segmentedlist>
121
122 <variablelist>
123 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
124 <?dbfo list-presentation="list"?>
125 <?dbhtml list-presentation="table"?>
126
127 <varlistentry id="copydatabase">
128 <term><command>copydatabase</command></term>
129 <listitem>
130 <para>
131 perform a document-by-document copy of one or more
132 <application>Xapian</application> databases.
133 </para>
134 <indexterm zone="xapian copydatabase">
135 <primary sortas="b-copydatabase">copydatabase</primary>
136 </indexterm>
137 </listitem>
138 </varlistentry>
139
140 <varlistentry id="delve">
141 <term><command>delve</command></term>
142 <listitem>
143 <para>
144 inspect the contents of a <application>Xapian</application>
145 database.
146 </para>
147 <indexterm zone="xapian delve">
148 <primary sortas="b-delve">delve</primary>
149 </indexterm>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry id="quest">
154 <term><command>quest</command></term>
155 <listitem>
156 <para>
157 is a search command line tool.
158 </para>
159 <indexterm zone="xapian quest">
160 <primary sortas="b-quest">quest</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="simpleexpand">
166 <term><command>simpleexpand</command></term>
167 <listitem>
168 <para>
169 is a simple example program demonstrating query expansion.
170 </para>
171 <indexterm zone="xapian simpleexpand">
172 <primary sortas="b-simpleexpand">simpleexpand</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry>
176
177 <varlistentry id="simpleindex">
178 <term><command>simpleindex</command></term>
179 <listitem>
180 <para>
181 index each paragraph of a text file as a
182 <application>Xapian</application> document.
183 </para>
184 <indexterm zone="xapian simpleindex">
185 <primary sortas="b-simpleindex">simpleindex</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
190 <varlistentry id="simplesearch">
191 <term><command>simplesearch</command></term>
192 <listitem>
193 <para>
194 is a simple command line search utility.
195 </para>
196 <indexterm zone="xapian simplesearch">
197 <primary sortas="b-simplesearch">simplesearch</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="xapian-check">
203 <term><command>xapian-check</command></term>
204 <listitem>
205 <para>
206 check the consistency of a database or table.
207 </para>
208 <indexterm zone="xapian xapian-check">
209 <primary sortas="b-xapian-check">xapian-check</primary>
210 </indexterm>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry id="xapian-chert-update">
215 <term><command>xapian-chert-update</command></term>
216 <listitem>
217 <para>
218 update a chert database to the new format keys.
219 </para>
220 <indexterm zone="xapian xapian-chert-update">
221 <primary sortas="b-xapian-chert-update">xapian-chert-update</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="xapian-compact">
227 <term><command>xapian-compact</command></term>
228 <listitem>
229 <para>
230 compact a database, or merge and compact several.
231 </para>
232 <indexterm zone="xapian xapian-compact">
233 <primary sortas="b-xapian-compact">xapian-compact</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="xapian-config">
239 <term><command>xapian-config</command></term>
240 <listitem>
241 <para>
242 report information about the installed xapian.
243 </para>
244 <indexterm zone="xapian xapian-config">
245 <primary sortas="b-xapian-config">xapian-config</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="xapian-inspect">
251 <term><command>xapian-inspect</command></term>
252 <listitem>
253 <para>
254 inspect the contents of a flint table for development or debugging.
255 </para>
256 <indexterm zone="xapian xapian-inspect">
257 <primary sortas="b-xapian-inspect">xapian-inspect</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="xapian-metadata">
263 <term><command>xapian-metadata</command></term>
264 <listitem>
265 <para>
266 read and write user metadata.
267 </para>
268 <indexterm zone="xapian xapian-metadata">
269 <primary sortas="b-xapian-metadata">xapian-metadata</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="xapian-progsrv">
275 <term><command>xapian-progsrv</command></term>
276 <listitem>
277 <para>
278 remote server for use with <application>ProgClient</application>.
279 </para>
280 <indexterm zone="xapian xapian-progsrv">
281 <primary sortas="b-xapian-progsrv">xapian-progsrv</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="xapian-replicate">
287 <term><command>xapian-replicate</command></term>
288 <listitem>
289 <para>
290 replicate a database from a master server to a local copy.
291 </para>
292 <indexterm zone="xapian xapian-replicate">
293 <primary sortas="b-xapian-replicate">xapian-replicate</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="xapian-replicate-server">
299 <term><command>xapian-replicate-server</command></term>
300 <listitem>
301 <para>
302 service database replication requests from clients.
303 </para>
304 <indexterm zone="xapian xapian-replicate-server">
305 <primary sortas="b-xapian-replicate-server">xapian-replicate-server</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="xapian-tcpsrv">
311 <term><command>xapian-tcpsrv</command></term>
312 <listitem>
313 <para>
314 is the TCP daemon for use with <application>Xapian</application>'s
315 remote backend.
316 </para>
317 <indexterm zone="xapian xapian-tcpsrv">
318 <primary sortas="b-xapian-tcpsrv">xapian-tcpsrv</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 </variablelist>
324
325 </sect2>
326
327</sect1>
Note: See TracBrowser for help on using the repository browser.