doc: Clarify theme use

Signed-off-by: Guido Günther <agx@sigxcpu.org>
This commit is contained in:
Guido Günther
2025-04-24 12:57:24 +02:00
parent eb2cb76635
commit 84b783cbf7
3 changed files with 24 additions and 16 deletions
+12 -4
View File
@@ -11,10 +11,18 @@ Theme configuration for feedbackd
DESCRIPTION
-----------
In order to reflect device specifics and user overrides the feedback
(such as sound, haptic or led) that is being triggered by an event can
be configured and overridden by so called themes. Feedback themes use a JSON
format that can be validated with ``fbd-theme-validate``.
The feedback provided to the user for an event is determined by the
feedback theme. Each theme consists of up to three profiles (`full`,
`quiet` and `silent`) containing event names and their associated
feedback.
Events in the theme are named according to the
`Event Naming Specifiaction
<https://gitlab.freedesktop.org/agx/feedbackd/-/blob/main/doc/Event-naming-spec-0.0.0.md>`_
Feedback themes use a JSON format that can be validated with
``fbd-theme-validate(1)``. They can include other themes to avoid
repetition.
For details on how to create or modify feedback themes see
``feedbackd's documentation`` at https://gitlab.freedesktop.org/agx/feedbackd#feedback-theme
+6 -4
View File
@@ -21,14 +21,14 @@ event feedback such as playing a sound, trigger a haptic motor or blink
a LED.
The feedback triggered by a given event is determined by the feedback theme in
use. Events are submitted via a DBus API.
use (see `feedback-themes(5)`). Events are submitted via a DBus API.
Any feedback triggered by a client via an event will be stopped latest when the
client disconnects from DBus. This makes sure all feedbacks get canceled if the
app that triggered it crashes.
For details refer to the event and feedback theme specs at
`<https://gitlab.freedesktop.org/agx/feedbackd/>`__
`<https://gitlab.freedesktop.org/agx/feedbackd/>`__.
Feedbackd reloads the feedback theme on `SIGHUP` (i.e. `pkill -HUP feedbackd`).
@@ -49,7 +49,8 @@ These gsettings are used by ``feedbackd``:
- `org.sigxcpu.feedbackd`
- `profile`: The current overall feedback profile
- `profile`: The current overall feedback profile. Valid values are
`full`, `quiet` and `silent`.
- `allow-important`: List of apps that can override the feedback level
(useful for e.g. allowing the alarm clock to also emit sound when
device is in silent mode).
@@ -61,7 +62,8 @@ These gsettings are used by ``feedbackd``:
- `org.sigxcpu.feedbackd.application`
- `profile`: Per application profile levels
- `profile`: Per application profile levels. Valid values are
`full`, `quiet` and `silent`.
See also
========