Warning, /frameworks/baloo/README.md is written in an unsupported language. File is not indexed.
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:** email@example.com ([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) have information on Baloo's command-line tools and how to monitor its operation. 0024 0025 0026 ### Developers 0027 [![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/) 0028 [![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/) 0029 * [Build Instructions](@ref build-instructions) 0030 * Baloo follows the [KDE Frameworks coding style](https://community.kde.org/Policies/Frameworks_Coding_Style). 0031 0032 ### Distributions 0033 Baloo is developed and tested exclusively for Linux. While it may run on other 0034 unix based systems. It is not recommended, and certainly not tested. 0035 0036 We do not recommend to package Baloo for Windows or OSX as both these operating 0037 systems offer their own file searching solutions which better integrate with 0038 the native system than Baloo ever will. 0039 0040 Baloo may run on 32-bit systems, but it has not been tested and may not work 0041 correctly. Please test and let us know by [filing a bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo). 0042 0043 **Supported Kernels:** Linux 0044 **Supported Architectures:** x86_64, aarch64 0045 **Supported Filesystems:** ext3/4, Btrfs, XFS 0046 0047 ###### File Indexing Plugins 0048 0049 Baloo relies on [KFileMetaData](https://api.kde.org/frameworks/kfilemetadata/html/index.html) to extract content from the files. KFileMetadata 0050 ships with a number of plugins which can be enabled or disabled. We recommend 0051 shipping all KFileMetaData plugins. Specially ffmpeg by default. Without the indexers, 0052 Baloo cannot function to its full potential.