source: general/genlib/clucene.xml@ 7f5a588

<?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 clucene-download-http " ">
  <!ENTITY clucene-download-ftp  " ">
  <!ENTITY clucene-md5sum        " ">
  <!ENTITY clucene-size          "19 MB">
  <!ENTITY clucene-buildsize     "86 MB">
  <!ENTITY clucene-time          "0.8 SBU">
]>

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

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

  <title>CLucene-&clucene-version;</title>

  <indexterm zone="clucene">
    <primary sortas="l-clucene">clucene</primary>
  </indexterm>

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

    <para><application>CLucene</application> is a C++ version of Lucene, a
    high performance text search engine.</para>

    &lfs74_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/clucene-&clucene-version;-contribs_lib-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="git"/> and
      <xref linkend="cmake"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="boost"/>
    </para>

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

  </sect2>

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

    <para>
      Since <application>CLucene</application> developers haven't released any
      tarballs yet, to obtain the source code first clone
      <application>CLucene</application> git repository then checkout the
      &clucene-version; version:
    </para>

<screen><userinput>git clone git://clucene.git.sourceforge.net/gitroot/clucene/clucene &amp;&amp;
cd clucene &amp;&amp;
git checkout tags/clucene-src-&clucene-version;</userinput></screen>

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

<screen><userinput>patch -Np1 -i ../clucene-&clucene-version;-contribs_lib-1.patch &amp;&amp;
mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_CONTRIBS_LIB=ON .. &amp;&amp;
make</userinput></screen>

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

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

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DBUILD_CONTRIBS_LIB=ON</parameter>: This cmake variable
      enables building the CLucene contribs library necessary for running
      applications that use language specific text analyzers like LibreOffice
      for example.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>
          libclucene-contribs-lib.so,
          libclucene-core.so, and
          libclucene-shared.so
        </seg>
        <seg>
          /usr/include/CLucene and
          /usr/lib/CLuceneConfig.cmake
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>