source: archive/gnome/tracker-miners.xml@ 48b59802

<?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-miners-download-http "&gnome-download-http;/tracker-miners/2.3/tracker-miners-&tracker-miners-version;.tar.xz">
  <!ENTITY tracker-miners-download-ftp  "&gnome-download-ftp;/tracker-miners/2.3/tracker-miners-&tracker-miners-version;.tar.xz">
  <!ENTITY tracker-miners-md5sum        "0bbcab133ed33ccbf65923020f99e1cc">
  <!ENTITY tracker-miners-size          "3.0 MB">
  <!ENTITY tracker-miners-buildsize     "28 MB (with tests)">
  <!ENTITY tracker-miners-time          "1.0 SBU (with tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>Tracker-miners</application> package contains a set of
      data extractors for Tracker.
    </para>

    &lfs101_checked;

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="tracker"/>,
      <xref linkend="exempi"/>, and
      <xref linkend="gexiv2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="ffmpeg"/>,
      <xref linkend="flac"/>,
      <xref linkend="giflib"/>,
      <xref linkend="icu"/>,
      <xref linkend="libexif"/>,
      <xref linkend="libgrss"/>,
      <xref linkend="libgxps"/>, and
      <xref linkend="poppler"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="cmake"/>,
      <xref linkend="dconf"/>,
      <xref linkend="libgsf"/>,
      <xref linkend="libseccomp"/>,
      <xref linkend="taglib"/>,
      <xref linkend="totem-pl-parser"/>,
      <xref linkend="upower"/>,
      <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
      <ulink url="https://libosinfo.org">libosinfo</ulink>, and
      <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
    </para>

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

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

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


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

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

    <para>
      To test the results, as the <systemitem class="username">root</systemitem>
      user, issue: <command>ninja test</command>.
      Eight tests, test-image-1, 300-miner-basic-ops, 310-fts-basic,
      310-fts-basic, 311-fts-file-operations, 401-extractor-flac-cuesheet,
      500-writeback-images, 501-writeback-image-details, and
      502-writeback-audio are known to fail due to internal test
      suite problems.
      <!--Two tests, test-image-1 and functional-401-extractor-flac-cuesheet, 
      are known to fail.-->
      <!-- flac cuesheet is due to libcue not being installed. -->
    </para>

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

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

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

    <para>
      <option>-Dminer_rss=false</option>: Use this option if you have not
      installed the recommended dependency libgrss.
    </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>
          libtracker-extract.so, and
          several modules under /usr/lib/tracker-miners-2.0.
        </seg>
        <seg>
          /usr/lib/tracker-miners-2.0 and
          /usr/share/tracker-miners
        </seg>
      </seglistitem>
    </segmentedlist>
  </sect2>

</sect1>