From 154701fee64295fb1921e74bfc8f8e5b5cb1e872 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Date: Tue, 29 Aug 2023 11:53:06 +0200
Subject: [PATCH] doc: Add manpage for feedback themes

This should direct users to the documentation.

Prompted by https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1050762
---
 doc/fbcli.rst           |  2 +-
 doc/feedback-themes.rst | 32 ++++++++++++++++++++++++++++++++
 doc/feedbackd.rst       |  2 +-
 doc/meson.build         |  1 +
 4 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 doc/feedback-themes.rst

diff --git a/doc/fbcli.rst b/doc/fbcli.rst
index 1c3baaa..314a34e 100644
--- a/doc/fbcli.rst
+++ b/doc/fbcli.rst
@@ -46,4 +46,4 @@ OPTIONS
 See also
 ========
 
-``feedbackd(8)`` ``fbd-theme-validate(1)``
+``feedbackd(8)`` ``fbd-theme-validate(1)`` ``feedback-themes(5)``
diff --git a/doc/feedback-themes.rst b/doc/feedback-themes.rst
new file mode 100644
index 0000000..ef5528e
--- /dev/null
+++ b/doc/feedback-themes.rst
@@ -0,0 +1,32 @@
+.. _feedback-themes(5):
+
+===============
+feedback themes
+===============
+
+---------------------------------
+Theme configuration for feedbackd
+---------------------------------
+
+DESCRIPTION
+===========
+
+In order to reflect device specifics and user overrides the feedback
+(such as sound, haptic or led) that are being triggered by events can
+be configured. This allows for device as well as user specific
+configuration. Themes use a json format and can be validated by
+``fbd-theme-validate``.
+
+For details on how to create or modify feedback themes see [feedbackd's documentation](
+https://source.puri.sm/Librem5/feedbackd#feedback-theme)
+
+Sound events
+============
+
+Sound feedbacks specify an event name from a XDG sound theme. Sound themes
+are described in the [Sound theme spec](https://freedesktop.org/wiki/Specifications/sound-theme-spec/).
+
+See also
+========
+
+``feedbackd(8)`` ``fbcli(1)`` ``fbd-theme-validate(1)``
diff --git a/doc/feedbackd.rst b/doc/feedbackd.rst
index cd4f4b6..ed03a27 100644
--- a/doc/feedbackd.rst
+++ b/doc/feedbackd.rst
@@ -39,4 +39,4 @@ Options
 See also
 ========
 
-``fbcli(1)`` ``fbd-theme-validate(1)``
+``fbcli(1)`` ``fbd-theme-validate(1)`` ``feedback-themes(5)`` ``feedback-themes(5)``
diff --git a/doc/meson.build b/doc/meson.build
index dd16d8b..fe87fda 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -53,6 +53,7 @@ if get_option('man')
     ['fbcli', 1],
     ['fbd-theme-validate', 1],
     ['feedbackd', 8],
+    ['feedback-themes', 5],
   ]
 
   rst2man = find_program('rst2man', 'rst2man.py', required: false)