README.md 2.54 KB
Newer Older
Vishesh Handa's avatar
Vishesh Handa committed
1
2
# Baloo

David Faure's avatar
David Faure committed
3
## Introduction
4

5
6
Baloo is the file indexing and file search framework for KDE Plasma. It focuses 
on speed and a very small memory footprint. It maintains an index of your files 
7
and optionally their contents which [you can search](./docs/user/searching.md).
Vishesh Handa's avatar
Vishesh Handa committed
8

Vishesh Handa's avatar
Vishesh Handa committed
9
## Contributing
Vishesh Handa's avatar
Vishesh Handa committed
10

Méven Car's avatar
Méven Car committed
11
Baloo is part of the KDE umbrella and relies on the KDE infrastructure.
Vishesh Handa's avatar
Vishesh Handa committed
12

13
**Mailing List:** kde-devel@kde.org ([info page](https://mail.kde.org/mailman/listinfo/kde-devel))
14
**Bug Tracker:** http://bugs.kde.org  ([new bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo))
15
**IRC Channel:** #kde-baloo on Libera Chat
Vishesh Handa's avatar
Vishesh Handa committed
16

17
The recommended way of contributing patches is via KDE's [GitLab](https://invent.kde.org/frameworks/baloo) instance.
Vishesh Handa's avatar
Vishesh Handa committed
18

Vishesh Handa's avatar
Vishesh Handa committed
19
## Documentation
Vishesh Handa's avatar
Vishesh Handa committed
20

Vishesh Handa's avatar
Vishesh Handa committed
21
### Users
22
* [Searching](./docs/user/searching.md)
23
24
* [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.

David Faure's avatar
David Faure committed
25

Vishesh Handa's avatar
Vishesh Handa committed
26
### Developers
27
28
[![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/)
[![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/)
29
* [Build Instructions](@ref build-instructions)
30
* Baloo follows the [KDE Frameworks coding style](https://community.kde.org/Policies/Frameworks_Coding_Style).
Vishesh Handa's avatar
Vishesh Handa committed
31
32

### Distributions
33
34
35
36
37
38
39
40
41
42
43
Baloo is developed and tested exclusively for Linux. While it may run on other
unix based systems. It is not recommended, and certainly not tested.

We do not recommend to package Baloo for Windows or OSX as both these operating
systems offer their own file searching solutions which better integrate with
the native system than Baloo ever will.

Baloo may run on 32-bit systems, but it has not been tested and may not work
correctly. Please test and let us know by [filing a bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo).

**Supported Kernels:** Linux
44
45
**Supported Architectures:** x86_64, aarch64
**Supported Filesystems:** ext3/4, Btrfs, XFS
46
47
48
49
50
51
52

###### File Indexing Plugins

Baloo relies on [KFileMetaData](https://api.kde.org/frameworks/kfilemetadata/html/index.html) to extract content from the files. KFileMetadata
ships with a number of plugins which can be enabled or disabled. We recommend
shipping all KFileMetaData plugins. Specially ffmpeg by default. Without the indexers, 
Baloo cannot function to its full potential.