source: x/installing/libinput.xml@ f977d64

10.0 10.1 11.0 11.1 11.2 11.3 12.0 9.1 kea ken/inkscape-core-mods lazarus lxqt plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since f977d64 was f977d64, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update to libinput-1.15.1.
Update to mercurial-5.3.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22625 af4574ff-66df-0310-9fd7-8a98e5e911e0

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