Baloo: Difference between revisions

From KDE Community Wiki
No edit summary
(Add note on `balooctl checkDb`)
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[https://projects.kde.org/projects/frameworks/baloo Baloo] is the file indexing and file search framework for KDE.
[[File:Mascot konqi-support-search.png|thumbnail|right|Help [[Konqi]] find what he wants!]]
[https://projects.kde.org/projects/frameworks/baloo Baloo] is the file indexing and file search framework for KDE Plasma.


:Mailing List: [email protected] ([https://mail.kde.org/mailman/listinfo/kde-devel info page])
:Mailing List: [email protected] ([https://mail.kde.org/mailman/listinfo/kde-devel info page])
Line 8: Line 9:
== Useful pages ==
== Useful pages ==
* [[Baloo/Architecture | Architecture]]
* [[Baloo/Architecture | Architecture]]
* [[Baloo/Configuration]]
* [[Baloo/Debugging]]
* [[Baloo/Debugging]]
* [[Baloo/NepomukPort]]
* [[Baloo/NepomukPort]]
* [[Baloo/Tasks]]
* [[Baloo/Tasks]]
* [[Baloo/XapianAlternatives]]
* [[Baloo/XapianAlternatives]]
* [[Baloo/XapianProblems]]


== Using Baloo ==
== Using Baloo ==
Line 18: Line 21:


An [http://vhanda.in/blog/2014/04/desktop-search-configuration/ intentionally limited number of settings] are provided via the KDE System Settings "Desktop Search" icon.  Other adjustments can be made directly to the [[Baloo/Configuration | configuration file]].
An [http://vhanda.in/blog/2014/04/desktop-search-configuration/ intentionally limited number of settings] are provided via the KDE System Settings "Desktop Search" icon.  Other adjustments can be made directly to the [[Baloo/Configuration | configuration file]].
== balooctl ==
<code>balooctl</code> is a CLI command to perform certain operations on Baloo. The operations are indicated by '''arguments'''. All available arguments can be listed by issuing <code>balooctl --help</code> in terminal app, such as [[userbase:Konsole]].
To be noted, argument <code>checkDb</code> is only meant to be used by developers for debugging. All it does is to print some messages but not to sanitize the database. And the execution time grows exponentially with the number of indexed files (see [https://bugs.kde.org/show_bug.cgi?id=380465#c5 Comment 5 under bug #380465]).

Revision as of 19:37, 23 February 2018

Help Konqi find what he wants!

Baloo is the file indexing and file search framework for KDE Plasma.

Mailing List: [email protected] (info page)
IRC Channel: #kde-baloo on freenode

Baloo focuses on providing a very small memory footprint along with with extremely fast searching.

Useful pages

Using Baloo

Baloo is not an application, but a daemon to index files. Applications can use the Baloo framework to provide file search results.

An intentionally limited number of settings are provided via the KDE System Settings "Desktop Search" icon. Other adjustments can be made directly to the configuration file.

balooctl

balooctl is a CLI command to perform certain operations on Baloo. The operations are indicated by arguments. All available arguments can be listed by issuing balooctl --help in terminal app, such as userbase:Konsole.

To be noted, argument checkDb is only meant to be used by developers for debugging. All it does is to print some messages but not to sanitize the database. And the execution time grows exponentially with the number of indexed files (see Comment 5 under bug #380465).