Files
feedbackd/doc/feedbackd.xml
T
Chris Vogel bd16d5761d doc: feedback stops when client disconnects
extended documentation for feedbackd.
2022-12-12 11:20:51 +00:00

77 lines
1.7 KiB
XML

<refentry id="gtester">
<refentryinfo>
<title>feedbackd</title>
<productname>feedbackd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Guido</firstname>
<surname>Günther</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>feedbackd</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>feedbackd</refname>
<refpurpose>A daemon to provide feedback on events</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>feedbackd</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>
<command>feedbackd</command> 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.
</para>
<para>
The feedback triggered by a given event is determined by the feedback
theme in use. Events are submitted via a DBus API.
</para>
<para>
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.
</para>
<para>
For details
refer to the event and feedback theme specs at
<ulink url="https://source.puri.sm/Librem5/feedbackd/"/>
</para>
</refsect1>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option>, <option>--help</option></term>
<listitem><para>
print help and exit
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>See also</title>
<para>
<citerefentry>
<refentrytitle>fbcli</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>