source: gnome/platform/tracker3-miners.xml@ de74d323

12.2 trunk
Last change on this file since de74d323 was 5eaa870e, checked in by Douglas R. Reno <renodr@…>, 3 weeks ago

Tags for GNOME Libraries
  • Property mode set to 100644
File size: 13.4 KB
Line 
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 "8c1b48f2fa57d888967de9b5ff348fc1">
10 <!ENTITY tracker3-miners-size "4.3 MB">
11 <!ENTITY tracker3-miners-buildsize "36 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 &lfs122_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 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
70 <itemizedlist spacing="compact">
71 <listitem>
72 <para>
73 Required patch:
74 <ulink url="&patch-root;/tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch"/>
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Tracker-miners Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref linkend="gst10-plugins-base"/>,
84 <xref linkend="tracker3"/>,
85 <xref linkend="exempi"/>, and
86 <xref linkend="gexiv2"/>
87 </para>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref linkend="giflib"/>,
92 <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
93 <xref role='runtime' linkend="gst10-libav"/> (runtime),
94 <xref linkend="icu"/>,
95 <xref linkend="libexif"/>,
96 <xref linkend="libgxps"/>,
97 <xref linkend="libseccomp"/>,
98 <xref linkend="poppler"/>, and
99 <xref linkend="upower"/>
100 </para>
101
102 <bridgehead renderas="sect4">Optional</bridgehead>
103 <para role="optional">
104 <xref linkend="asciidoc"/>,
105 <xref linkend="cmake"/>,
106 <xref linkend="dconf"/>,
107 <xref linkend="ffmpeg"/>,
108 <xref linkend="libgsf"/>,
109 <xref linkend="NetworkManager"/>,
110 <xref linkend="taglib"/>,
111 <xref linkend="totem-pl-parser"/>,
112 <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
113 <ulink url="https://gitlab.gnome.org/GNOME/libgrss">libgrss</ulink>,
114 <ulink url="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
115 <ulink url="https://libosinfo.org">libosinfo</ulink>, and
116 <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
117 </para>
118
119 </sect2>
120
121 <sect2 role="kernel" id="tracker3-miners-kernel">
122 <title>Kernel Configuration</title>
123
124 <para>
125 Enable the following options in the kernel configuration, then recompile
126 the kernel and reboot if necessary:
127 </para>
128
129 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
130 href="tracker3-miners-kernel.xml"/>
131
132 <indexterm zone="tracker3-miners tracker3-miners-kernel">
133 <primary sortas="d-traker-miners">tracker-miners</primary>
134 </indexterm>
135 </sect2>
136
137 <sect2 role="installation">
138 <title>Installation of Tracker-miners</title>
139
140 <note>
141 <para>
142 If you plan to run the tests, some timeouts are too short when
143 using spinning disks. There are two places where timeouts are
144 used: first, individual tests inside a group of tests have a
145 default timeout of 10s. This can be changed by setting the environment
146 variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
147 value when running the tests (see below). Second, a global timeout
148 for a group of tests is fixed at configuration time. The default value
149 in the <filename class="directory">functional-tests</filename>
150 directory (other directories have only short lived tests) may be
151 increased with the following command (replace 200 with a value
152 suitable for your machine):
153 </para>
154
155<screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
156 </note>
157
158 <para>
159 First, fix one issue in the TIFF extractor and another issue in the
160 Landlock sandbox:
161 </para>
162
163<screen><userinput remap="pre">patch -Np1 -i ../tracker-miners-&tracker3-miners-version;-upstream_fixes-1.patch</userinput></screen>
164
165 <para>
166 Install <application>Tracker-miners</application> by running the following
167 commands:
168 </para>
169
170
171<screen revision="systemd"><userinput>mkdir build &amp;&amp;
172cd build &amp;&amp;
173
174meson setup --prefix=/usr \
175 --buildtype=release \
176 -D man=false \
177 -D miner_rss=false \
178 .. &amp;&amp;
179ninja</userinput></screen>
180
181<screen revision="sysv"><userinput>mkdir build &amp;&amp;
182cd build &amp;&amp;
183
184meson setup --prefix=/usr \
185 --buildtype=release \
186 -D systemd_user_services=false \
187 -D man=false \
188 -D miner_rss=false \
189 .. &amp;&amp;
190ninja</userinput></screen>
191
192
193 <para>
194 Now, as the <systemitem class="username">root</systemitem> user:
195 </para>
196
197 <screen role="root"><userinput>ninja install</userinput></screen>
198
199 <para>
200 To test the results, issue (adjust the individual test timeout to a
201 value suitable for your machine, see the note above):
202 </para>
203
204<screen remap="test"><userinput>meson configure -D debug=true &amp;&amp;
205dbus-run-session env LC_ALL=C.UTF-8 TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> \
206 ninja test &amp;&amp;
207rm -rf ~/tracker-tests</userinput></screen>
208
209 <note>
210 <para>
211 The tests create files in the user directory (up to 24 MB), so
212 they have to be removed afterwards.
213 </para>
214 </note>
215 </sect2>
216
217 <sect2 role="commands">
218 <title>Command Explanations</title>
219
220 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
221 href="../../xincludes/meson-buildtype-release.xml"/>
222
223 <para>
224 <parameter>-D man=false</parameter>: This switch prevents the build process
225 from generating man pages. Omit this switch if you have
226 <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
227 install the man pages.
228 </para>
229
230 <para>
231 <parameter>-D miner_rss=false</parameter>: This switch prevents using
232 libgrss for indexing RSS feeds because libgrss is insecure and no longer
233 in BLFS.
234 </para>
235
236 <para revision="sysv">
237 <parameter>-D systemd_user_services=false</parameter>: This switch prevents
238 the build process from installing systemd units since they are useless
239 on SysV systems.
240 </para>
241
242 <para>
243 <option>-D seccomp=false</option>: This option disables the seccomp system
244 call filter. On some architectures, such as i686 and ARM, the functions
245 that tracker-miners uses are not guarded properly, and tracker-miners
246 will get killed with a SIGSYS as a result. Note that disabling
247 seccomp may cause the system to be compromised worse in the event that a
248 security vulnerability in tracker-miners or its dependencies is
249 exploited.
250 </para>
251
252 <para>
253 <option>-D landlock=disabled</option>: This switch disables the
254 Landlock file access sandbox. Use it if you don't want to build the
255 kernel with Landlock support. Note that disabling Landlock may
256 cause the system to be compromised worse in the event that a security
257 vulnerability in tracker-miners or its dependencies is exploited.
258 </para>
259
260 <para>
261 <option>-D battery_detection=none</option>: Use this option if you have
262 not installed the recommended dependency upower. Do not use this
263 option if your system has a battery (laptop battery or UPS), or
264 tracker-miners may waste the battery power and lifespan when the A/C
265 power is unavailable.
266 </para>
267
268 </sect2>
269
270 <sect2 role="content">
271 <title>Contents</title>
272
273 <segmentedlist>
274 <segtitle>Installed Programs</segtitle>
275 <segtitle>Installed Libraries</segtitle>
276 <segtitle>Installed Directories</segtitle>
277
278 <seglistitem>
279 <seg>
280 tracker3-daemon,
281 tracker3-extract,
282 tracker3-index,
283 tracker3-info,
284 tracker3-reset,
285 tracker3-search,
286 tracker3-status, and
287 tracker3-tag
288 </seg>
289 <seg>
290 Several modules under /usr/lib/tracker-miners-3.0
291 </seg>
292 <seg>
293 /usr/lib/tracker-miners-3.0,
294 /usr/libexec/tracker3, and
295 /usr/share/tracker3-miners
296 </seg>
297 </seglistitem>
298 </segmentedlist>
299
300 <variablelist>
301 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
302 <?dbfo list-presnetation="list"?>
303 <?dbhtml list-presentation="table"?>
304
305 <varlistentry id="tracker3-daemon">
306 <term><command>tracker3-daemon</command></term>
307 <listitem>
308 <para>
309 starts, stops, restarts, and lists daemons responsible for indexing
310 content
311 </para>
312 <indexterm zone="tracker3-miners tracker3-daemon">
313 <primary sortas="b-tracker3-daemon">tracker3-daemon</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="tracker3-extract">
319 <term><command>tracker3-extract</command></term>
320 <listitem>
321 <para>
322 extracts metadata from a file
323 </para>
324 <indexterm zone="tracker3-miners tracker3-extract">
325 <primary sortas="b-tracker3-extract">tracker3-extract</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="tracker3-index">
331 <term><command>tracker3-index</command></term>
332 <listitem>
333 <para>
334 indexes content using the Tracker filesystem miner
335 </para>
336 <indexterm zone="tracker3-miners tracker3-index">
337 <primary sortas="b-tracker3-index">tracker3-index</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="tracker3-info">
343 <term><command>tracker3-info</command></term>
344 <listitem>
345 <para>
346 retrieves all information available for a certain file
347 </para>
348 <indexterm zone="tracker3-miners tracker3-info">
349 <primary sortas="b-tracker3-info">tracker3-info</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="tracker3-reset">
355 <term><command>tracker3-reset</command></term>
356 <listitem>
357 <para>
358 resets the Tracker index and configuration
359 </para>
360 <indexterm zone="tracker3-miners tracker3-reset">
361 <primary sortas="b-tracker3-reset">tracker3-reset</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="tracker3-search">
367 <term><command>tracker3-search</command></term>
368 <listitem>
369 <para>
370 searches for content by type or across all types
371 </para>
372 <indexterm zone="tracker3-miners tracker3-search">
373 <primary sortas="b-tracker3-search">tracker3-search</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="tracker3-status">
379 <term><command>tracker3-status</command></term>
380 <listitem>
381 <para>
382 provides status and statistics on data that has been indexed
383 </para>
384 <indexterm zone="tracker3-miners tracker3-status">
385 <primary sortas="b-tracker3-status">tracker3-status</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="tracker3-tag">
391 <term><command>tracker3-tag</command></term>
392 <listitem>
393 <para>
394 adds, removes, and lists tags
395 </para>
396 <indexterm zone="tracker3-miners tracker3-tag">
397 <primary sortas="b-tracker3-tag">tracker3-tag</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401 </variablelist>
402 </sect2>
403
404</sect1>
Note: See TracBrowser for help on using the repository browser.