[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[ec047148] | 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 |
|
---|
[8dd1b0d] | 7 | <!ENTITY localsearch-download-http "&gnome-download-http;/localsearch/3.8/localsearch-&localsearch-version;.tar.xz">
|
---|
| 8 | <!ENTITY localsearch-download-ftp " ">
|
---|
| 9 | <!ENTITY localsearch-md5sum "b9aa37c729509b6abc94fc6dedc99058">
|
---|
| 10 | <!ENTITY localsearch-size "4.3 MB">
|
---|
| 11 | <!ENTITY localsearch-buildsize "43 MB (with tests)">
|
---|
| 12 | <!ENTITY localsearch-time "0.4 SBU (with parallelism=4; add as much as 1.0 SBU for tests, dependent on disk speed)">
|
---|
[ec047148] | 13 | ]>
|
---|
| 14 |
|
---|
[8dd1b0d] | 15 | <sect1 id="localsearch" xreflabel="localsearch-&localsearch-version;">
|
---|
| 16 | <?dbhtml filename="localsearch.html"?>
|
---|
[ec047148] | 17 |
|
---|
| 18 |
|
---|
[8dd1b0d] | 19 | <title>localsearch-&localsearch-version;</title>
|
---|
[ec047148] | 20 |
|
---|
[8dd1b0d] | 21 | <indexterm zone="localsearch">
|
---|
| 22 | <primary sortas="a-localsearch">localsearch</primary>
|
---|
[ec047148] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[8dd1b0d] | 26 | <title>Introduction to Localsearch</title>
|
---|
[ec047148] | 27 |
|
---|
| 28 | <para>
|
---|
[8dd1b0d] | 29 | The <application>Localsearch</application> package contains a filesystem
|
---|
| 30 | indexer as well as a metadata extractor.
|
---|
[ec047148] | 31 | </para>
|
---|
| 32 |
|
---|
[5eaa870e] | 33 | &lfs122_checked;
|
---|
[ec047148] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
[8dd1b0d] | 39 | Download (HTTP): <ulink url="&localsearch-download-http;"/>
|
---|
[ec047148] | 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
[8dd1b0d] | 44 | Download (FTP): <ulink url="&localsearch-download-ftp;"/>
|
---|
[ec047148] | 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
[8dd1b0d] | 49 | Download MD5 sum: &localsearch-md5sum;
|
---|
[ec047148] | 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
[8dd1b0d] | 54 | Download size: &localsearch-size;
|
---|
[ec047148] | 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
[8dd1b0d] | 59 | Estimated disk space required: &localsearch-buildsize;
|
---|
[ec047148] | 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
[8dd1b0d] | 64 | Estimated build time: &localsearch-time;
|
---|
[ec047148] | 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
[8558044] | 68 |
|
---|
[8dd1b0d] | 69 | <bridgehead renderas="sect3">Localsearch Dependencies</bridgehead>
|
---|
[ec047148] | 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
| 73 | <xref linkend="gst10-plugins-base"/>,
|
---|
[8dd1b0d] | 74 | <xref linkend="tinysparql"/>,
|
---|
[ec047148] | 75 | <xref linkend="exempi"/>, and
|
---|
| 76 | <xref linkend="gexiv2"/>
|
---|
| 77 | </para>
|
---|
| 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 80 | <para role="recommended">
|
---|
| 81 | <xref linkend="giflib"/>,
|
---|
[4974cb5] | 82 | <xref role='runtime' linkend="gst10-plugins-good"/> (runtime),
|
---|
| 83 | <xref role='runtime' linkend="gst10-libav"/> (runtime),
|
---|
[ec047148] | 84 | <xref linkend="icu"/>,
|
---|
| 85 | <xref linkend="libexif"/>,
|
---|
[aa36625] | 86 | <xref linkend="libgxps"/>,
|
---|
[7ff805c3] | 87 | <xref linkend="libseccomp"/>,
|
---|
| 88 | <xref linkend="poppler"/>, and
|
---|
| 89 | <xref linkend="upower"/>
|
---|
[ec047148] | 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 93 | <para role="optional">
|
---|
[21d18f7e] | 94 | <xref linkend="asciidoc"/>,
|
---|
[ec047148] | 95 | <xref linkend="cmake"/>,
|
---|
| 96 | <xref linkend="dconf"/>,
|
---|
[4974cb5] | 97 | <xref linkend="ffmpeg"/>,
|
---|
[ec047148] | 98 | <xref linkend="libgsf"/>,
|
---|
[3a0324c] | 99 | <xref linkend="NetworkManager"/>,
|
---|
[ec047148] | 100 | <xref linkend="taglib"/>,
|
---|
| 101 | <xref linkend="totem-pl-parser"/>,
|
---|
| 102 | <ulink url="https://github.com/lipnitsk/libcue">libcue</ulink>,
|
---|
[3cf21db] | 103 | <ulink url="https://gitlab.gnome.org/GNOME/libgrss">libgrss</ulink>,
|
---|
[17aa21c] | 104 | <ulink url="https://libiptcdata.sourceforge.net/">libitpcdata</ulink>,
|
---|
[c3c692e6] | 105 | <ulink url="https://libosinfo.org">libosinfo</ulink>, and
|
---|
| 106 | <ulink url="https://gitlab.gnome.org/GNOME/gupnp">gupnp</ulink>
|
---|
[ec047148] | 107 | </para>
|
---|
| 108 |
|
---|
| 109 | </sect2>
|
---|
| 110 |
|
---|
[8dd1b0d] | 111 | <sect2 role="kernel" id="localsearch-kernel">
|
---|
[20be11fa] | 112 | <title>Kernel Configuration</title>
|
---|
| 113 |
|
---|
| 114 | <para>
|
---|
| 115 | Enable the following options in the kernel configuration, then recompile
|
---|
| 116 | the kernel and reboot if necessary:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[8dd1b0d] | 120 | href="localsearch-kernel.xml"/>
|
---|
[20be11fa] | 121 |
|
---|
[8dd1b0d] | 122 | <indexterm zone="localsearch localsearch-kernel">
|
---|
| 123 | <primary sortas="d-localsearch">localsearch</primary>
|
---|
[20be11fa] | 124 | </indexterm>
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
[ec047148] | 127 | <sect2 role="installation">
|
---|
[8dd1b0d] | 128 | <title>Installation of Localsearch</title>
|
---|
| 129 |
|
---|
| 130 | <warning>
|
---|
| 131 | <para>
|
---|
| 132 | If you are upgrading this package from a version where it was known as
|
---|
| 133 | <application>tracker-miners</application>, there are several files
|
---|
| 134 | which will cause conflicts. Before installing this package, remove
|
---|
| 135 | these files as the &root; user:
|
---|
| 136 | </para>
|
---|
| 137 | </warning>
|
---|
| 138 |
|
---|
| 139 | <screen role="root"><userinput remap="pre">rm -fv /etc/xdg/autostart/tracker-miner-fs-3.desktop &&
|
---|
| 140 | rm -fv /usr/lib/systemd/user/tracker-miner-fs-3.service &&
|
---|
| 141 | rm -fv /usr/lib/systemd/user/tracker-miner-fs-control-3.service &&
|
---|
| 142 | rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Miner.Files.service &&
|
---|
| 143 | rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Writeback.service &&
|
---|
| 144 | rm -fv /usr/share/dbus-1/services/org.freedesktop.Tracker3.Miner.Files.Control.service</userinput></screen>
|
---|
[ec047148] | 145 |
|
---|
[aa36625] | 146 | <note>
|
---|
| 147 | <para>
|
---|
| 148 | If you plan to run the tests, some timeouts are too short when
|
---|
| 149 | using spinning disks. There are two places where timeouts are
|
---|
| 150 | used: first, individual tests inside a group of tests have a
|
---|
| 151 | default timeout of 10s. This can be changed by setting the environment
|
---|
| 152 | variable <envar>TRACKER_TESTS_AWAIT_TIMEOUT</envar> to the desired
|
---|
| 153 | value when running the tests (see below). Second, a global timeout
|
---|
| 154 | for a group of tests is fixed at configuration time. The default value
|
---|
| 155 | in the <filename class="directory">functional-tests</filename>
|
---|
| 156 | directory (other directories have only short lived tests) may be
|
---|
| 157 | increased with the following command (replace 200 with a value
|
---|
| 158 | suitable for your machine):
|
---|
| 159 | </para>
|
---|
[674cb17] | 160 |
|
---|
| 161 | <screen remap="test"><userinput>sed -i s/120/<replaceable>200</replaceable>/ tests/functional-tests/meson.build</userinput></screen>
|
---|
[aa36625] | 162 | </note>
|
---|
[674cb17] | 163 |
|
---|
[219e2d6] | 164 | <para>
|
---|
[8dd1b0d] | 165 | Install <application>Localsearch</application> by running the following
|
---|
[ec047148] | 166 | commands:
|
---|
| 167 | </para>
|
---|
| 168 |
|
---|
| 169 |
|
---|
| 170 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
| 171 | cd build &&
|
---|
| 172 |
|
---|
[91318eb] | 173 | meson setup --prefix=/usr \
|
---|
| 174 | --buildtype=release \
|
---|
[9612d4f3] | 175 | -D man=false \
|
---|
[3cf21db] | 176 | -D miner_rss=false \
|
---|
[91318eb] | 177 | .. &&
|
---|
[ec047148] | 178 | ninja</userinput></screen>
|
---|
| 179 |
|
---|
| 180 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 181 | cd build &&
|
---|
| 182 |
|
---|
[9612d4f3] | 183 | meson setup --prefix=/usr \
|
---|
| 184 | --buildtype=release \
|
---|
| 185 | -D systemd_user_services=false \
|
---|
| 186 | -D man=false \
|
---|
[3cf21db] | 187 | -D miner_rss=false \
|
---|
[9612d4f3] | 188 | .. &&
|
---|
[ec047148] | 189 | ninja</userinput></screen>
|
---|
| 190 |
|
---|
[9612d4f3] | 191 |
|
---|
| 192 | <para>
|
---|
| 193 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 194 | </para>
|
---|
| 195 |
|
---|
| 196 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 197 |
|
---|
[ec047148] | 198 | <para>
|
---|
[674cb17] | 199 | To test the results, issue (adjust the individual test timeout to a
|
---|
[aa36625] | 200 | value suitable for your machine, see the note above):
|
---|
[ec047148] | 201 | </para>
|
---|
| 202 |
|
---|
[9612d4f3] | 203 | <screen remap="test"><userinput>meson configure -D debug=true &&
|
---|
| 204 | dbus-run-session env LC_ALL=C.UTF-8 TRACKER_TESTS_AWAIT_TIMEOUT=<replaceable>20</replaceable> \
|
---|
| 205 | ninja test &&
|
---|
[cac5f30] | 206 | rm -rf ~/tracker-tests</userinput></screen>
|
---|
| 207 |
|
---|
| 208 | <note>
|
---|
| 209 | <para>
|
---|
| 210 | The tests create files in the user directory (up to 24 MB), so
|
---|
| 211 | they have to be removed afterwards.
|
---|
| 212 | </para>
|
---|
| 213 | </note>
|
---|
[ec047148] | 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | <sect2 role="commands">
|
---|
| 217 | <title>Command Explanations</title>
|
---|
| 218 |
|
---|
[adf17153] | 219 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 220 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 221 |
|
---|
[21d18f7e] | 222 | <para>
|
---|
[9612d4f3] | 223 | <parameter>-D man=false</parameter>: This switch prevents the build process
|
---|
[a58c8ee] | 224 | from generating man pages. Omit this switch if you have
|
---|
[21d18f7e] | 225 | <xref linkend="asciidoc" role="nodep"/> installed and wish to generate and
|
---|
[a58c8ee] | 226 | install the man pages.
|
---|
[21d18f7e] | 227 | </para>
|
---|
| 228 |
|
---|
[3cf21db] | 229 | <para>
|
---|
| 230 | <parameter>-D miner_rss=false</parameter>: This switch prevents using
|
---|
| 231 | libgrss for indexing RSS feeds because libgrss is insecure and no longer
|
---|
| 232 | in BLFS.
|
---|
| 233 | </para>
|
---|
| 234 |
|
---|
[ec047148] | 235 | <para revision="sysv">
|
---|
[9612d4f3] | 236 | <parameter>-D systemd_user_services=false</parameter>: This switch prevents
|
---|
[ec047148] | 237 | the build process from installing systemd units since they are useless
|
---|
| 238 | on SysV systems.
|
---|
| 239 | </para>
|
---|
| 240 |
|
---|
[600a1b25] | 241 | <para>
|
---|
[9612d4f3] | 242 | <option>-D seccomp=false</option>: This option disables the seccomp system
|
---|
[600a1b25] | 243 | call filter. On some architectures, such as i686 and ARM, the functions
|
---|
| 244 | that tracker-miners uses are not guarded properly, and tracker-miners
|
---|
[20be11fa] | 245 | will get killed with a SIGSYS as a result. Note that disabling
|
---|
[69f44a21] | 246 | seccomp may cause the system to be compromised worse in the event that a
|
---|
[8dd1b0d] | 247 | security vulnerability in localsearch or its dependencies is
|
---|
[20be11fa] | 248 | exploited.
|
---|
| 249 | </para>
|
---|
| 250 |
|
---|
| 251 | <para>
|
---|
[9612d4f3] | 252 | <option>-D landlock=disabled</option>: This switch disables the
|
---|
[20be11fa] | 253 | Landlock file access sandbox. Use it if you don't want to build the
|
---|
[69f44a21] | 254 | kernel with Landlock support. Note that disabling Landlock may
|
---|
| 255 | cause the system to be compromised worse in the event that a security
|
---|
[8dd1b0d] | 256 | vulnerability in localsearch or its dependencies is exploited.
|
---|
[600a1b25] | 257 | </para>
|
---|
| 258 |
|
---|
[7ff805c3] | 259 | <para>
|
---|
[9612d4f3] | 260 | <option>-D battery_detection=none</option>: Use this option if you have
|
---|
[7ff805c3] | 261 | not installed the recommended dependency upower. Do not use this
|
---|
| 262 | option if your system has a battery (laptop battery or UPS), or
|
---|
[8dd1b0d] | 263 | localsearch may waste the battery power and lifespan when the A/C
|
---|
[7ff805c3] | 264 | power is unavailable.
|
---|
| 265 | </para>
|
---|
| 266 |
|
---|
[ec047148] | 267 | </sect2>
|
---|
| 268 |
|
---|
| 269 | <sect2 role="content">
|
---|
| 270 | <title>Contents</title>
|
---|
| 271 |
|
---|
| 272 | <segmentedlist>
|
---|
| 273 | <segtitle>Installed Programs</segtitle>
|
---|
| 274 | <segtitle>Installed Libraries</segtitle>
|
---|
| 275 | <segtitle>Installed Directories</segtitle>
|
---|
| 276 |
|
---|
| 277 | <seglistitem>
|
---|
| 278 | <seg>
|
---|
[8dd1b0d] | 279 | localsearch
|
---|
[ec047148] | 280 | </seg>
|
---|
| 281 | <seg>
|
---|
[8dd1b0d] | 282 | Several modules under /usr/lib/localsearch-3.0
|
---|
[ec047148] | 283 | </seg>
|
---|
| 284 | <seg>
|
---|
[8dd1b0d] | 285 | /usr/lib/localsearch-3.0 and
|
---|
| 286 | /usr/share/localsearch
|
---|
[ec047148] | 287 | </seg>
|
---|
| 288 | </seglistitem>
|
---|
| 289 | </segmentedlist>
|
---|
[6256f2f7] | 290 |
|
---|
| 291 | <variablelist>
|
---|
| 292 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 293 | <?dbfo list-presnetation="list"?>
|
---|
| 294 | <?dbhtml list-presentation="table"?>
|
---|
| 295 |
|
---|
[8dd1b0d] | 296 | <varlistentry id="localsearch-prog">
|
---|
| 297 | <term><command>localsearch</command></term>
|
---|
[6256f2f7] | 298 | <listitem>
|
---|
| 299 | <para>
|
---|
| 300 | starts, stops, restarts, and lists daemons responsible for indexing
|
---|
| 301 | content
|
---|
| 302 | </para>
|
---|
[8dd1b0d] | 303 | <indexterm zone="localsearch localsearch-prog">
|
---|
| 304 | <primary sortas="b-localsearch">localsearch</primary>
|
---|
[6256f2f7] | 305 | </indexterm>
|
---|
| 306 | </listitem>
|
---|
| 307 | </varlistentry>
|
---|
| 308 | </variablelist>
|
---|
[8dd1b0d] | 309 |
|
---|
[ec047148] | 310 | </sect2>
|
---|
[4c24eb0a] | 311 |
|
---|
[ec047148] | 312 | </sect1>
|
---|