Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
Evangelos Ribeiro Tzaras
feedbackd
Commits
afcb57ab
Commit
afcb57ab
authored
Jun 26, 2020
by
Guido Gunther
Committed by
Guido Gunther
Jul 04, 2020
Browse files
doc: Add fbcli manpage
parent
754b520c
Changes
4
Hide whitespace changes
Inline
Side-by-side
doc/fbcli.xml
0 → 100644
View file @
afcb57ab
<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>
doc/meson.build
View file @
afcb57ab
...
...
@@ -36,5 +36,34 @@ gnome.gtkdoc('libfeedback',
install_dir: 'libfeedback',
content_files: content_files,
install: true)
endif
if get_option('man')
manpages = [
'fbcli',
]
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@',
]
man1_dir = get_option('mandir') + '/man1'
foreach page : manpages
custom_target(page + '-man',
input : page + '.xml',
output : page + '.1',
command: xsltproc_command,
install: true,
install_dir: man1_dir)
endforeach
endif
meson.build
View file @
afcb57ab
...
...
@@ -112,6 +112,7 @@ summary = [
'',
' Daemon: @0@'.format(get_option('daemon')),
' Documentation: @0@'.format(get_option('gtk_doc')),
' Manual pages: @0@'.format(get_option('man')),
' Introspection: @0@'.format(introspection),
' Vapi: @0@'.format(get_option('vapi')),
' Tests: @0@'.format(get_option('tests')),
...
...
meson_options.txt
View file @
afcb57ab
...
...
@@ -7,6 +7,9 @@ option('daemon',
option('gtk_doc',
type: 'boolean', value: false,
description: 'Whether to generate the API reference for Libfeedback')
option('man',
type: 'boolean', value : false,
description : 'generate man pages (requires xsltproc)')
option('tests',
type: 'boolean', value: true,
description: 'Whether to compile unit tests')
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment