BOOK/gnome/platform/tracker3.xml

   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
   8            "&gnome-download-http;/tracker/3.1/tracker-&tracker3-version;.tar.xz">
   9   <!ENTITY tracker3-download-ftp
  10            "&gnome-download-ftp;/tracker/3.1/tracker-&tracker3-version;.tar.xz">
  11   <!ENTITY tracker3-md5sum        "c7a502802f213a6cb9a7b2fc94ef47d1">
  12   <!ENTITY tracker3-size          "1.4 MB">
  13   <!ENTITY tracker3-buildsize     "81 MB (with tests)">
  14   <!ENTITY tracker3-time          "0.8 SBU (with tests)">
  15 ]>
  16
  17 <sect1 id="tracker3" xreflabel="Tracker-&tracker3-version;">
  18   <?dbhtml filename="tracker3.html"?>
  19
  20   <sect1info>
  21     <othername>$LastChangedBy$</othername>
  22     <date>$Date$</date>
  23   </sect1info>
  24
  25   <title>Tracker-&tracker3-version;</title>
  26
  27   <indexterm zone="tracker3">
  28     <primary sortas="a-Tracker3">Tracker3</primary>
  29   </indexterm>
  30
  31   <sect2 role="package">
  32     <title>Introduction to Tracker</title>
  33
  34     <para>
  35       <application>Tracker</application> is the file indexing and search
  36       provider used in the <application>GNOME</application> desktop environment.
  37     </para>
  38
  39     &lfs101_checked;
  40
  41     <bridgehead renderas="sect3">Package Information</bridgehead>
  42     <itemizedlist spacing="compact">
  43       <listitem>
  44         <para>
  45           Download (HTTP): <ulink url="&tracker3-download-http;"/>
  46         </para>
  47       </listitem>
  48       <listitem>
  49         <para>
  50           Download (FTP): <ulink url="&tracker3-download-ftp;"/>
  51         </para>
  52       </listitem>
  53       <listitem>
  54         <para>
  55           Download MD5 sum: &tracker3-md5sum;
  56         </para>
  57       </listitem>
  58       <listitem>
  59         <para>
  60           Download size: &tracker3-size;
  61         </para>
  62       </listitem>
  63       <listitem>
  64         <para>
  65           Estimated disk space required: &tracker3-buildsize;
  66         </para>
  67       </listitem>
  68       <listitem>
  69         <para>
  70           Estimated build time: &tracker3-time;
  71         </para>
  72       </listitem>
  73     </itemizedlist>
  74
  75 <!-- Not needed with 3.0.3, but keep around just in case
  76     <bridgehead renderas="sect3">Additional Downloads</bridgehead>
  77     <itemizedlist spacing="compact">
  78       <listitem>
  79         <para>
  80           Required patch:
  81           <ulink url="&patch-root;/tracker-&tracker3-version;-upstream_fixes-1.patch"/>
  82         </para>
  83       </listitem>
  84     </itemizedlist>
  85 -->
  86
  87     <bridgehead renderas="sect3">Tracker Dependencies</bridgehead>
  88
  89     <bridgehead renderas="sect4">Required</bridgehead>
  90     <para role="required">
  91       <xref linkend="json-glib"/>,
  92       <xref linkend="libseccomp"/>,
  93       <xref linkend="libsoup"/>, and
  94       <xref linkend="vala"/>
  95     </para>
  96
  97     <bridgehead renderas="sect4">Recommended</bridgehead>
  98     <para role="recommended">
  99       <xref linkend="gobject-introspection"/>,
 100       <xref linkend="icu"/>,
 101       <xref linkend="NetworkManager"/>,
 102       <xref linkend="sqlite"/>, and
 103       <xref linkend="upower"/>
 104     </para>
 105
 106     <bridgehead renderas="sect4">Optional</bridgehead>
 107     <para role="optional">
 108       <xref linkend="asciidoc"/>,
 109       <xref linkend="gtk-doc"/>,
 110       <ulink url="https://github.com/scop/bash-completion/">bash-completion</ulink>,
 111       <ulink url="https://github.com/snowballstem/snowball/">libstemmer</ulink>, and
 112       <ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
 113       (for tests)
 114       <!-- Python2 used to be a dependency until 2.2.1 -->
 115     </para>
 116
 117     <para condition="html" role="usernotes">User Notes:
 118       <ulink url="&blfs-wiki;/tracker3"/>
 119     </para>
 120   </sect2>
 121
 122   <sect2 role="installation">
 123     <title>Installation of Tracker</title>
 124
 125     <para>
 126       Install <application>Tracker</application> by running the following
 127       commands:
 128     </para>
 129
 130 <screen revision="systemd"><userinput>mkdir build &amp;&amp;
 131 cd    build &amp;&amp;
 132
 133 meson --prefix=/usr -Ddocs=false -Dman=false .. &amp;&amp;
 134 ninja</userinput></screen>
 135
 136 <screen revision="sysv"><userinput>mkdir build &amp;&amp;
 137 cd    build &amp;&amp;
 138
 139 meson --prefix=/usr -Ddocs=false -Dman=false -Dsystemd_user_services=false .. &amp;&amp;
 140 ninja</userinput></screen>
 141
 142     <para>
 143       To test the results, issue: <command>ninja test</command>. The tests
 144       should be run from a graphical session. One test,
 145       <filename>tracker:functional/portal</filename>, is known to timeout.
 146       14 tests will fail if the Python 3 module tap.py is not installed.
 147     </para>
 148
 149     <para>
 150       Now, as the <systemitem class="username">root</systemitem> user:
 151     </para>
 152
 153 <screen role="root"><userinput>ninja install</userinput></screen>
 154
 155   </sect2>
 156
 157
 158   <sect2 role="commands">
 159     <title>Command Explanations</title>
 160
 161     <para>
 162       <parameter>-Ddocs=false</parameter>: This switch prevents the
 163       build process from generating API documentation. Omit this switch if you
 164       have <xref linkend="gtk-doc" role="nodep"/> installed and wish to
 165       generate and install the API documentation.
 166     </para>
 167
 168     <para>
 169       <parameter>-Dman=false</parameter>: This switch prevents the build
 170       process from generating man pages. Omit this switch if you have
 171       <xref linkend="asciidoc" role="nodep"/> installed and wish to generate
 172       and install the man pages.
 173     </para>
 174
 175     <para revision="sysv">
 176       <parameter>-Dsystemd_user_services=false</parameter>: This switch prevents
 177       the build process from installing systemd user services since they are
 178       useless on SysV systems.
 179     </para>
 180
 181   </sect2>
 182
 183
 184   <sect2 role="content">
 185     <title>Contents</title>
 186
 187     <segmentedlist>
 188       <segtitle>Installed Programs</segtitle>
 189       <segtitle>Installed Library</segtitle>
 190       <segtitle>Installed Directories</segtitle>
 191
 192       <seglistitem>
 193         <seg>
 194           tracker3
 195         </seg>
 196         <seg>
 197           libtracker-sparql-3.0.so
 198         </seg>
 199         <seg>
 200           /usr/{include,lib}/tracker-3.0,
 201           /usr/libexec/tracker3,
 202           /usr/share/tracker3, and
 203           /usr/share/gtk-doc/html/{libtracker-sparql,ontology}-3
 204         </seg>
 205       </seglistitem>
 206     </segmentedlist>
 207
 208     <variablelist>
 209       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 210       <?dbfo list-presentation="list"?>
 211       <?dbhtml list-presentation="table"?>
 212
 213       <varlistentry id="tracker3-prog">
 214         <term><command>tracker3</command></term>
 215         <listitem>
 216           <para>
 217             is a control program for the indexer
 218           </para>
 219           <indexterm zone="tracker3 tracker3-prog">
 220             <primary sortas="b-tracker3">tracker3</primary>
 221           </indexterm>
 222         </listitem>
 223       </varlistentry>
 224
 225       <varlistentry id="libtracker3-sparql">
 226         <term><filename class="libraryfile">libtracker-sparql-3.0.so</filename></term>
 227         <listitem>
 228           <para>
 229             contains resource management and database functions
 230           </para>
 231           <indexterm zone="tracker3 libtracker3-sparql">
 232             <primary sortas="c-libtracker3-sparql">libtracker-sparql-3.0.so</primary>
 233           </indexterm>
 234         </listitem>
 235       </varlistentry>
 236
 237     </variablelist>
 238
 239   </sect2>
 240
 241 </sect1>