| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 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.7/tracker-miners-&tracker3-miners-version;.tar.xz">
|
|---|
| 8 | <!ENTITY tracker3-miners-download-ftp " ">
|
|---|
| 9 | <!ENTITY tracker3-miners-md5sum "fc47e13aebbcbe002cfd07980d0cde46">
|
|---|
| 10 | <!ENTITY tracker3-miners-size "7.2 MB">
|
|---|
| 11 | <!ENTITY tracker3-miners-buildsize "38 MB (with tests)">
|
|---|
| 12 | <!ENTITY tracker3-miners-time "0.3 SBU (with parallelism=4; add as much as 1.0 SBU for tests, dependent on disk speed)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="tracker3-miners" xreflabel="tracker-miners-&tracker3-miners-version;">
|
|---|
| 16 | <?dbhtml filename="tracker3-miners.html"?>
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | <title>Tracker-miners-&tracker3-miners-version;</title>
|
|---|
| 20 |
|
|---|
| 21 | <indexterm zone="tracker3-miners">
|
|---|
| 22 | <primary sortas="a-tracker3-miners">tracker3-miners</primary>
|
|---|
| 23 | </indexterm>
|
|---|
| 24 |
|
|---|
| 25 | <sect2 role="package">
|
|---|
| 26 | <title>Introduction to Tracker-miners</title>
|
|---|
| 27 |
|
|---|
| 28 | <para>
|
|---|
| 29 | The <application>Tracker-miners</application> package contains a set of
|
|---|
| 30 | data extractors for Tracker.
|
|---|
| 31 | </para>
|
|---|
| 32 |
|
|---|
| 33 | &lfs121_checked;
|
|---|
| 34 |
|
|---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 36 | <itemizedlist spacing="compact">
|
|---|
| 37 | <listitem>
|
|---|
| 38 | <para>
|
|---|
| 39 | Download (HTTP): <ulink url="&tracker3-miners-download-http;"/>
|
|---|
| 40 | </para>
|
|---|
| 41 | </listitem>
|
|---|
| 42 | <listitem>
|
|---|
| 43 | <para>
|
|---|
| 44 | Download (FTP): <ulink url="&tracker3-miners-download-ftp;"/>
|
|---|
| 45 | </para>
|
|---|
| 46 | </listitem>
|
|---|
| 47 | <listitem>
|
|---|
| 48 | <para>
|
|---|
| 49 | Download MD5 sum: &tracker3-miners-md5sum;
|
|---|
| 50 | </para>
|
|---|
| 51 | </listitem>
|
|---|
| 52 | <listitem>
|
|---|
| 53 | <para>
|
|---|
| 54 | Download size: &tracker3-miners-size;
|
|---|
| 55 | </para>
|
|---|
| 56 | </listitem>
|
|---|
| 57 | <listitem>
|
|---|
| 58 | <para>
|
|---|
| 59 | Estimated disk space required: &tracker3-miners-buildsize;
|
|---|
| 60 | </para>
|
|---|
| 61 | </listitem>
|
|---|
| 62 | <listitem>
|
|---|
| 63 | <para>
|
|---|
| 64 | Estimated build time: &tracker3-miners-time;
|
|---|
| 65 | </para>
|
|---|
| 66 | </listitem>
|
|---|
| 67 | </itemizedlist>
|
|---|
| 68 |
|
|---|
| 69 | <!--
|
|---|
| 70 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 71 | <itemizedlist spacing="compact">
|
|---|
| 72 | <listitem>
|
|---|
| 73 | <para>
|
|---|
| 74 | Required patch:
|
|---|
| 75 | <ulink url="&patch-root;/tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch"/>
|
|---|
| 76 | </para>
|
|---|
| 77 | </listitem>
|
|---|
| 78 | </itemizedlist>
|
|---|
| 79 | -->
|
|---|
| 80 |
|
|---|
| 81 | <bridgehead renderas="sect3">Tracker-miners Dependencies</bridgehead>
|
|---|
| 82 |
|
|---|
| 83 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 84 | <para role="required">
|
|---|
| 85 | <xref linkend="gst10-plugins-base"/>,
|
|---|
| 86 | <xref linkend="tracker3"/>,
|
|---|
| 87 | <xref linkend="exempi"/>, and
|
|---|
| 88 | <xref linkend="gexiv2"/>
|
|---|
| 89 | </para>
|
|---|
| 90 |
|
|---|
| 91 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 92 | <para role="recommended">
|
|---|
| 93 | <xref linkend="giflib"/>,
|
|---|
| 94 | <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
|
|---|
| 95 | <xref role='runtime' linkend="gst10-libav"/> (runtime),
|
|---|
| 96 | <xref linkend="icu"/>,
|
|---|
| 97 | <xref linkend="libexif"/>,
|
|---|
| 98 | <xref linkend="libgrss"/>,
|
|---|
| 99 | <xref linkend="libgxps"/>,
|
|---|
| 100 | <xref linkend="libseccomp"/>,
|
|---|
| 101 | <xref linkend="poppler"/>, and
|
|---|
| 102 | <xref linkend="upower"/>
|
|---|
| 103 | </para>
|
|---|
| 104 |
|
|---|
| 105 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 106 | <para role="optional">
|
|---|
| 107 | <xref linkend="asciidoc"/>,
|
|---|
| 108 | <xref linkend="cmake"/>,
|
|---|
| 109 | <xref linkend="dconf"/>,
|
|---|
| 110 | <xref linkend="ffmpeg"/>,
|
|---|
| 111 | <xref linkend="libgsf"/>,
|
|---|
| 112 | <xref linkend="NetworkManager"/>,
|
|---|
| 113 | <xref linkend="taglib"/>,
|
|---|
| 114 | <xref linkend="totem-pl-parser"/>,
|
|---|
| 115 | <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
|
|---|
| 116 | <ulink url="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
|
|---|
| 117 | <ulink url="https://libosinfo.org">libosinfo</ulink>, and
|
|---|
| 118 | <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
|
|---|
| 119 | </para>
|
|---|
| 120 |
|
|---|
| 121 | </sect2>
|
|---|
| 122 |
|
|---|
| 123 | <sect2 role="installation">
|
|---|
| 124 | <title>Installation of Tracker-miners</title>
|
|---|
| 125 |
|
|---|
| 126 | <note>
|
|---|
| 127 | <para>
|
|---|
| 128 | If you plan to run the tests, some timeouts are too short when
|
|---|
| 129 | using spinning disks. There are two places where timeouts are
|
|---|
| 130 | used: first, individual tests inside a group of tests have a
|
|---|
| 131 | default timeout of 10s. This can be changed by setting the environment
|
|---|
| 132 | variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
|
|---|
| 133 | value when running the tests (see below). Second, a global timeout
|
|---|
| 134 | for a group of tests is fixed at configuration time. The default value
|
|---|
| 135 | in the <filename class="directory">functional-tests</filename>
|
|---|
| 136 | directory (other directories have only short lived tests) may be
|
|---|
| 137 | increased with the following command (replace 200 with a value
|
|---|
| 138 | suitable for your machine):
|
|---|
| 139 | </para>
|
|---|
| 140 |
|
|---|
| 141 | <screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
|
|---|
| 142 | </note>
|
|---|
| 143 |
|
|---|
| 144 | <!-- Applied in 3.6.2
|
|---|
| 145 | <para>
|
|---|
| 146 | First, fix some problems with the recent tightening of the seccomp
|
|---|
| 147 | sandbox:
|
|---|
| 148 | </para>
|
|---|
| 149 |
|
|---|
| 150 | <screen><userinput remap="pre">patch -Np1 -i ../tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch</userinput></screen>
|
|---|
| 151 | -->
|
|---|
| 152 |
|
|---|
| 153 | <para>
|
|---|
| 154 | Install <application>Tracker-miners</application> by running the following
|
|---|
| 155 | commands:
|
|---|
| 156 | </para>
|
|---|
| 157 |
|
|---|
| 158 |
|
|---|
| 159 | <screen revision="systemd"><userinput>mkdir build &&
|
|---|
| 160 | cd build &&
|
|---|
| 161 |
|
|---|
| 162 | meson setup --prefix=/usr \
|
|---|
| 163 | --buildtype=release \
|
|---|
| 164 | -Dman=false \
|
|---|
| 165 | -Dlandlock=disabled \
|
|---|
| 166 | .. &&
|
|---|
| 167 | ninja</userinput></screen>
|
|---|
| 168 |
|
|---|
| 169 | <screen revision="sysv"><userinput>mkdir build &&
|
|---|
| 170 | cd build &&
|
|---|
| 171 |
|
|---|
| 172 | meson setup --prefix=/usr \
|
|---|
| 173 | --buildtype=release \
|
|---|
| 174 | -Dsystemd_user_services=false \
|
|---|
| 175 | -Dman=false \
|
|---|
| 176 | -Dlandlock=disabled \
|
|---|
| 177 | .. &&
|
|---|
| 178 | ninja</userinput></screen>
|
|---|
| 179 |
|
|---|
| 180 | <para>
|
|---|
| 181 | <!-- Some tests fail in 3.6.1 due to seccomp sandbox changes.
|
|---|
| 182 | See https://github.blog/2023-10-09-coordinated-disclosure-1-click-rce-on-gnome-cve-2023-43641/ -->
|
|---|
| 183 | To test the results, issue (adjust the individual test timeout to a
|
|---|
| 184 | value suitable for your machine, see the note above):
|
|---|
| 185 | </para>
|
|---|
| 186 |
|
|---|
| 187 | <screen remap="test"><userinput>dbus-run-session env TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> ninja test &&
|
|---|
| 188 | rm -rf ~/tracker-tests</userinput></screen>
|
|---|
| 189 |
|
|---|
| 190 | <note>
|
|---|
| 191 | <para>
|
|---|
| 192 | The tests create files in the user directory (up to 24 MB), so
|
|---|
| 193 | they have to be removed afterwards.
|
|---|
| 194 | </para>
|
|---|
| 195 | </note>
|
|---|
| 196 |
|
|---|
| 197 | <para>
|
|---|
| 198 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 199 | </para>
|
|---|
| 200 |
|
|---|
| 201 | <screen role="root"><userinput>ninja install</userinput></screen>
|
|---|
| 202 | </sect2>
|
|---|
| 203 |
|
|---|
| 204 | <sect2 role="commands">
|
|---|
| 205 | <title>Command Explanations</title>
|
|---|
| 206 |
|
|---|
| 207 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 208 | href="../../xincludes/meson-buildtype-release.xml"/>
|
|---|
| 209 |
|
|---|
| 210 | <para>
|
|---|
| 211 | <parameter>-Dman=false</parameter>: This switch prevents the build process
|
|---|
| 212 | from generating man pages. Omit this switch if you have
|
|---|
| 213 | <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
|
|---|
| 214 | install the man pages.
|
|---|
| 215 | </para>
|
|---|
| 216 |
|
|---|
| 217 | <para>
|
|---|
| 218 | <parameter>-Dlandlock=disabled</parameter>: This switch disables the
|
|---|
| 219 | Landlock file access sandbox due to it requiring additional kernel
|
|---|
| 220 | configuration and packages such as selinux or AppArmor.
|
|---|
| 221 | </para>
|
|---|
| 222 |
|
|---|
| 223 | <para revision="sysv">
|
|---|
| 224 | <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
|
|---|
| 225 | the build process from installing systemd units since they are useless
|
|---|
| 226 | on SysV systems.
|
|---|
| 227 | </para>
|
|---|
| 228 |
|
|---|
| 229 | <para>
|
|---|
| 230 | <option>-Dseccomp=false</option>: This option disables the seccomp system
|
|---|
| 231 | call filter. On some architectures, such as i686 and ARM, the functions
|
|---|
| 232 | that tracker-miners uses are not guarded properly, and tracker-miners
|
|---|
| 233 | will get killed with a SIGSYS as a result.
|
|---|
| 234 | </para>
|
|---|
| 235 |
|
|---|
| 236 | <para>
|
|---|
| 237 | <option>-Dminer_rss=false</option>: Use this option if you have not
|
|---|
| 238 | installed the recommended dependency libgrss.
|
|---|
| 239 | </para>
|
|---|
| 240 |
|
|---|
| 241 | <para>
|
|---|
| 242 | <option>-Dbattery_detection=none</option>: Use this option if you have
|
|---|
| 243 | not installed the recommended dependency upower. Do not use this
|
|---|
| 244 | option if your system has a battery (laptop battery or UPS), or
|
|---|
| 245 | tracker miners may waste the battery power and lifespan when the A/C
|
|---|
| 246 | power is unavailable.
|
|---|
| 247 | </para>
|
|---|
| 248 |
|
|---|
| 249 | </sect2>
|
|---|
| 250 |
|
|---|
| 251 | <sect2 role="content">
|
|---|
| 252 | <title>Contents</title>
|
|---|
| 253 |
|
|---|
| 254 | <segmentedlist>
|
|---|
| 255 | <segtitle>Installed Programs</segtitle>
|
|---|
| 256 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 257 | <segtitle>Installed Directories</segtitle>
|
|---|
| 258 |
|
|---|
| 259 | <seglistitem>
|
|---|
| 260 | <seg>
|
|---|
| 261 | tracker3-daemon,
|
|---|
| 262 | tracker3-extract,
|
|---|
| 263 | tracker3-index,
|
|---|
| 264 | tracker3-info,
|
|---|
| 265 | tracker3-reset,
|
|---|
| 266 | tracker3-search,
|
|---|
| 267 | tracker3-status, and
|
|---|
| 268 | tracker3-tag
|
|---|
| 269 | </seg>
|
|---|
| 270 | <seg>
|
|---|
| 271 | Several modules under /usr/lib/tracker-miners-3.0
|
|---|
| 272 | </seg>
|
|---|
| 273 | <seg>
|
|---|
| 274 | /usr/lib/tracker-miners-3.0,
|
|---|
| 275 | /usr/libexec/tracker3, and
|
|---|
| 276 | /usr/share/tracker3-miners
|
|---|
| 277 | </seg>
|
|---|
| 278 | </seglistitem>
|
|---|
| 279 | </segmentedlist>
|
|---|
| 280 |
|
|---|
| 281 | <variablelist>
|
|---|
| 282 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 283 | <?dbfo list-presnetation="list"?>
|
|---|
| 284 | <?dbhtml list-presentation="table"?>
|
|---|
| 285 |
|
|---|
| 286 | <varlistentry id="tracker3-daemon">
|
|---|
| 287 | <term><command>tracker3-daemon</command></term>
|
|---|
| 288 | <listitem>
|
|---|
| 289 | <para>
|
|---|
| 290 | starts, stops, restarts, and lists daemons responsible for indexing
|
|---|
| 291 | content
|
|---|
| 292 | </para>
|
|---|
| 293 | <indexterm zone="tracker3-miners tracker3-daemon">
|
|---|
| 294 | <primary sortas="b-tracker3-daemon">tracker3-daemon</primary>
|
|---|
| 295 | </indexterm>
|
|---|
| 296 | </listitem>
|
|---|
| 297 | </varlistentry>
|
|---|
| 298 |
|
|---|
| 299 | <varlistentry id="tracker3-extract">
|
|---|
| 300 | <term><command>tracker3-extract</command></term>
|
|---|
| 301 | <listitem>
|
|---|
| 302 | <para>
|
|---|
| 303 | extracts metadata from a file
|
|---|
| 304 | </para>
|
|---|
| 305 | <indexterm zone="tracker3-miners tracker3-extract">
|
|---|
| 306 | <primary sortas="b-tracker3-extract">tracker3-extract</primary>
|
|---|
| 307 | </indexterm>
|
|---|
| 308 | </listitem>
|
|---|
| 309 | </varlistentry>
|
|---|
| 310 |
|
|---|
| 311 | <varlistentry id="tracker3-index">
|
|---|
| 312 | <term><command>tracker3-index</command></term>
|
|---|
| 313 | <listitem>
|
|---|
| 314 | <para>
|
|---|
| 315 | indexes content using the Tracker filesystem miner
|
|---|
| 316 | </para>
|
|---|
| 317 | <indexterm zone="tracker3-miners tracker3-index">
|
|---|
| 318 | <primary sortas="b-tracker3-index">tracker3-index</primary>
|
|---|
| 319 | </indexterm>
|
|---|
| 320 | </listitem>
|
|---|
| 321 | </varlistentry>
|
|---|
| 322 |
|
|---|
| 323 | <varlistentry id="tracker3-info">
|
|---|
| 324 | <term><command>tracker3-info</command></term>
|
|---|
| 325 | <listitem>
|
|---|
| 326 | <para>
|
|---|
| 327 | retrieves all information available for a certain file
|
|---|
| 328 | </para>
|
|---|
| 329 | <indexterm zone="tracker3-miners tracker3-info">
|
|---|
| 330 | <primary sortas="b-tracker3-info">tracker3-info</primary>
|
|---|
| 331 | </indexterm>
|
|---|
| 332 | </listitem>
|
|---|
| 333 | </varlistentry>
|
|---|
| 334 |
|
|---|
| 335 | <varlistentry id="tracker3-reset">
|
|---|
| 336 | <term><command>tracker3-reset</command></term>
|
|---|
| 337 | <listitem>
|
|---|
| 338 | <para>
|
|---|
| 339 | resets the Tracker index and configuration
|
|---|
| 340 | </para>
|
|---|
| 341 | <indexterm zone="tracker3-miners tracker3-reset">
|
|---|
| 342 | <primary sortas="b-tracker3-reset">tracker3-reset</primary>
|
|---|
| 343 | </indexterm>
|
|---|
| 344 | </listitem>
|
|---|
| 345 | </varlistentry>
|
|---|
| 346 |
|
|---|
| 347 | <varlistentry id="tracker3-search">
|
|---|
| 348 | <term><command>tracker3-search</command></term>
|
|---|
| 349 | <listitem>
|
|---|
| 350 | <para>
|
|---|
| 351 | searches for content by type or across all types
|
|---|
| 352 | </para>
|
|---|
| 353 | <indexterm zone="tracker3-miners tracker3-search">
|
|---|
| 354 | <primary sortas="b-tracker3-search">tracker3-search</primary>
|
|---|
| 355 | </indexterm>
|
|---|
| 356 | </listitem>
|
|---|
| 357 | </varlistentry>
|
|---|
| 358 |
|
|---|
| 359 | <varlistentry id="tracker3-status">
|
|---|
| 360 | <term><command>tracker3-status</command></term>
|
|---|
| 361 | <listitem>
|
|---|
| 362 | <para>
|
|---|
| 363 | provides status and statistics on data that has been indexed
|
|---|
| 364 | </para>
|
|---|
| 365 | <indexterm zone="tracker3-miners tracker3-status">
|
|---|
| 366 | <primary sortas="b-tracker3-status">tracker3-status</primary>
|
|---|
| 367 | </indexterm>
|
|---|
| 368 | </listitem>
|
|---|
| 369 | </varlistentry>
|
|---|
| 370 |
|
|---|
| 371 | <varlistentry id="tracker3-tag">
|
|---|
| 372 | <term><command>tracker3-tag</command></term>
|
|---|
| 373 | <listitem>
|
|---|
| 374 | <para>
|
|---|
| 375 | adds, removes, and lists tags
|
|---|
| 376 | </para>
|
|---|
| 377 | <indexterm zone="tracker3-miners tracker3-tag">
|
|---|
| 378 | <primary sortas="b-tracker3-tag">tracker3-tag</primary>
|
|---|
| 379 | </indexterm>
|
|---|
| 380 | </listitem>
|
|---|
| 381 | </varlistentry>
|
|---|
| 382 | </variablelist>
|
|---|
| 383 | </sect2>
|
|---|
| 384 |
|
|---|
| 385 | </sect1>
|
|---|
