source: general/genlib/xapian.xml@ 1a64240

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY xapian-download-http
           "http://oligarchy.co.uk/xapian/&xapian-version;/xapian-core-&xapian-version;.tar.xz">
  <!ENTITY xapian-download-ftp  " ">
  <!ENTITY xapian-md5sum        "276497a458a8ae63e7dceb372cc1bc37">
  <!ENTITY xapian-size          "3.1 MB">
  <!ENTITY xapian-buildsize     "158 MB (additional 151 MB for tests)">
  <!ENTITY xapian-time          "1.2 SBU (additional 19 SBU for tests)">
]>

<sect1 id="xapian" xreflabel="xapian-&xapian-version;">
  <?dbhtml filename="xapian.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Xapian-&xapian-version;</title>

  <indexterm zone="xapian">
    <primary sortas="a-xapian">xapian</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to xapian</title>

    <para>
      Xapian is an open source search engine library.
    </para>

    &lfs77_checked; &gcc5_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&xapian-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&xapian-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &xapian-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &xapian-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &xapian-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &xapian-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Xapian Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/xapian"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Xapian</title>

    <para>Install <application>Xapian</application> by
    running the following commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --disable-static \
            --docdir=/usr/share/doc/xapian-core-&xapian-version; &amp;&amp;
make</userinput></screen>

    


    <para>
      To run the test suite, issue: <command>make check</command>.
    </para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          copydatabase, delve, quest, simpleexpand, simpleindex, simplesearch,
          xapian-check, xapian-chert-update, xapian-compact, xapian-config,
          xapian-inspect, xapian-metadata, xapian-progsrv, xapian-replicate,
          xapian-replicate-server and xapian-tcpsrv
        </seg>
        <seg>
          libxapian.so
        </seg>
        <seg>
          /usr/include/xapian, 
          /usr/lib/cmake/xapian, and 
          /usr/share/doc/xapian-core-&xapian-version;
        </seg>
      </seglistitem>
    </segmentedlist>
  </sect2>

</sect1>