100 lines
2.4 KiB
XML
100 lines
2.4 KiB
XML
<refentry id="gtester">
|
|
|
|
<refentryinfo>
|
|
<title>fbcli</title>
|
|
<productname>feedbackd</productname>
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Guido</firstname>
|
|
<surname>Günther</surname>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>fbcli</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>fbcli</refname>
|
|
<refpurpose>Emit events to feedbackd</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>fbcli</command>
|
|
<arg choice="opt" rep="repeat">OPTION</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1><title>Description</title>
|
|
<para><command>fbcli</command> can be used to submit events to <command>feedbackd</command>
|
|
to trigger audio, visual or haptic feedback.
|
|
</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>
|
|
|
|
<varlistentry>
|
|
<term><option>-E=<replaceable>EVENT</replaceable></option></term>
|
|
<term><option>--event=<replaceable>EVENT</replaceable></option></term>
|
|
<para>
|
|
Submit the given event to <command>feedbackd</command>. Valid events are
|
|
listes in the event naming spec at
|
|
<ulink url="https://source.puri.sm/Librem5/feedbackd/-/blob/master/Event-naming-spec-0.0.0.md"/>
|
|
</para>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-t=<replaceable>TIMEOUT</replaceable></option></term>
|
|
<term><option>--timeout=<replaceable>TIMEOUT</replaceable></option></term>
|
|
<para>
|
|
The timeout in seconds after which feedback for the given event should
|
|
be stopped.
|
|
</para>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-p=<replaceable>PROFILE</replaceable></option></term>
|
|
<term><option>--profile=<replaceable>PROFILE</replaceable></option></term>
|
|
<para>
|
|
The feedback profile (<literal>full</literal>, <literal>quiet</literal>, <literal>silent</literal>)
|
|
to use for the given event.
|
|
</para>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-w=<replaceable>TIMEOUT</replaceable></option></term>
|
|
<term><option>--watch=<replaceable>TIMEOUT</replaceable></option></term>
|
|
<para>
|
|
Maximum timout to wait for the feedback for the given event to end and
|
|
<command>fbcli</command> to exit.
|
|
</para>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1><title>See also</title>
|
|
<para>
|
|
<citerefentry>
|
|
<refentrytitle>feedbackd</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|