diff --git a/debian/control b/debian/control index 1b504d9..1e14235 100644 --- a/debian/control +++ b/debian/control @@ -5,7 +5,6 @@ Maintainer: Guido Günther Build-Depends: dbus, debhelper-compat (= 12), - docbook-xsl , dh-sequence-gir, gsettings-desktop-schemas , gi-docgen , @@ -17,8 +16,8 @@ Build-Depends: libjson-glib-dev, meson, pkg-config, + python3-docutils , valac, - xsltproc , Standards-Version: 4.4.0 Homepage: https://source.puri.sm/Librem5/feedbackd diff --git a/doc/fbcli.rst b/doc/fbcli.rst new file mode 100644 index 0000000..8d439a2 --- /dev/null +++ b/doc/fbcli.rst @@ -0,0 +1,49 @@ +.. _fbcli(1): + +===== +fbcli +===== + +------------------------ +Emit events to feedbackd +------------------------ + +SYNOPSIS +-------- +| **fbcli** [OPTIONS...] + + +DESCRIPTION +----------- + +``fbcli`` can be used to submit events to ``feedbackd`` to trigger +audio, visual or haptic feedback. + +OPTIONS +======= + +``-h``, ``--help`` + print help and exit + +``-E=EVENT``; ``--event=EVENT`` + Submit the given event to ``feedbackd``. Valid events are listes in + the event naming spec at + `https://source.puri.sm/Librem5/feedbackd/-/blob/main/Event-naming-spec-0.0.0.md`__ + +``-t=TIMEOUT``; ``--timeout=TIMEOUT`` + The timeout in seconds after which feedback for the given event should + be stopped. + +``-P=PROFILE``; ``--profile=PROFILE`` + The feedback profile (``full``, ``quiet``, ``silent``) + to use for the given event. If no event is specified then the global + feedback profile is changed. + +``-w=TIMEOUT``; ``--watch=TIMEOUT`` + Maximum timeout to wait for the feedback for the given event to end and + ``fbcli`` to exit. + +See also +======== + +``feedbackd(8)`` diff --git a/doc/fbcli.xml b/doc/fbcli.xml deleted file mode 100644 index 282e045..0000000 --- a/doc/fbcli.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - -fbcli -feedbackd - - -Developer -Guido -Günther - - - - - -fbcli -1 -User Commands - - - -fbcli -Emit events to feedbackd - - - - -fbcli -OPTION - - - -Description -fbcli can be used to submit events to feedbackd -to trigger audio, visual or haptic feedback. - - - -Options - - - -, - -print help and exit - - - - - - - - Submit the given event to feedbackd. Valid events are - listes in the event naming spec at - - - - - - - - - The timeout in seconds after which feedback for the given event should - be stopped. - - - - - - - - The feedback profile (full, quiet, silent) - to use for the given event. If no event is specified then the global - feedback profile is changed. - - - - - - - - Maximum timeout to wait for the feedback for the given event to end and - fbcli to exit. - - - - - - - - -See also - - -feedbackd -1 - - - - diff --git a/doc/feedbackd.rst b/doc/feedbackd.rst new file mode 100644 index 0000000..51fffa4 --- /dev/null +++ b/doc/feedbackd.rst @@ -0,0 +1,42 @@ +.. _feedbackd(8): + +========= +feedbackd +========= + +-------------------------------------- +A daemon to provide feedback on events +-------------------------------------- + +SYNOPSIS +-------- +| **feedbackd** [OPTIONS...] + + +DESCRIPTION +=========== + +``Feedbackd`` is a daemon that runs in the users session to trigger +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. + +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 +``__ + +Options +======= + +``-h``, ``--help`` + print help and exit + +See also +======== + +``fbcli(1)`` diff --git a/doc/feedbackd.xml b/doc/feedbackd.xml deleted file mode 100644 index 6717cf6..0000000 --- a/doc/feedbackd.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - -feedbackd -feedbackd - - -Developer -Guido -Günther - - - - - -feedbackd -1 -User Commands - - - -feedbackd -A daemon to provide feedback on events - - - - -feedbackd -OPTION - - - -Description - - feedbackd is a daemon that runs in the users - session to trigger 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. - - - 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 - - - - -Options - - - -, - -print help and exit - - - - - - -See also - - -fbcli -1 - - - - diff --git a/doc/meson.build b/doc/meson.build index b4a2a27..fc72ed1 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -50,31 +50,30 @@ endif if get_option('man') manpages = [ - 'fbcli', - 'feedbackd', + ['fbcli', 1], + ['feedbackd', 8], ] - xsltproc = find_program('xsltproc', required : true) - xsltproc_command = [ - xsltproc, - '--nonet', - '--stringparam', 'man.output.quietly', '1', - '--stringparam', 'funcsynopsis.style', 'ansi', - '--stringparam', 'man.th.extra1.suppress', '1', - '--stringparam', 'man.authors.section.enabled', '0', - '--stringparam', 'man.copyright.section.enabled', '0', - '-o', '@OUTPUT@', - 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl', - '@INPUT@', + rst2man = find_program('rst2man', 'rst2man.py', required: false) + rst2man_flags = [ + '--syntax-highlight=none', ] - man1_dir = get_option('mandir') + '/man1' - foreach page : manpages - custom_target(page + '-man', - input : page + '.xml', - output : page + '.1', - command: xsltproc_command, + foreach manpage: manpages + man_name = manpage[0] + man_section = manpage[1] + + custom_target('man-@0@'.format(man_name), + input: '@0@.rst'.format(man_name), + output: '@0@.@1@'.format(man_name, man_section), + command: [ + rst2man, + rst2man_flags, + '@INPUT@', + ], + capture: true, install: true, - install_dir: man1_dir) + install_dir: get_option('mandir') / 'man@0@'.format(man_section), + ) endforeach endif diff --git a/meson_options.txt b/meson_options.txt index 4d1b4f0..59e2281 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -9,7 +9,7 @@ option('gtk_doc', description: 'Whether to generate the API reference for Libfeedback') option('man', type: 'boolean', value : false, - description : 'generate man pages (requires xsltproc)') + description : 'generate man pages (requires rst2man)') option('tests', type: 'boolean', value: true, description: 'Whether to compile unit tests')