1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY libinput-version "1.19.3">
|
---|
8 |
|
---|
9 | <!ENTITY libinput-download-http "https://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">
|
---|
10 | <!ENTITY libinput-download-ftp " ">
|
---|
11 | <!ENTITY libinput-md5sum "a9f6fe8156739b51593674183cb25399">
|
---|
12 | <!ENTITY libinput-size "640 KB">
|
---|
13 | <!ENTITY libinput-buildsize "10 MB (add 17 MB for documentation)">
|
---|
14 | <!ENTITY libinput-time "0.1 SBU (add 0.1 SBU for documentation)">
|
---|
15 | ]>
|
---|
16 |
|
---|
17 | <sect2 id="libinput" xreflabel="libinput-&libinput-version;">
|
---|
18 | <?dbhtml filename="libinput.html"?>
|
---|
19 |
|
---|
20 | <sect2info>
|
---|
21 | <date>$Date$</date>
|
---|
22 | </sect2info>
|
---|
23 |
|
---|
24 | <title>libinput-&libinput-version;</title>
|
---|
25 |
|
---|
26 | <indexterm zone="libinput">
|
---|
27 | <primary sortas="a-libinput">libinput</primary>
|
---|
28 | </indexterm>
|
---|
29 |
|
---|
30 | <sect3 role="package">
|
---|
31 | <title>Introduction to libinput</title>
|
---|
32 |
|
---|
33 | <para>
|
---|
34 | <application>libinput</application> is a library that handles
|
---|
35 | input devices for display servers and other applications that
|
---|
36 | need to directly deal with input devices.
|
---|
37 | </para>
|
---|
38 |
|
---|
39 | &lfs110a_checked;
|
---|
40 |
|
---|
41 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
42 | <itemizedlist spacing="compact">
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (HTTP): <ulink url="&libinput-download-http;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (FTP): <ulink url="&libinput-download-ftp;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download MD5 sum: &libinput-md5sum;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download size: &libinput-size;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated disk space required: &libinput-buildsize;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated build time: &libinput-time;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">libinput Dependencies</bridgehead>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
78 | <para role="required">
|
---|
79 | <xref linkend="libevdev"/> and
|
---|
80 | <xref linkend="mtdev"/>
|
---|
81 | </para>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
84 | <para role="optional">
|
---|
85 | <xref linkend="valgrind"/> (to run the tests),
|
---|
86 | <ulink url="http://sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
|
---|
87 | <xref linkend="gtk3"/> (to build the GUI event viewer),
|
---|
88 | <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests),
|
---|
89 | <xref linkend="libwacom"/>, and
|
---|
90 | <ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <para condition="html" role="usernotes">
|
---|
94 | User Notes: <ulink url="&blfs-wiki;/libinput"/>
|
---|
95 | </para>
|
---|
96 | </sect3>
|
---|
97 |
|
---|
98 | <sect3 role="kernel" id="libinput-kernel">
|
---|
99 | <title>kernel configuration for running the libinput testsuite</title>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Although libinput works with the same kernel configuration used by <xref
|
---|
103 | linkend="libevdev"/>, its extensive testsuite requires the presence of
|
---|
104 | <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
|
---|
105 | and <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>).
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | If you wish to run the full tests, enable the following option in the kernel
|
---|
110 | configuration and recompile the kernel if necessary:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><literal>Device Drivers --->
|
---|
114 | Input device support --->
|
---|
115 | Miscellaneous Devices --->
|
---|
116 | <*/M> User level driver support [CONFIG_INPUT_UINPUT]</literal></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | If you build this as a module, it needs to be inserted before the testsuite
|
---|
120 | runs.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | On an Xorg system you will also need to prevent the events generated
|
---|
125 | during the testsuite from interfering with your desktop. Copy the
|
---|
126 | file <filename>test/50-litest.conf</filename> into
|
---|
127 | <filename class="directory">${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
|
---|
128 | and restart X. For further information see
|
---|
129 | <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <indexterm zone="libinput libinput-kernel">
|
---|
133 | <primary sortas="d-libinput">libinput</primary>
|
---|
134 | </indexterm>
|
---|
135 | </sect3>
|
---|
136 |
|
---|
137 | <sect3 role="installation">
|
---|
138 | <title>Installation of libinput</title>
|
---|
139 |
|
---|
140 | <para>
|
---|
141 | Install <application>libinput</application> by running the following
|
---|
142 | commands:
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | <screen><userinput>mkdir build &&
|
---|
146 | cd build &&
|
---|
147 |
|
---|
148 | meson --prefix=$XORG_PREFIX \
|
---|
149 | --buildtype=release \
|
---|
150 | -Ddebug-gui=false \
|
---|
151 | -Dtests=false \
|
---|
152 | -Dlibwacom=false \
|
---|
153 | .. &&
|
---|
154 | ninja</userinput></screen>
|
---|
155 |
|
---|
156 | <note>
|
---|
157 | <para>
|
---|
158 | If you want to run the full tests, remove -Dtests from the
|
---|
159 | <command>meson</command> command above. Please read "kernel
|
---|
160 | configuration for running the libinput testsuite" (above).
|
---|
161 | </para>
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | If you have enabled the full tests, you can run the main tests
|
---|
165 | <emphasis>as the root user</emphasis> by executing:
|
---|
166 | <command>ninja test</command>. A very large number of tests will
|
---|
167 | be run, about 20 fail (at least on an Xorg system).
|
---|
168 | </para>
|
---|
169 | </note>
|
---|
170 |
|
---|
171 | <para>
|
---|
172 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
173 | </para>
|
---|
174 |
|
---|
175 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
176 |
|
---|
177 | <para>
|
---|
178 | If you have passed <option>-Ddocumentation=true</option> to
|
---|
179 | <command>meson</command>, you can install the generated documentation
|
---|
180 | by running the following commands as the <systemitem
|
---|
181 | class="username">root</systemitem> user:
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <!-- seems the api doc is not generated because the directory is not a git
|
---|
185 | repository... -->
|
---|
186 | <screen role="root"
|
---|
187 | remap="doc"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version;/html &&
|
---|
188 | cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html</userinput></screen>
|
---|
189 |
|
---|
190 | </sect3>
|
---|
191 |
|
---|
192 | <sect3 role="commands">
|
---|
193 | <title>Command Explanations</title>
|
---|
194 |
|
---|
195 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
196 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
197 |
|
---|
198 | <para>
|
---|
199 | <parameter>-Ddebug-gui=false</parameter>: This switch
|
---|
200 | disables creation of a visual debug helper for libinput. Remove
|
---|
201 | if you want it, and you have <xref linkend="gtk3"/> installed.
|
---|
202 | </para>
|
---|
203 |
|
---|
204 | <para>
|
---|
205 | <parameter>-Dtests=false</parameter>: This switch disables compilation of
|
---|
206 | the main tests. Even with the tests defined as false, you can still run
|
---|
207 | the first four minor tests, as a regular user, but one will be skipped if
|
---|
208 | <ulink url="https://pypi.org/project/pyparsing">PyParsing</ulink> is not
|
---|
209 | installed.
|
---|
210 | </para>
|
---|
211 |
|
---|
212 | <para>
|
---|
213 | <parameter>-Dlibwacom=false</parameter>: Remove this option if you
|
---|
214 | have <xref linkend="libwacom"/> installed, or if you are installing
|
---|
215 | GNOME.
|
---|
216 | </para>
|
---|
217 |
|
---|
218 | <para>
|
---|
219 | <option>-Ddocumentation=true</option>: This switch enables
|
---|
220 | generation of the documentation. Add it if you want to generate
|
---|
221 | the documentation. You must have <xref linkend="doxygen"/> and
|
---|
222 | <xref linkend="graphviz"/> installed.
|
---|
223 | </para>
|
---|
224 |
|
---|
225 | </sect3>
|
---|
226 |
|
---|
227 | <sect3 role="content">
|
---|
228 | <title>Contents</title>
|
---|
229 |
|
---|
230 | <segmentedlist>
|
---|
231 | <segtitle>Installed Programs</segtitle>
|
---|
232 | <segtitle>Installed Libraries</segtitle>
|
---|
233 | <segtitle>Installed Directories</segtitle>
|
---|
234 |
|
---|
235 | <seglistitem>
|
---|
236 | <seg>
|
---|
237 | libinput
|
---|
238 | <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
|
---|
239 | libinput-record, libinput-replay Library Executables -->
|
---|
240 | </seg>
|
---|
241 | <seg>
|
---|
242 | libinput.so
|
---|
243 | </seg>
|
---|
244 | <seg>
|
---|
245 | $XORG_PREFIX/libexec/libinput,
|
---|
246 | /etc/libinput,
|
---|
247 | /usr/share/libinput, and (optionally)
|
---|
248 | /usr/share/doc/libinput-&libinput-version;
|
---|
249 | </seg>
|
---|
250 | </seglistitem>
|
---|
251 | </segmentedlist>
|
---|
252 |
|
---|
253 | <variablelist>
|
---|
254 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
255 | <?dbfo list-presentation="list"?>
|
---|
256 | <?dbhtml list-presentation="table"?>
|
---|
257 |
|
---|
258 | <varlistentry id="libinput-prog">
|
---|
259 | <term><command>libinput</command></term>
|
---|
260 | <listitem>
|
---|
261 | <para>
|
---|
262 | is a set of tools to interface with the
|
---|
263 | <application>libinput</application> library
|
---|
264 | </para>
|
---|
265 | <indexterm zone="libinput libinput-prog">
|
---|
266 | <primary sortas="b-libinput-prog">libinput</primary>
|
---|
267 | </indexterm>
|
---|
268 | </listitem>
|
---|
269 | </varlistentry>
|
---|
270 | <!--
|
---|
271 | <varlistentry id="libinput-debug-events">
|
---|
272 | <term><command>libinput-debug-events</command></term>
|
---|
273 | <listitem>
|
---|
274 | <para>
|
---|
275 | is a debug helper for <application>libinput</application>.
|
---|
276 | </para>
|
---|
277 | <indexterm zone="libinput libinput-debug-events">
|
---|
278 | <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
|
---|
279 | </indexterm>
|
---|
280 | </listitem>
|
---|
281 | </varlistentry>
|
---|
282 |
|
---|
283 | <varlistentry id="libinput-list-devices">
|
---|
284 | <term><command>libinput-list-devices</command></term>
|
---|
285 | <listitem>
|
---|
286 | <para>
|
---|
287 | lists local devices as recognized by
|
---|
288 | <application>libinput</application>.
|
---|
289 | </para>
|
---|
290 | <indexterm zone="libinput libinput-list-devices">
|
---|
291 | <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
|
---|
292 | </indexterm>
|
---|
293 | </listitem>
|
---|
294 | </varlistentry>
|
---|
295 |
|
---|
296 | <varlistentry id="libinput-measure">
|
---|
297 | <term><command>libinput-measure</command></term>
|
---|
298 | <listitem>
|
---|
299 | <para>
|
---|
300 | is the entry to a set of debugging programs to measure
|
---|
301 | the properties of one or more devices.
|
---|
302 | </para>
|
---|
303 | <indexterm zone="libinput libinput-measure">
|
---|
304 | <primary sortas="b-libinput-measure">libinput-measure</primary>
|
---|
305 | </indexterm>
|
---|
306 | </listitem>
|
---|
307 | </varlistentry>
|
---|
308 |
|
---|
309 | <varlistentry id="libinput-record">
|
---|
310 | <term><command>libinput-record</command></term>
|
---|
311 | <listitem>
|
---|
312 | <para>
|
---|
313 | records kernel events from a device in a form that can later be
|
---|
314 | replayed by libinput-replay.
|
---|
315 | </para>
|
---|
316 | <indexterm zone="libinput libinput-record">
|
---|
317 | <primary sortas="b-libinput-record">libinput-record</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="libinput-replay">
|
---|
323 | <term><command>libinput-replay</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>
|
---|
326 | replays kernel events from a recording made by libinput-record.
|
---|
327 | </para>
|
---|
328 | <indexterm zone="libinput libinput-replay">
|
---|
329 | <primary sortas="b-libinput-replay">libinput-replay</primary>
|
---|
330 | </indexterm>
|
---|
331 | </listitem>
|
---|
332 | </varlistentry>
|
---|
333 | -->
|
---|
334 | <varlistentry id="libinput-lib">
|
---|
335 | <term><filename class="libraryfile">libinput.so</filename></term>
|
---|
336 | <listitem>
|
---|
337 | <para>
|
---|
338 | contains API functions for handling input devices
|
---|
339 | </para>
|
---|
340 | <indexterm zone="libinput libinput-lib">
|
---|
341 | <primary sortas="c-libinput-lib">libinput.so</primary>
|
---|
342 | </indexterm>
|
---|
343 | </listitem>
|
---|
344 | </varlistentry>
|
---|
345 |
|
---|
346 | </variablelist>
|
---|
347 |
|
---|
348 | </sect3>
|
---|
349 |
|
---|
350 | </sect2>
|
---|