File: fbcli.xml

package info (click to toggle)
feedbackd 0.0.0%2Bgit20210125-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 636 kB
  • sloc: ansic: 4,567; xml: 348; sh: 23; makefile: 17; python: 14
file content (100 lines) | stat: -rw-r--r-- 2,581 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<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. If no event is specified then the global
  feedback profile is changed.
</para>
</varlistentry>

<varlistentry>
<term><option>-w=<replaceable>TIMEOUT</replaceable></option></term>
<term><option>--watch=<replaceable>TIMEOUT</replaceable></option></term>
<para>
  Maximum timeout 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>