source: general/genlib/xapian.xml@ d373629

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since d373629 was d373629, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Update to xapian-core-1.4.2.
Update to Python-3.6.0.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18116 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 "cd7615e14a87a033cee2993a016edc43">
11 <!ENTITY xapian-size "2.7 MB">
12 <!ENTITY xapian-buildsize "120 MB (add 113 MB for tests)">
13 <!ENTITY xapian-time "1.7 SBU (add 26 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 &lfs7a_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"/> (for tests)
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 \
80 --disable-static \
81 --docdir=/usr/share/doc/xapian-core-&xapian-version; &amp;&amp;
82make</userinput></screen>
83
84 <para>
85 To run the test suite, issue: <command>make check</command>.
86 Several tests based on valgrind fail.
87 </para>
88
89 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
90
91<screen role="root"><userinput>make install</userinput></screen>
92
93 </sect2>
94
95 <sect2 role="content">
96 <title>Contents</title>
97
98 <segmentedlist>
99 <segtitle>Installed Programs</segtitle>
100 <segtitle>Installed Libraries</segtitle>
101 <segtitle>Installed Directories</segtitle>
102
103 <seglistitem>
104 <seg>
105 copydatabase, delve, quest, simpleexpand, simpleindex, simplesearch,
106 xapian-check, xapian-chert-update, xapian-compact, xapian-config,
107 xapian-inspect, xapian-metadata, xapian-progsrv, xapian-replicate,
108 xapian-replicate-server and xapian-tcpsrv
109 </seg>
110 <seg>
111 libxapian.so
112 </seg>
113 <seg>
114 /usr/include/xapian,
115 /usr/lib/cmake/xapian, and
116 /usr/share/doc/xapian-core-&xapian-version;
117 </seg>
118 </seglistitem>
119 </segmentedlist>
120
121 <variablelist>
122 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
123 <?dbfo list-presentation="list"?>
124 <?dbhtml list-presentation="table"?>
125
126 <varlistentry id="copydatabase">
127 <term><command>copydatabase</command></term>
128 <listitem>
129 <para>
130 perform a document-by-document copy of one or more
131 <application>Xapian</application> databases.
132 </para>
133 <indexterm zone="xapian copydatabase">
134 <primary sortas="b-copydatabase">copydatabase</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138
139 <varlistentry id="delve">
140 <term><command>delve</command></term>
141 <listitem>
142 <para>
143 inspect the contents of a <application>Xapian</application>
144 database.
145 </para>
146 <indexterm zone="xapian delve">
147 <primary sortas="b-delve">delve</primary>
148 </indexterm>
149 </listitem>
150 </varlistentry>
151
152 <varlistentry id="quest">
153 <term><command>quest</command></term>
154 <listitem>
155 <para>
156 is a search command line tool.
157 </para>
158 <indexterm zone="xapian quest">
159 <primary sortas="b-quest">quest</primary>
160 </indexterm>
161 </listitem>
162 </varlistentry>
163
164 <varlistentry id="simpleexpand">
165 <term><command>simpleexpand</command></term>
166 <listitem>
167 <para>
168 is a simple example program demonstrating query expansion.
169 </para>
170 <indexterm zone="xapian simpleexpand">
171 <primary sortas="b-simpleexpand">simpleexpand</primary>
172 </indexterm>
173 </listitem>
174 </varlistentry>
175
176 <varlistentry id="simpleindex">
177 <term><command>simpleindex</command></term>
178 <listitem>
179 <para>
180 index each paragraph of a text file as a
181 <application>Xapian</application> document.
182 </para>
183 <indexterm zone="xapian simpleindex">
184 <primary sortas="b-simpleindex">simpleindex</primary>
185 </indexterm>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry id="simplesearch">
190 <term><command>simplesearch</command></term>
191 <listitem>
192 <para>
193 is a simple command line search utility.
194 </para>
195 <indexterm zone="xapian simplesearch">
196 <primary sortas="b-simplesearch">simplesearch</primary>
197 </indexterm>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry id="xapian-check">
202 <term><command>xapian-check</command></term>
203 <listitem>
204 <para>
205 check the consistency of a database or table.
206 </para>
207 <indexterm zone="xapian xapian-check">
208 <primary sortas="b-xapian-check">xapian-check</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="xapian-chert-update">
214 <term><command>xapian-chert-update</command></term>
215 <listitem>
216 <para>
217 update a chert database to the new format keys.
218 </para>
219 <indexterm zone="xapian xapian-chert-update">
220 <primary sortas="b-xapian-chert-update">xapian-chert-update</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="xapian-compact">
226 <term><command>xapian-compact</command></term>
227 <listitem>
228 <para>
229 compact a database, or merge and compact several.
230 </para>
231 <indexterm zone="xapian xapian-compact">
232 <primary sortas="b-xapian-compact">xapian-compact</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="xapian-config">
238 <term><command>xapian-config</command></term>
239 <listitem>
240 <para>
241 report information about the installed xapian.
242 </para>
243 <indexterm zone="xapian xapian-config">
244 <primary sortas="b-xapian-config">xapian-config</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="xapian-inspect">
250 <term><command>xapian-inspect</command></term>
251 <listitem>
252 <para>
253 inspect the contents of a flint table for development or debugging.
254 </para>
255 <indexterm zone="xapian xapian-inspect">
256 <primary sortas="b-xapian-inspect">xapian-inspect</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="xapian-metadata">
262 <term><command>xapian-metadata</command></term>
263 <listitem>
264 <para>
265 read and write user metadata.
266 </para>
267 <indexterm zone="xapian xapian-metadata">
268 <primary sortas="b-xapian-metadata">xapian-metadata</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="xapian-progsrv">
274 <term><command>xapian-progsrv</command></term>
275 <listitem>
276 <para>
277 remote server for use with <application>ProgClient</application>.
278 </para>
279 <indexterm zone="xapian xapian-progsrv">
280 <primary sortas="b-xapian-progsrv">xapian-progsrv</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="xapian-replicate">
286 <term><command>xapian-replicate</command></term>
287 <listitem>
288 <para>
289 replicate a database from a master server to a local copy.
290 </para>
291 <indexterm zone="xapian xapian-replicate">
292 <primary sortas="b-xapian-replicate">xapian-replicate</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="xapian-replicate-server">
298 <term><command>xapian-replicate-server</command></term>
299 <listitem>
300 <para>
301 service database replication requests from clients.
302 </para>
303 <indexterm zone="xapian xapian-replicate-server">
304 <primary sortas="b-xapian-replicate-server">xapian-replicate-server</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="xapian-tcpsrv">
310 <term><command>xapian-tcpsrv</command></term>
311 <listitem>
312 <para>
313 is the TCP daemon for use with <application>Xapian</application>'s
314 remote backend.
315 </para>
316 <indexterm zone="xapian xapian-tcpsrv">
317 <primary sortas="b-xapian-tcpsrv">xapian-tcpsrv</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 </variablelist>
323
324 </sect2>
325
326</sect1>
Note: See TracBrowser for help on using the repository browser.