source: general/genlib/xapian.xml@ cf193634

systemd-13485
Last change on this file since cf193634 was ac38e9dc, checked in by Douglas R. Reno <renodr@…>, 9 years ago

Import back into SVN from Github

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