source: gnome/platform/tracker3.xml

trunk
Last change on this file was 89c43fd4, checked in by Xi Ruoyao <xry111@…>, 5 days ago

tracker: Adapt for sqlite-3.45.3

I noticed the issue rebuilding tracker for ICU-75. But it turns out the
breakage is introduced by the previous sqlite update.

  • Property mode set to 100644
File size: 10.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-download-http
8 "&gnome-download-http;/tracker/3.7/tracker-&tracker3-version;.tar.xz">
9 <!ENTITY tracker3-download-ftp " ">
10 <!ENTITY tracker3-md5sum "63357a4966867fa86b7f899283de075e">
11 <!ENTITY tracker3-size "1.7 MB">
12 <!ENTITY tracker3-buildsize "58 MB (with tests)">
13 <!ENTITY tracker3-time "0.4 SBU (with tests)">
14]>
15
16<sect1 id="tracker3" xreflabel="Tracker-&tracker3-version;">
17 <?dbhtml filename="tracker3.html"?>
18
19
20 <title>Tracker-&tracker3-version;</title>
21
22 <indexterm zone="tracker3">
23 <primary sortas="a-Tracker3">Tracker3</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Tracker</title>
28
29 <para>
30 <application>Tracker</application> is the file indexing and search
31 provider used in the <application>GNOME</application> desktop environment.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&tracker3-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&tracker3-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &tracker3-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &tracker3-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &tracker3-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &tracker3-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70<!-- Not needed with 3.0.3, but keep around just in case
71 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch:
76 <ulink url="&patch-root;/tracker-&tracker3-version;-upstream_fixes-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80-->
81
82 <bridgehead renderas="sect3">Tracker Dependencies</bridgehead>
83
84 <bridgehead renderas="sect4">Required</bridgehead>
85 <para role="required">
86 <xref linkend="json-glib"/>,
87 <xref linkend="libseccomp"/>, and
88 <xref linkend="vala"/>
89 </para>
90
91 <bridgehead renderas="sect4">Recommended</bridgehead>
92 <para role="recommended">
93 &gobject-introspection;,
94 <xref linkend="icu"/>,
95 <xref linkend="libsoup3"/>,
96 <xref linkend="pygobject3"/>,
97 <xref linkend="sqlite"/>, and
98 <xref linkend="tracker3-miners"/> (runtime)
99 </para>
100
101 <bridgehead renderas="sect4">Optional</bridgehead>
102 <para role="optional">
103 <xref linkend="asciidoc"/>,
104 <xref linkend="avahi"/>,
105<!-- It looks like not used even if docs=true,
106 the pre-built doc is shipped in tarball and will be installed
107 <xref linkend="gi-docgen"/>
108-->
109 <xref linkend="graphviz"/>,
110 <xref linkend="libsoup"/>,
111 <ulink url="https://github.com/scop/bash-completion/">bash-completion</ulink>, and
112 <ulink url="https://github.com/snowballstem/snowball/">libstemmer</ulink>
113 <!--<ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
114 (for tests)-->
115 </para>
116
117 </sect2>
118
119 <sect2 role="installation">
120 <title>Installation of Tracker</title>
121
122 <para>
123 Fix the location to install the documentation into:
124 </para>
125
126<screen><userinput>mv docs/reference/libtracker-sparql/doc/{Tracker-3.0,tracker-&tracker3-version;} &amp;&amp;
127sed '/docs_name/s/Tracker-3.0/tracker-&tracker3-version;/' \
128 -i docs/reference/libtracker-sparql/meson.build</userinput></screen>
129
130 <!-- https://gitlab.gnome.org/GNOME/tracker/-/merge_requests/665 -->
131 <para>
132 Adapt for a behavior change of SQLite 3.45.3:
133 </para>
134
135 <screen><userinput>sed 's/ROWID/\\"rdfs:Resource\\".ID/' \
136 -i src/libtracker-sparql/core/tracker-fts.c</userinput></screen>
137
138 <para>
139 Install <application>Tracker</application> by running the following
140 commands:
141 </para>
142
143<screen revision="systemd"><userinput>mkdir build &amp;&amp;
144cd build &amp;&amp;
145
146meson setup --prefix=/usr \
147 --buildtype=release \
148 -Dman=false \
149 .. &amp;&amp;
150ninja</userinput></screen>
151
152<screen revision="sysv"><userinput>mkdir build &amp;&amp;
153cd build &amp;&amp;
154
155meson setup --prefix=/usr \
156 --buildtype=release \
157 -Dman=false \
158 -Dsystemd_user_services=false \
159 .. &amp;&amp;
160ninja</userinput></screen>
161
162 <para>
163 Now, as the <systemitem class="username">root</systemitem> user:
164 </para>
165
166<screen role="root"><userinput>ninja install</userinput></screen>
167
168 <para>
169 To test the results, issue: <command>meson configure -Ddebug=true
170 &amp;&amp; ninja test</command>.
171 The test suite should be run from a graphical session. <!--One test,
172 <filename>tracker: fts / fts</filename>, is known to fail due to an
173 incompatibility with SQLite-3.42.-->
174 </para>
175
176 </sect2>
177
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
183 href="../../xincludes/meson-buildtype-release.xml"/>
184
185 <para>
186 <parameter>-Dman=false</parameter>: This switch prevents the build
187 process from generating man pages. Omit this switch if you have
188 <xref linkend="asciidoc" role="nodep"/> installed and wish to generate
189 and install the man pages.
190 </para>
191
192 <para revision="sysv">
193 <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
194 the build process from installing systemd user services since they are
195 useless on SysV systems.
196 </para>
197
198 <para>
199 <command>meson configure -Ddebug=true</command>: This command enables
200 some debug checks necessary for the test suite. We don't want to
201 enable them for the installed Tracker 3 libraries and programs, so
202 we run the test suite after installation.
203 </para>
204
205 </sect2>
206
207
208 <sect2 role="content">
209 <title>Contents</title>
210
211 <segmentedlist>
212 <segtitle>Installed Programs</segtitle>
213 <segtitle>Installed Library</segtitle>
214 <segtitle>Installed Directories</segtitle>
215
216 <seglistitem>
217 <seg>
218 tracker3,
219 tracker3-endpoint,
220 tracker3-export,
221 tracker3-help,
222 tracker3-import,
223 tracker3-sparql, and
224 tracker3-sql
225 </seg>
226 <seg>
227 libtracker-sparql-3.0.so
228 </seg>
229 <seg>
230 /usr/{include,lib}/tracker-3.0,
231 /usr/libexec/tracker3,
232 /usr/share/tracker3, and
233 /usr/share/doc/tracker-&tracker3-version; (optional)
234 </seg>
235 </seglistitem>
236 </segmentedlist>
237
238 <variablelist>
239 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
240 <?dbfo list-presentation="list"?>
241 <?dbhtml list-presentation="table"?>
242
243 <varlistentry id="tracker3-prog">
244 <term><command>tracker3</command></term>
245 <listitem>
246 <para>
247 is a control program for the indexer
248 </para>
249 <indexterm zone="tracker3 tracker3-prog">
250 <primary sortas="b-tracker3">tracker3</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="tracker3-endpoint">
256 <term><command>tracker3-endpoint</command></term>
257 <listitem>
258 <para>
259 creates a SPARQL endpoint
260 </para>
261 <indexterm zone="tracker3 tracker3-endpoint">
262 <primary sortas="b-tracker3-endpoint">tracker3-endpoint</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="tracker3-export">
268 <term><command>tracker3-export</command></term>
269 <listitem>
270 <para>
271 exports all data from a Tracker database
272 </para>
273 <indexterm zone="tracker3 tracker3-export">
274 <primary sortas="b-tracker3-export">tracker3-export</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="tracker3-help">
280 <term><command>tracker3-help</command></term>
281 <listitem>
282 <para>
283 shows manual pages related to Tracker
284 </para>
285 <indexterm zone="tracker3 tracker3-help">
286 <primary sortas="b-tracker3-help">tracker3-help</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="tracker3-import">
292 <term><command>tracker3-import</command></term>
293 <listitem>
294 <para>
295 imports data into a Tracker database
296 </para>
297 <indexterm zone="tracker3 tracker3-import">
298 <primary sortas="b-tracker3-import">tracker3-import</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="tracker3-sparql">
304 <term><command>tracker3-sparql</command></term>
305 <listitem>
306 <para>
307 uses SparQL to query a Tracker database
308 </para>
309 <indexterm zone="tracker3 tracker3-sparql">
310 <primary sortas="b-tracker3-sparql">tracker3-sparql</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="tracker3-sql">
316 <term><command>tracker3-sql</command></term>
317 <listitem>
318 <para>
319 uses SQL to query a Tracker database
320 </para>
321 <indexterm zone="tracker3 tracker3-sql">
322 <primary sortas="b-tracker3-sql">tracker3-sql</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="libtracker3-sparql">
328 <term><filename class="libraryfile">libtracker-sparql-3.0.so</filename></term>
329 <listitem>
330 <para>
331 contains resource management and database functions
332 </para>
333 <indexterm zone="tracker3 libtracker3-sparql">
334 <primary sortas="c-libtracker3-sparql">libtracker-sparql-3.0.so</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 </variablelist>
340
341 </sect2>
342
343</sect1>
Note: See TracBrowser for help on using the repository browser.