source: gnome/platform/tracker.xml@ d809816

<?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 tracker-download-http
           "&gnome-download-http;/tracker/2.2/tracker-&tracker-version;.tar.xz">
  <!ENTITY tracker-download-ftp
           "&gnome-download-ftp;/tracker/2.2/tracker-&tracker-version;.tar.xz">
  <!ENTITY tracker-md5sum        "e4c637cbc1aa2f4d03e09c8e6b318d6d">
  <!ENTITY tracker-size          "2.7 MB">
  <!ENTITY tracker-buildsize     "211 MB (with tests)">
  <!ENTITY tracker-time          "1.0 SBU (with tests)">
]>

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

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

  <title>Tracker-&tracker-version;</title>

  <indexterm zone="tracker">
    <primary sortas="a-Tracker">Tracker</primary>
  </indexterm>

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

    <para>
      <application>Tracker</application> is the file indexing and search
      provider used in the <application>GNOME</application> desktop environment.
    </para>

    &lfs84_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="json-glib"/>,
      <xref linkend="libseccomp"/>,
      <xref linkend="libsoup"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="icu"/>,
      <xref linkend="NetworkManager"/>,
      <xref linkend="sqlite"/>, and
      <xref linkend="upower"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="python2"/> (for the <quote>functional</quote> tests), and
      <ulink url="https://github.com/snowballstem/snowball/">Snowball</ulink>
    </para>

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

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

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

<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;

meson --prefix=/usr --sysconfdir=/etc .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. The tests
      should be run from a graphical session. Several tests may output an error
      due to the Python 2 module for PyGObject3 not being available.
    </para>

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

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

  </sect2>
<!-- Not needed. D-Bus files get installed in the proper location by default.
  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>- -with-session-bus-services-dir=/usr/share/dbus-1/services</parameter>:
      This switch defines the location of the <xref linkend="dbus"/> service
      directory.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

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

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

      <seglistitem>
        <seg>
          tracker
        </seg>
        <seg>
          libtracker-control.so, libtracker-miner.so, and libtracker-sparql.so
        </seg>
        <seg>
          /usr/{include,lib}/tracker-2.0, /usr/share/tracker, and
          /usr/share/gtk-doc/libtracker-{control,miner,sparql}
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="tracker-prog">
        <term><command>tracker</command></term>
        <listitem>
          <para>
            is a control program for the indexer.
          </para>
          <indexterm zone="tracker tracker-prog">
            <primary sortas="b-tracker">tracker</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtracker-control">
        <term><filename class="libraryfile">libtracker-control.so</filename></term>
        <listitem>
          <para>
            contains control and monitoring functions for miners.
          </para>
          <indexterm zone="tracker libtracker-control">
            <primary sortas="c-libtracker-control">libtracker-control.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtracker-miner">
        <term><filename class="libraryfile">libtracker-miner.so</filename></term>
        <listitem>
          <para>
            contains data mining functions.
          </para>
          <indexterm zone="tracker libtracker-miner">
            <primary sortas="c-libtracker-miner">libtracker-miner.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtracker-sparql">
        <term><filename class="libraryfile">libtracker-sparql.so</filename></term>
        <listitem>
          <para>
            contains resource management and database functions.
          </para>
          <indexterm zone="tracker libtracker-sparql">
            <primary sortas="c-libtracker-sparql">libtracker-sparql.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>