From 37969cea8e243af6222f8c05471769e6db6ec774 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Fri, 16 Jan 2026 16:24:59 +0100 Subject: [PATCH] feedback-themes: Improve manpage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Explain relation between profiles, events and feedback a bit better. Signed-off-by: Guido Günther --- doc/feedback-themes.rst | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/feedback-themes.rst b/doc/feedback-themes.rst index a20122d..46a5414 100644 --- a/doc/feedback-themes.rst +++ b/doc/feedback-themes.rst @@ -17,17 +17,24 @@ currently active feedback theme. Each theme consists of up to three profile sections named `full`, `quiet` and `silent` containing event names and their associated feedback. They can reference another theme via the `parent-name` -element to avoid repetition. +element to avoid repetition. If an event received by the daemon is not +present in the currently active theme or its parent theme it will be +ignored. -The events in the theme are named according to the +Each event maps to at most one feedback in each profile. The events +in the theme are named according to the `Event Naming Specifiaction -`_ +`_. -Feedback themes use a JSON format that can be validated with +There are two types of themes: *custom* themes and *device* themes. +They both use the same format but have different purpose. Custom +themes are meant to tweak feebackd's output to the user's needs while +device themes are meant to cater for hardware differences. Feedback +themes use a JSON format that can be validated with ``fbd-theme-validate(1)``. For details on how to create or modify feedback themes see -``feedbackd's documentation`` at https://gitlab.freedesktop.org/agx/feedbackd#feedback-theme +``feedbackd's documentation`` at https://gitlab.freedesktop.org/agx/feedbackd#feedback-theme. Feedback types -------------- @@ -49,7 +56,7 @@ are described in the ``Sound theme spec`` at https://freedesktop.org/wiki/Specif - `event-name`: The sound event name to use. - `media-role`: The media role to set played audio stream. Defaults to `event`. -`Sound` feedback is usually used in the `full` profile section of the the theme only. +`Sound` feedback is usually used in the `full` profile section of the theme only. VibraRumble feedback ~~~~~~~~~~~~~~~~~~~~ @@ -61,7 +68,7 @@ The `VibraRumble` feedback uses a single property - `duration`: The duration of the rumble in ms. - `mangitude`: The relative magnitude of the rumble (``[0, 1]``). -`VibraRumble` feedback is usually used in the `quiet` profile section of the the theme only. +`VibraRumble` feedback is usually used in the `quiet` profile section of the theme only. VibraPattern feedback ~~~~~~~~~~~~~~~~~~~~~ @@ -85,7 +92,7 @@ The `Led` feedback type uses two properties to specify the way a LED blinks. each component. E.g. `#00FFFF` corresponds to cyan color. - `frequency`: The LEDs blinkinig frequency in mHz. -`Led` feedback is usually used in the `silent` profile section of the the theme only. +`Led` feedback is usually used in the `silent` profile section of the theme only. See also ========