glfs/gnome/platform/tracker3.xml
2023-08-22 21:18:55 -05:00

259 lines
7.8 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY tracker3-download-http
"&gnome-download-http;/tracker/3.5/tracker-&tracker3-version;.tar.xz">
<!ENTITY tracker3-download-ftp
"&gnome-download-ftp;/tracker/3.5/tracker-&tracker3-version;.tar.xz">
<!ENTITY tracker3-md5sum "f78a0d145007d9871174be21a49ce9ef">
<!ENTITY tracker3-size "2.5 MB">
<!ENTITY tracker3-buildsize "51 MB (with tests)">
<!ENTITY tracker3-time "0.3 SBU (with tests)">
]>
<sect1 id="tracker3" xreflabel="Tracker-&tracker3-version;">
<?dbhtml filename="tracker3.html"?>
<title>Tracker-&tracker3-version;</title>
<indexterm zone="tracker3">
<primary sortas="a-Tracker3">Tracker3</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Tracker</title>
<para>
<application>Tracker</application> is the file indexing and search
provider used in the <application>GNOME</application> desktop environment.
</para>
&lfs120_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&tracker3-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&tracker3-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &tracker3-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &tracker3-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &tracker3-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &tracker3-time;
</para>
</listitem>
</itemizedlist>
<!-- Not needed with 3.0.3, but keep around just in case
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Required patch:
<ulink url="&patch-root;/tracker-&tracker3-version;-upstream_fixes-1.patch"/>
</para>
</listitem>
</itemizedlist>
-->
<bridgehead renderas="sect3">Tracker Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="json-glib"/>,
<xref linkend="libseccomp"/>, and
<xref linkend="vala"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="gobject-introspection"/>,
<xref linkend="icu"/>,
<xref linkend="libsoup3"/>,
<xref linkend="pygobject3"/>,
<xref linkend="sqlite"/>, and
<xref linkend="tracker3-miners"/> (runtime)
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="asciidoc"/>,
<!-- It looks like not used even if docs=true,
the pre-built doc is shipped in tarball and will be installed
<xref linkend="gi-docgen"/>
-->
<xref linkend="graphviz"/>,
<xref linkend="libsoup"/>,
<ulink url="https://github.com/scop/bash-completion/">bash-completion</ulink>, and
<ulink url="https://github.com/snowballstem/snowball/">libstemmer</ulink>
<!--<ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
(for tests)-->
</para>
</sect2>
<sect2 role="installation">
<title>Installation of Tracker</title>
<para>
Fix the location to install the documentation into:
</para>
<screen><userinput>mv docs/reference/libtracker-sparql/doc/{Tracker-3.0,tracker-&tracker3-version;} &amp;&amp;
sed '/docs_name/s/Tracker-3.0/tracker-&tracker3-version;/' \
-i docs/reference/libtracker-sparql/meson.build</userinput></screen>
<para>
Install <application>Tracker</application> by running the following
commands:
</para>
<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson setup --prefix=/usr \
--buildtype=release \
-Dman=false \
.. &amp;&amp;
ninja</userinput></screen>
<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson setup --prefix=/usr \
--buildtype=release \
-Dman=false \
-Dsystemd_user_services=false \
.. &amp;&amp;
ninja</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install</userinput></screen>
<para>
To test the results, issue: <command>meson configure -Ddebug=true
&amp;&amp; ninja test</command>.
The test suite should be run from a graphical session. One test,
<filename>tracker: fts / fts</filename>, is known to fail due to an
incompatibility with SQLite-3.42.
</para>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-buildtype-release.xml"/>
<para>
<parameter>-Dman=false</parameter>: This switch prevents the build
process from generating man pages. Omit this switch if you have
<xref linkend="asciidoc" role="nodep"/> installed and wish to generate
and install the man pages.
</para>
<para revision="sysv">
<parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
the build process from installing systemd user services since they are
useless on SysV systems.
</para>
<para>
<command>meson configure -Ddebug=true</command>: This command enables
some debug checks necessary for the test suite. We don't want to
enable them for the installed Tracker 3 libraries and programs, so
we run the test suite after installation.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
tracker3
</seg>
<seg>
libtracker-sparql-3.0.so
</seg>
<seg>
/usr/{include,lib}/tracker-3.0,
/usr/libexec/tracker3,
/usr/share/tracker3, and
/usr/share/doc/Tracker-3.0 (optional)
<!-- Xi, when you change documentation, please change this path -->
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="tracker3-prog">
<term><command>tracker3</command></term>
<listitem>
<para>
is a control program for the indexer
</para>
<indexterm zone="tracker3 tracker3-prog">
<primary sortas="b-tracker3">tracker3</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libtracker3-sparql">
<term><filename class="libraryfile">libtracker-sparql-3.0.so</filename></term>
<listitem>
<para>
contains resource management and database functions
</para>
<indexterm zone="tracker3 libtracker3-sparql">
<primary sortas="c-libtracker3-sparql">libtracker-sparql-3.0.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>