BOOK/gnome/platform/tracker3-miners.xml

   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 tracker3-miners-download-http "&gnome-download-http;/tracker-miners/3.1/tracker-miners-&tracker3-miners-version;.tar.xz">
   8   <!ENTITY tracker3-miners-download-ftp  "&gnome-download-ftp;/tracker-miners/3.1/tracker-miners-&tracker3-miners-version;.tar.xz">
   9   <!ENTITY tracker3-miners-md5sum        "93e1f45dee14826c0cbcd25a14feebde">
  10   <!ENTITY tracker3-miners-size          "3.9 MB">
  11   <!ENTITY tracker3-miners-buildsize     "44 MB (with tests)">
  12   <!ENTITY tracker3-miners-time          "1.0 SBU (with tests)">
  13 ]>
  14
  15 <sect1 id="tracker3-miners" xreflabel="tracker-miners-&tracker3-miners-version;">
  16   <?dbhtml filename="tracker3-miners.html"?>
  17
  18   <sect1info>
  19     <othername>$LastChangedBy$</othername>
  20     <date>$Date$</date>
  21   </sect1info>
  22
  23   <title>Tracker-miners-&tracker3-miners-version;</title>
  24
  25   <indexterm zone="tracker3-miners">
  26     <primary sortas="a-tracker3-miners">tracker3-miners</primary>
  27   </indexterm>
  28
  29   <sect2 role="package">
  30     <title>Introduction to Tracker-miners</title>
  31
  32     <para>
  33       The <application>Tracker-miners</application> package contains a set of
  34       data extractors for Tracker.
  35     </para>
  36
  37     &lfs101_checked;
  38
  39     <bridgehead renderas="sect3">Package Information</bridgehead>
  40     <itemizedlist spacing="compact">
  41       <listitem>
  42         <para>
  43           Download (HTTP): <ulink url="&tracker3-miners-download-http;"/>
  44         </para>
  45       </listitem>
  46       <listitem>
  47         <para>
  48           Download (FTP): <ulink url="&tracker3-miners-download-ftp;"/>
  49         </para>
  50       </listitem>
  51       <listitem>
  52         <para>
  53           Download MD5 sum: &tracker3-miners-md5sum;
  54         </para>
  55       </listitem>
  56       <listitem>
  57         <para>
  58           Download size: &tracker3-miners-size;
  59         </para>
  60       </listitem>
  61       <listitem>
  62         <para>
  63           Estimated disk space required: &tracker3-miners-buildsize;
  64         </para>
  65       </listitem>
  66       <listitem>
  67         <para>
  68           Estimated build time: &tracker3-miners-time;
  69         </para>
  70       </listitem>
  71     </itemizedlist>
  72
  73     <bridgehead renderas="sect3">Tracker-miners Dependencies</bridgehead>
  74
  75     <bridgehead renderas="sect4">Required</bridgehead>
  76     <para role="required">
  77       <xref linkend="gst10-plugins-base"/>,
  78       <xref linkend="tracker3"/>,
  79       <xref linkend="exempi"/>, and
  80       <xref linkend="gexiv2"/>
  81     </para>
  82
  83     <bridgehead renderas="sect4">Recommended</bridgehead>
  84     <para role="recommended">
  85       <xref linkend="ffmpeg"/>,
  86       <xref linkend="giflib"/>,
  87       <xref linkend="icu"/>,
  88       <xref linkend="libexif"/>,
  89       <xref linkend="libgrss"/>,
  90       <xref linkend="libgxps"/>, and
  91       <xref linkend="poppler"/>
  92     </para>
  93
  94     <bridgehead renderas="sect4">Optional</bridgehead>
  95     <para role="optional">
  96       <xref linkend="asciidoc"/>,
  97       <xref linkend="cmake"/>,
  98       <xref linkend="dconf"/>,
  99       <xref linkend="libgsf"/>,
 100       <xref linkend="libseccomp"/>,
 101       <xref linkend="taglib"/>,
 102       <xref linkend="totem-pl-parser"/>,
 103       <xref linkend="upower"/>,
 104       <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
 105       <ulink url="http://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
 106       <ulink url="https://libosinfo.org">libosinfo</ulink>
 107       <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>, and
 108       <ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
 109       (for tests)
 110     </para>
 111
 112     <para condition="html" role="usernotes">
 113       User Notes: <ulink url="&blfs-wiki;/tracker-miners"/>
 114     </para>
 115   </sect2>
 116
 117   <sect2 role="installation">
 118     <title>Installation of Tracker-miners</title>
 119
 120     <para>
 121       First, as the <systemitem class="username">root</systemitem> user,
 122       remove some files from tracker-2 which will conflict with
 123       tracker-miners-3:
 124     </para>
 125
 126 <screen role="root"><userinput remap="pre">rm -v /etc/xdg/autostart/tracker-miner-*</userinput></screen>
 127
 128     <para>
 129       Install <application>Tracker-miners</application> by running the following
 130       commands:
 131     </para>
 132
 133
 134 <screen revision="systemd"><userinput>mkdir build &amp;&amp;
 135 cd    build &amp;&amp;
 136
 137 meson --prefix=/usr -Dman=false .. &amp;&amp;
 138 ninja</userinput></screen>
 139
 140 <screen revision="sysv"><userinput>mkdir build &amp;&amp;
 141 cd    build &amp;&amp;
 142
 143 meson --prefix=/usr -Dsystemd_user_services=false -Dman=false .. &amp;&amp;
 144 ninja</userinput></screen>
 145
 146     <para>
 147       To test the results, as the <systemitem class="username">root</systemitem>
 148       user, issue: <command>ninja test</command>.  38 tests will fail if the
 149       Python 3 module tap.py is not installed.
 150     </para>
 151
 152     <para>
 153       Now, as the <systemitem class="username">root</systemitem> user:
 154     </para>
 155
 156 <screen role="root"><userinput>ninja install</userinput></screen>
 157   </sect2>
 158
 159   <sect2 role="commands">
 160     <title>Command Explanations</title>
 161
 162     <para>
 163       <parameter>-Dman=false</parameter>: This switch prevents the build process
 164       from generating man pages. Omit this switch if you have
 165       <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
 166       install the man pages.
 167     </para>
 168
 169     <para revision="sysv">
 170       <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
 171       the build process from installing systemd units since they are useless
 172       on SysV systems.
 173     </para>
 174
 175     <para>
 176       <option>-Dminer_rss=false</option>: Use this option if you have not
 177       installed the recommended dependency libgrss.
 178     </para>
 179
 180   </sect2>
 181
 182   <sect2 role="content">
 183     <title>Contents</title>
 184
 185     <segmentedlist>
 186       <segtitle>Installed Programs</segtitle>
 187       <segtitle>Installed Libraries</segtitle>
 188       <segtitle>Installed Directories</segtitle>
 189
 190       <seglistitem>
 191         <seg>
 192           None
 193         </seg>
 194         <seg>
 195           Several modules under /usr/lib/tracker-miners-3.0.
 196         </seg>
 197         <seg>
 198           /usr/lib/tracker-miners-3.0,
 199           /usr/libexec/tracker3, and
 200           /usr/share/tracker3-miners
 201         </seg>
 202       </seglistitem>
 203     </segmentedlist>
 204   </sect2>
 205
 206 </sect1>