source: general/genlib/xapian.xml@ 567dc7d8

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 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 nosym 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 567dc7d8 was 567dc7d8, checked in by Bruce Dubbs <bdubbs@…>, 8 years ago

Update to ffmpeg-3.1.
Update to pulseaudio-9.0.
Update to xapian-core-1.4.0.
Update to stunnel-5.33.
Update to sysstat-11.3.5.
Update to libinput-1.3.3.

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