From 49f697b232928d28d329f46c955aa28e4d2f77b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Wed, 7 Dec 2022 12:27:56 +0100 Subject: [PATCH] doc: Add manual page for fbd-theme-validate --- doc/fbd-theme-validate.rst | 56 ++++++++++++++++++++++++++++++++++++++ doc/meson.build | 1 + 2 files changed, 57 insertions(+) create mode 100644 doc/fbd-theme-validate.rst diff --git a/doc/fbd-theme-validate.rst b/doc/fbd-theme-validate.rst new file mode 100644 index 0000000..c32391c --- /dev/null +++ b/doc/fbd-theme-validate.rst @@ -0,0 +1,56 @@ +.. _fbd-theme-validate(1): + +================== +fbd-theme-validate +================== + +------------------------- +Validate feedbackd themes +------------------------- + +SYNOPSIS +-------- +| **fbd-theme-validate** [OPTIONS...] + + +DESCRIPTION +----------- + +``fbd-theme-validate`` parses and validates the given feedbackd theme +file. If the theme specifies parent themes then these are parsed and +validates as well. + +OPTIONS +======= + +``-h``, ``--help`` + print help and exit + +``--version`` + print version information and exit + +``--compatible=COMPATIBLE`` + Specify the device compatible to use. Specify this if you validate a user + theme and want to simulate how it would look like on a device with compatible + ```COMPATIBLE```. + +EXAMPLES +======== + +Validate a custom theme in the users home directory the same way as it would be +loaded on a Librem 5: + +:: + + fbd-theme-validate --compatible=purism,librem5 ~/.config/feedbackd/themes/custom.json + +Validate the device theme for a OnePlus 6T: + +:: + + fbd-theme-validate /usr/share/feedbackd/themes/oneplus,fajita.json + +See also +======== + +``feedbackd(8)`` ``fbcli(1)`` diff --git a/doc/meson.build b/doc/meson.build index fc72ed1..dd16d8b 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -51,6 +51,7 @@ endif if get_option('man') manpages = [ ['fbcli', 1], + ['fbd-theme-validate', 1], ['feedbackd', 8], ]