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