source: gnome/platform/localsearch.xml@ 601beb9b

<?xml version="1.0" encoding="UTF-8"?>
<!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 localsearch-download-http "&gnome-download-http;/localsearch/3.8/localsearch-&localsearch-version;.tar.xz">
  <!ENTITY localsearch-download-ftp  " ">
  <!ENTITY localsearch-md5sum        "b9aa37c729509b6abc94fc6dedc99058">
  <!ENTITY localsearch-size          "4.3 MB">
  <!ENTITY localsearch-buildsize     "43 MB (with tests)">
  <!ENTITY localsearch-time          "0.4 SBU (with parallelism=4; add as much as 1.0 SBU for tests, dependent on disk speed)">
]>

<sect1 id="localsearch" xreflabel="localsearch-&localsearch-version;">
  <?dbhtml filename="localsearch.html"?>


  <title>localsearch-&localsearch-version;</title>

  <indexterm zone="localsearch">
    <primary sortas="a-localsearch">localsearch</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Localsearch</title>

    <para>
      The <application>Localsearch</application> package contains a filesystem
      indexer as well as a metadata extractor.
    </para>

    &lfs122_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&localsearch-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&localsearch-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &localsearch-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &localsearch-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &localsearch-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &localsearch-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Localsearch Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="tinysparql"/>,
      <xref linkend="exempi"/>, and
      <xref linkend="gexiv2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="giflib"/>,
      <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
      <xref role='runtime' linkend="gst10-libav"/> (runtime),
      <xref linkend="icu"/>,
      <xref linkend="libexif"/>,
      <xref linkend="libgxps"/>,
      <xref linkend="libseccomp"/>,
      <xref linkend="poppler"/>, and
      <xref linkend="upower"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="asciidoc"/>,
      <xref linkend="cmake"/>,
      <xref linkend="dconf"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="libgsf"/>,
      <xref linkend="NetworkManager"/>,
      <xref linkend="taglib"/>,
      <xref linkend="totem-pl-parser"/>,
      <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
      <ulink url="https://gitlab.gnome.org/GNOME/libgrss">libgrss</ulink>,
      <ulink url="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
      <ulink url="https://libosinfo.org">libosinfo</ulink>, and
      <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
    </para>

  </sect2>

  <sect2 role="kernel" id="localsearch-kernel">
    <title>Kernel Configuration</title>

    <para>
      Enable the following options in the kernel configuration, then recompile
      the kernel and reboot if necessary:
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="localsearch-kernel.xml"/>

    <indexterm zone="localsearch localsearch-kernel">
      <primary sortas="d-localsearch">localsearch</primary>
    </indexterm>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Localsearch</title>

    <warning>
      <para>
        If you are upgrading this package from a version where it was known as
        <application>tracker-miners</application>, there are several files
        which will cause conflicts. Before installing this package, remove
        these files as the &root; user:
      </para>
    </warning>

<screen role="root"><userinput remap="pre">rm -fv /etc/xdg/autostart/tracker-miner-fs-3.desktop                           &amp;&amp;
rm -fv /usr/lib/systemd/user/tracker-miner-fs-3.service                        &amp;&amp;
rm -fv /usr/lib/systemd/user/tracker-miner-fs-control-3.service                &amp;&amp;
rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Miner.Files.service &amp;&amp;
rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Writeback.service   &amp;&amp;
rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Miner.Files.Control.service</userinput></screen>

    <note>
      <para>
        If you plan to run the tests, some timeouts are too short when
        using spinning disks. There are two places where timeouts are
        used: first, individual tests inside a group of tests have a
        default timeout of 10s. This can be changed by setting the environment
        variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
        value when running the tests (see below). Second, a global timeout
        for a group of tests is fixed at configuration time. The default value
        in the <filename class="directory">functional-tests</filename>
        directory (other directories have only short lived tests) may be
        increased with the following command (replace 200 with a value
        suitable for your machine):
      </para>

<screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
    </note>

    <para>
      Install <application>Localsearch</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 \
            -D man=false        \
            -D miner_rss=false  \
            ..                  &amp;&amp;
ninja</userinput></screen>

<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr                  \
            --buildtype=release            \
            -D systemd_user_services=false \
            -D man=false                   \
            -D miner_rss=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 (adjust the individual test timeout to a
      value suitable for your machine, see the note above):
    </para>

<screen remap="test"><userinput>meson configure -D debug=true &amp;&amp;
dbus-run-session env LC_ALL=C.UTF-8 TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> \
                 ninja test &amp;&amp;
rm -rf ~/tracker-tests</userinput></screen>

    <note>
      <para>
        The tests create files in the user directory (up to 24 MB), so
        they have to be removed afterwards.
      </para>
    </note>
  </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>-D man=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>
      <parameter>-D miner_rss=false</parameter>: This switch prevents using
      libgrss for indexing RSS feeds because libgrss is insecure and no longer
      in BLFS.
    </para>

    <para revision="sysv">
      <parameter>-D systemd_user_services=false</parameter>: This switch prevents
      the build process from installing systemd units since they are useless
      on SysV systems.
    </para>

    <para>
      <option>-D seccomp=false</option>: This option disables the seccomp system
      call filter. On some architectures, such as i686 and ARM, the functions
      that tracker-miners uses are not guarded properly, and tracker-miners
      will get killed with a SIGSYS as a result.  Note that disabling
      seccomp may cause the system to be compromised worse in the event that a
      security vulnerability in localsearch or its dependencies is
      exploited.
    </para>

    <para>
      <option>-D landlock=disabled</option>: This switch disables the
      Landlock file access sandbox.  Use it if you don't want to build the
      kernel with Landlock support.  Note that disabling Landlock may
      cause the system to be compromised worse in the event that a security
      vulnerability in localsearch or its dependencies is exploited.
    </para>

    <para>
      <option>-D battery_detection=none</option>: Use this option if you have
      not installed the recommended dependency upower.  Do not use this
      option if your system has a battery (laptop battery or UPS), or
      localsearch may waste the battery power and lifespan when the A/C
      power is unavailable.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          localsearch
        </seg>
        <seg>
          Several modules under /usr/lib/localsearch-3.0
        </seg>
        <seg>
          /usr/lib/localsearch-3.0 and
          /usr/share/localsearch
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presnetation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="localsearch-prog">
        <term><command>localsearch</command></term>
        <listitem>
          <para>
            starts, stops, restarts, and lists daemons responsible for indexing
            content
          </para>
          <indexterm zone="localsearch localsearch-prog">
            <primary sortas="b-localsearch">localsearch</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>