[ec047148] | 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-download-http
|
---|
[bed8a11c] | 8 | "&gnome-download-http;/tracker/3.5/tracker-&tracker3-version;.tar.xz">
|
---|
[ec047148] | 9 | <!ENTITY tracker3-download-ftp
|
---|
[bed8a11c] | 10 | "&gnome-download-ftp;/tracker/3.5/tracker-&tracker3-version;.tar.xz">
|
---|
| 11 | <!ENTITY tracker3-md5sum "f78a0d145007d9871174be21a49ce9ef">
|
---|
| 12 | <!ENTITY tracker3-size "2.5 MB">
|
---|
| 13 | <!ENTITY tracker3-buildsize "51 MB (with tests)">
|
---|
[dec2fe3] | 14 | <!ENTITY tracker3-time "0.3 SBU (with tests)">
|
---|
[ec047148] | 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="tracker3" xreflabel="Tracker-&tracker3-version;">
|
---|
| 18 | <?dbhtml filename="tracker3.html"?>
|
---|
| 19 |
|
---|
| 20 |
|
---|
| 21 | <title>Tracker-&tracker3-version;</title>
|
---|
| 22 |
|
---|
| 23 | <indexterm zone="tracker3">
|
---|
| 24 | <primary sortas="a-Tracker3">Tracker3</primary>
|
---|
| 25 | </indexterm>
|
---|
| 26 |
|
---|
| 27 | <sect2 role="package">
|
---|
| 28 | <title>Introduction to Tracker</title>
|
---|
| 29 |
|
---|
| 30 | <para>
|
---|
| 31 | <application>Tracker</application> is the file indexing and search
|
---|
| 32 | provider used in the <application>GNOME</application> desktop environment.
|
---|
| 33 | </para>
|
---|
| 34 |
|
---|
[b5c0ca3] | 35 | &lfs120_checked;
|
---|
[ec047148] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&tracker3-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&tracker3-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &tracker3-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &tracker3-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &tracker3-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &tracker3-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
[e83d3a5] | 71 | <!-- Not needed with 3.0.3, but keep around just in case
|
---|
[21d18f7e] | 72 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 73 | <itemizedlist spacing="compact">
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>
|
---|
| 76 | Required patch:
|
---|
| 77 | <ulink url="&patch-root;/tracker-&tracker3-version;-upstream_fixes-1.patch"/>
|
---|
| 78 | </para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
[e83d3a5] | 81 | -->
|
---|
[21d18f7e] | 82 |
|
---|
[ec047148] | 83 | <bridgehead renderas="sect3">Tracker Dependencies</bridgehead>
|
---|
| 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 86 | <para role="required">
|
---|
| 87 | <xref linkend="json-glib"/>,
|
---|
[dae4075] | 88 | <xref linkend="libseccomp"/>, and
|
---|
[ec047148] | 89 | <xref linkend="vala"/>
|
---|
| 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 93 | <para role="recommended">
|
---|
| 94 | <xref linkend="gobject-introspection"/>,
|
---|
[bbfc73c] | 95 | <xref linkend="icu"/>,
|
---|
[dec2fe3] | 96 | <xref linkend="libsoup3"/>,
|
---|
| 97 | <xref linkend="pygobject3"/>,
|
---|
[bbfc73c] | 98 | <xref linkend="sqlite"/>, and
|
---|
| 99 | <xref linkend="tracker3-miners"/> (runtime)
|
---|
[ec047148] | 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 103 | <para role="optional">
|
---|
[21d18f7e] | 104 | <xref linkend="asciidoc"/>,
|
---|
[7623a70] | 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 | -->
|
---|
[bed8a11c] | 109 | <xref linkend="graphviz"/>,
|
---|
[29cd7e3] | 110 | <xref linkend="libsoup"/>,
|
---|
[c3c692e6] | 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)-->
|
---|
[ec047148] | 115 | </para>
|
---|
| 116 |
|
---|
| 117 | </sect2>
|
---|
| 118 |
|
---|
| 119 | <sect2 role="installation">
|
---|
| 120 | <title>Installation of Tracker</title>
|
---|
| 121 |
|
---|
[7623a70] | 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;} &&
|
---|
| 127 | sed '/docs_name/s/Tracker-3.0/tracker-&tracker3-version;/' \
|
---|
| 128 | -i docs/reference/libtracker-sparql/meson.build</userinput></screen>
|
---|
| 129 |
|
---|
[ec047148] | 130 | <para>
|
---|
| 131 | Install <application>Tracker</application> by running the following
|
---|
| 132 | commands:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
| 136 | cd build &&
|
---|
| 137 |
|
---|
[7623a70] | 138 | meson setup --prefix=/usr \
|
---|
| 139 | --buildtype=release \
|
---|
| 140 | -Dman=false \
|
---|
[91318eb] | 141 | .. &&
|
---|
[ec047148] | 142 | ninja</userinput></screen>
|
---|
| 143 |
|
---|
| 144 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 145 | cd build &&
|
---|
| 146 |
|
---|
[91318eb] | 147 | meson setup --prefix=/usr \
|
---|
[7623a70] | 148 | --buildtype=release \
|
---|
[91318eb] | 149 | -Dman=false \
|
---|
| 150 | -Dsystemd_user_services=false \
|
---|
| 151 | .. &&
|
---|
[ec047148] | 152 | ninja</userinput></screen>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
| 155 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 156 | </para>
|
---|
| 157 |
|
---|
| 158 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 159 |
|
---|
[7623a70] | 160 | <para>
|
---|
| 161 | To test the results, issue: <command>meson configure -Ddebug=true
|
---|
| 162 | && ninja test</command>.
|
---|
| 163 | The test suite should be run from a graphical session. One test,
|
---|
| 164 | <filename>tracker: fts / fts</filename>, is known to fail due to an
|
---|
[ae69b0e] | 165 | incompatibility with SQLite-3.42.
|
---|
[7623a70] | 166 | </para>
|
---|
| 167 |
|
---|
[ec047148] | 168 | </sect2>
|
---|
| 169 |
|
---|
| 170 |
|
---|
| 171 | <sect2 role="commands">
|
---|
| 172 | <title>Command Explanations</title>
|
---|
| 173 |
|
---|
[adf17153] | 174 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 175 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[ec047148] | 176 |
|
---|
[21d18f7e] | 177 | <para>
|
---|
| 178 | <parameter>-Dman=false</parameter>: This switch prevents the build
|
---|
[aa0f6080] | 179 | process from generating man pages. Omit this switch if you have
|
---|
[21d18f7e] | 180 | <xref linkend="asciidoc" role="nodep"/> installed and wish to generate
|
---|
[aa0f6080] | 181 | and install the man pages.
|
---|
[21d18f7e] | 182 | </para>
|
---|
[8558044] | 183 |
|
---|
[ec047148] | 184 | <para revision="sysv">
|
---|
| 185 | <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
|
---|
| 186 | the build process from installing systemd user services since they are
|
---|
| 187 | useless on SysV systems.
|
---|
| 188 | </para>
|
---|
| 189 |
|
---|
[7623a70] | 190 | <para>
|
---|
| 191 | <command>meson configure -Ddebug=true</command>: This command enables
|
---|
| 192 | some debug checks necessary for the test suite. We don't want to
|
---|
| 193 | enable them for the installed Tracker 3 libraries and programs, so
|
---|
| 194 | we run the test suite after installation.
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
[ec047148] | 197 | </sect2>
|
---|
| 198 |
|
---|
| 199 |
|
---|
| 200 | <sect2 role="content">
|
---|
| 201 | <title>Contents</title>
|
---|
| 202 |
|
---|
| 203 | <segmentedlist>
|
---|
| 204 | <segtitle>Installed Programs</segtitle>
|
---|
| 205 | <segtitle>Installed Library</segtitle>
|
---|
| 206 | <segtitle>Installed Directories</segtitle>
|
---|
| 207 |
|
---|
| 208 | <seglistitem>
|
---|
| 209 | <seg>
|
---|
| 210 | tracker3
|
---|
| 211 | </seg>
|
---|
| 212 | <seg>
|
---|
| 213 | libtracker-sparql-3.0.so
|
---|
| 214 | </seg>
|
---|
| 215 | <seg>
|
---|
[3b339ddc] | 216 | /usr/{include,lib}/tracker-3.0,
|
---|
| 217 | /usr/libexec/tracker3,
|
---|
| 218 | /usr/share/tracker3, and
|
---|
[bed8a11c] | 219 | /usr/share/doc/Tracker-3.0 (optional)
|
---|
| 220 | <!-- Xi, when you change documentation, please change this path -->
|
---|
[ec047148] | 221 | </seg>
|
---|
| 222 | </seglistitem>
|
---|
| 223 | </segmentedlist>
|
---|
| 224 |
|
---|
| 225 | <variablelist>
|
---|
| 226 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 227 | <?dbfo list-presentation="list"?>
|
---|
| 228 | <?dbhtml list-presentation="table"?>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="tracker3-prog">
|
---|
| 231 | <term><command>tracker3</command></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
[4c24eb0a] | 234 | is a control program for the indexer
|
---|
[ec047148] | 235 | </para>
|
---|
| 236 | <indexterm zone="tracker3 tracker3-prog">
|
---|
| 237 | <primary sortas="b-tracker3">tracker3</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | <varlistentry id="libtracker3-sparql">
|
---|
| 243 | <term><filename class="libraryfile">libtracker-sparql-3.0.so</filename></term>
|
---|
| 244 | <listitem>
|
---|
| 245 | <para>
|
---|
[4c24eb0a] | 246 | contains resource management and database functions
|
---|
[ec047148] | 247 | </para>
|
---|
| 248 | <indexterm zone="tracker3 libtracker3-sparql">
|
---|
| 249 | <primary sortas="c-libtracker3-sparql">libtracker-sparql-3.0.so</primary>
|
---|
| 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
| 254 | </variablelist>
|
---|
| 255 |
|
---|
| 256 | </sect2>
|
---|
| 257 |
|
---|
| 258 | </sect1>
|
---|