frameworks/baloo/README.md

0001 # Baloo
0002
0003 ## Introduction
0004
0005 Baloo is the file indexing and file search framework for KDE Plasma. It focuses
0006 on speed and a very small memory footprint. It maintains an index of your files
0007 and optionally their contents which [you can search](./docs/user/searching.md).
0008
0009 ## Contributing
0010
0011 Baloo is part of the KDE umbrella and relies on the KDE infrastructure.
0012
0013 **Mailing List:** kde-devel@kde.org ([info page](https://mail.kde.org/mailman/listinfo/kde-devel))
0014 **Bug Tracker:** http://bugs.kde.org  ([new bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo))
0015 **IRC Channel:** #kde-baloo on Libera Chat
0016
0017 The recommended way of contributing patches is via KDE's [GitLab](https://invent.kde.org/frameworks/baloo) instance.
0018
0019 ## Documentation
0020
0021 ### Users
0022 * [Searching](./docs/user/searching.md)
0023 * [The Baloo pages on KDE Community Wiki](https://community.kde.org/Baloo) has information on Baloo's command-line tools and how to monitor its operation.
0024
0025 ### File Indexing Plugins
0026
0027 Baloo relies on [KFileMetaData](https://api.kde.org/frameworks/kfilemetadata/html/index.html) to extract content and
0028 metadata from files. KFileMetadata uses a number file type specific plugins. In case individual
0029 plugins are packaged separately, we recommend installing all plugins.
0030
0031 Without the indexer plugins, Baloo cannot function to its full potential.
0032
0033 ### Developers
0034 [![Build Status](https://build.kde.org/job/Frameworks/job/baloo/job/kf5-qt5%20SUSEQt5.15/badge/icon?subject=SUSE%20Qt5.15)](https://build.kde.org/job/Frameworks/job/baloo/job/kf5-qt5%20SUSEQt5.15/)
0035 [![Build Status](https://build.kde.org/job/Frameworks/job/baloo/job/kf5-qt5%20FreeBSDQt5.15/badge/icon?subject=FreeBSD%20Qt5.15)](https://build.kde.org/job/Frameworks/job/baloo/job/kf5-qt5%20FreeBSDQt5.15/)
0036 * [Build Instructions](@ref build-instructions)
0037 * Baloo follows the [KDE Frameworks coding style](https://community.kde.org/Policies/Frameworks_Coding_Style).
0038
0039 ### Distributions
0040 Baloo is developed and tested exclusively for Linux. While it may run on other
0041 unix based systems. It is not recommended, and certainly not tested.
0042
0043 We do not recommend to package Baloo for Windows or OSX as both these operating
0044 systems offer their own file searching solutions which better integrate with
0045 the native system than Baloo ever will.
0046
0047 Baloo may run on 32-bit systems, but it has not been tested and may not work
0048 correctly. Please test and let us know by [filing a bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo).
0049
0050 **Supported Kernels:** Linux
0051 **Supported Architectures:** x86_64, aarch64
0052 **Supported Filesystems:** ext3/4, Btrfs, XFS
0053
0054 #### Packaging the indexer service
0055
0056 The service is an autostarted, session wide background service. In case KF5 and KF6
0057 versions of the Baloo libraries are installed, both will use the same service and
0058 database.
0059
0060 Only one version of the service autostart file and associated binaries should be
0061 installed at a time, i.e. the `baloo_file.desktop` service definition, the `baloo_file`
0062 service binary, the `baloo_file_extractor` helper, and the `balooctl` tool.
0063
0064 Building of the service can be disabled using the `BUILD_INDEXER_SERVICE` CMake option.