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