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.5/tracker-miners-&tracker3-miners-version;.tar.xz">
|
---|
8 | <!ENTITY tracker3-miners-download-ftp "&gnome-download-ftp;/tracker-miners/3.5/tracker-miners-&tracker3-miners-version;.tar.xz">
|
---|
9 | <!ENTITY tracker3-miners-md5sum "307705e0ebb45c733f42489230ab14f2">
|
---|
10 | <!ENTITY tracker3-miners-size "7.2 MB">
|
---|
11 | <!ENTITY tracker3-miners-buildsize "38 MB (with tests)">
|
---|
12 | <!ENTITY tracker3-miners-time "0.5 SBU (with parallelism=4; add 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 | &lfs120_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">Tracker-miners Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
72 | <para role="required">
|
---|
73 | <xref linkend="gst10-plugins-base"/>,
|
---|
74 | <xref linkend="tracker3"/>,
|
---|
75 | <xref linkend="exempi"/>, and
|
---|
76 | <xref linkend="gexiv2"/>
|
---|
77 | </para>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
80 | <para role="recommended">
|
---|
81 | <xref linkend="giflib"/>,
|
---|
82 | <xref linkend="gst10-plugins-base"/>,
|
---|
83 | <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
|
---|
84 | <xref role='runtime' linkend="gst10-libav"/> (runtime),
|
---|
85 | <xref linkend="icu"/>,
|
---|
86 | <xref linkend="libexif"/>,
|
---|
87 | <xref linkend="libgrss"/>,
|
---|
88 | <xref linkend="libgxps"/>,
|
---|
89 | <xref linkend="libseccomp"/>, and
|
---|
90 | <xref linkend="poppler"/>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
94 | <para role="optional">
|
---|
95 | <xref linkend="asciidoc"/>,
|
---|
96 | <xref linkend="cmake"/>,
|
---|
97 | <xref linkend="dconf"/>,
|
---|
98 | <xref linkend="ffmpeg"/>,
|
---|
99 | <xref linkend="libgsf"/>,
|
---|
100 | <xref linkend="NetworkManager"/>,
|
---|
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="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
|
---|
106 | <ulink url="https://libosinfo.org">libosinfo</ulink>, and
|
---|
107 | <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
|
---|
108 | <!--<ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
|
---|
109 | (for tests)-->
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | </sect2>
|
---|
113 |
|
---|
114 | <sect2 role="installation">
|
---|
115 | <title>Installation of Tracker-miners</title>
|
---|
116 |
|
---|
117 | <!--
|
---|
118 | <para>
|
---|
119 | First, as the <systemitem class="username">root</systemitem> user,
|
---|
120 | remove some files from tracker-2 which will conflict with
|
---|
121 | tracker-miners-3:
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <screen role="root"><userinput remap="pre">rm -fv /etc/xdg/autostart/tracker-miner-*</userinput></screen>
|
---|
125 | -->
|
---|
126 |
|
---|
127 | <note>
|
---|
128 | <para>
|
---|
129 | If you plan to run the tests, some timeouts are too short when
|
---|
130 | using spinning disks. There are two places where timeouts are
|
---|
131 | used: first, individual tests inside a group of tests have a
|
---|
132 | default timeout of 10s. This can be changed by setting the environment
|
---|
133 | variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
|
---|
134 | value when running the tests (see below). Second, a global timeout
|
---|
135 | for a group of tests is fixed at configuration time. The default value
|
---|
136 | in the <filename class="directory">functional-tests</filename>
|
---|
137 | directory (other directories have only short lived tests) may be
|
---|
138 | increased with the following command (replace 200 with a value
|
---|
139 | suitable for your machine):
|
---|
140 | </para>
|
---|
141 |
|
---|
142 | <screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
|
---|
143 | </note>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | Install <application>Tracker-miners</application> by running the following
|
---|
147 | commands:
|
---|
148 | </para>
|
---|
149 |
|
---|
150 |
|
---|
151 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
152 | cd build &&
|
---|
153 |
|
---|
154 | meson setup --prefix=/usr \
|
---|
155 | --buildtype=release \
|
---|
156 | -Dman=false \
|
---|
157 | .. &&
|
---|
158 | ninja</userinput></screen>
|
---|
159 |
|
---|
160 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
161 | cd build &&
|
---|
162 |
|
---|
163 | meson setup --prefix=/usr \
|
---|
164 | --buildtype=release \
|
---|
165 | -Dsystemd_user_services=false \
|
---|
166 | -Dman=false \
|
---|
167 | .. &&
|
---|
168 | ninja</userinput></screen>
|
---|
169 |
|
---|
170 | <para>
|
---|
171 | To test the results, issue (adjust the individual test timeout to a
|
---|
172 | value suitable for your machine, see the note above):
|
---|
173 | </para>
|
---|
174 |
|
---|
175 | <screen remap="test"><userinput>dbus-run-session env TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> ninja test &&
|
---|
176 | rm -rf ~/tracker-tests</userinput></screen>
|
---|
177 |
|
---|
178 | <note>
|
---|
179 | <para>
|
---|
180 | The tests create files in the user directory (up to 24 MB), so
|
---|
181 | they have to be removed afterwards.
|
---|
182 | </para>
|
---|
183 | </note>
|
---|
184 |
|
---|
185 | <para>
|
---|
186 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
190 | </sect2>
|
---|
191 |
|
---|
192 | <sect2 role="commands">
|
---|
193 | <title>Command Explanations</title>
|
---|
194 |
|
---|
195 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
196 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
197 |
|
---|
198 | <para>
|
---|
199 | <parameter>-Dman=false</parameter>: This switch prevents the build process
|
---|
200 | from generating man pages. Omit this switch if you have
|
---|
201 | <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
|
---|
202 | install the man pages.
|
---|
203 | </para>
|
---|
204 |
|
---|
205 | <para revision="sysv">
|
---|
206 | <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
|
---|
207 | the build process from installing systemd units since they are useless
|
---|
208 | on SysV systems.
|
---|
209 | </para>
|
---|
210 |
|
---|
211 | <para>
|
---|
212 | <option>-Dseccomp=false</option>: This option disables the seccomp system
|
---|
213 | call filter. On some architectures, such as i686 and ARM, the functions
|
---|
214 | that tracker-miners uses are not guarded properly, and tracker-miners
|
---|
215 | will get killed with a SIGSYS as a result.
|
---|
216 | </para>
|
---|
217 |
|
---|
218 | <para>
|
---|
219 | <option>-Dminer_rss=false</option>: Use this option if you have not
|
---|
220 | installed the recommended dependency libgrss.
|
---|
221 | </para>
|
---|
222 |
|
---|
223 | </sect2>
|
---|
224 |
|
---|
225 | <sect2 role="content">
|
---|
226 | <title>Contents</title>
|
---|
227 |
|
---|
228 | <segmentedlist>
|
---|
229 | <segtitle>Installed Programs</segtitle>
|
---|
230 | <segtitle>Installed Libraries</segtitle>
|
---|
231 | <segtitle>Installed Directories</segtitle>
|
---|
232 |
|
---|
233 | <seglistitem>
|
---|
234 | <seg>
|
---|
235 | None
|
---|
236 | </seg>
|
---|
237 | <seg>
|
---|
238 | Several modules under /usr/lib/tracker-miners-3.0
|
---|
239 | </seg>
|
---|
240 | <seg>
|
---|
241 | /usr/lib/tracker-miners-3.0,
|
---|
242 | /usr/libexec/tracker3, and
|
---|
243 | /usr/share/tracker3-miners
|
---|
244 | </seg>
|
---|
245 | </seglistitem>
|
---|
246 | </segmentedlist>
|
---|
247 | </sect2>
|
---|
248 |
|
---|
249 | </sect1>
|
---|