source: x/installing/libinput.xml@ 9fa8a61

10.0 10.1 11.0 8.4 9.0 9.1 bdubbs/svn elogind ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 9fa8a61 was 9fa8a61, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to libva-2.3.0 (Xorg driver).
Update to libinput-1.12.3 (Xorg driver).
Update to libevdev-1.6.0 (Xorg driver).
Update to mesa-18.2.4.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20696 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.12.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 "083d6bf311d5e1e3a62440dc634bb8f0">
12 <!ENTITY libinput-size "508 KB">
13 <!ENTITY libinput-buildsize "10 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 &lfs83_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 <ulink revision="sysv" url="https://sourceforge.net/projects/linuxwacom/files/libwacom/">libwacom</ulink>
91 <xref revision="systemd" linkend="libwacom"/>
92 <!-- commas outside the rev get rendered on either version -->
93 , and
94 <ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
95 </para>
96
97 <para condition="html" role="usernotes">
98 User Notes: <ulink url="&blfs-wiki;/libinput"/>
99 </para>
100 </sect3>
101
102 <sect3 role="kernel" id="libinput-kernel">
103 <title>kernel configuration for running the libinput testsuite</title>
104
105 <para>
106 Although libinput works with the same kernel configuration used by <xref
107 linkend="libevdev"/>, its extensive testsuite requires the presence of
108 <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
109 and <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>).
110 </para>
111
112 <para>
113 If you wish to run the full tests, enable the following option in the kernel
114 configuration and recompile the kernel if necessary:
115 </para>
116
117<screen><literal>Device Drivers ---&gt;
118 Input device support ---&gt;
119 Miscellaneous Devices ---&gt;
120 &lt;*/M&gt; User level driver support [CONFIG_INPUT_UINPUT]</literal></screen>
121
122 <para>
123 If you build this as a module, it needs to be inserted before the testsuite
124 runs.
125 </para>
126
127 <para>
128 On an Xorg system you will also need to prevent the events generated
129 during the testsuite from interfering with your desktop. Copy the
130 file <filename>test/50-litest.conf</filename> into
131 <filename class="directory"> ${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
132 and restart X. For further information see
133 <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
134 </para>
135
136 <indexterm zone="libinput libinput-kernel">
137 <primary sortas="d-libinput">libinput</primary>
138 </indexterm>
139 </sect3>
140
141 <sect3 role="installation">
142 <title>Installation of libinput</title>
143
144 <para>
145 Install <application>libinput</application> by running the following
146 commands:
147 </para>
148
149<screen><userinput>mkdir build &amp;&amp;
150cd build &amp;&amp;
151
152meson --prefix=$XORG_PREFIX \
153 -Dudev-dir=/lib/udev \
154 -Ddebug-gui=false \
155 -Dtests=false \
156 -Ddocumentation=false \
157 -Dlibwacom=false \
158 .. &amp;&amp;
159ninja</userinput></screen>
160
161 <note>
162 <para>If you want to run the full tests, remove -Dtests from the
163 <command>meson</command> command above. Please read "kernel configuration
164 for running the libinput testsuite" (above).
165 </para>
166
167 <para>
168 If you have enabled the full tests, you can run the main tests
169 <emphasis>as the root user</emphasis> by executing:
170 <command>ninja test</command>. A very large number of tests will
171 be run, about 20 fail (at least on an Xorg system).
172 </para>
173 </note>
174
175 <para>
176 Now, as the <systemitem class="username">root</systemitem> user:
177 </para>
178
179<screen role="root"><userinput>ninja install</userinput></screen>
180
181 <para>
182 If <xref linkend="doxygen"/> and <xref linkend="graphviz"/> were
183 present during the build, you can install the generated documentation
184 by running the following commands as the <systemitem
185 class="username">root</systemitem> user:
186 </para>
187
188<screen role="root"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version; &amp;&amp;
189cp -rv html/* /usr/share/doc/libinput-&libinput-version;</userinput></screen>
190
191 </sect3>
192
193 <sect3 role="commands">
194 <title>Command Explanations</title>
195
196 <para>
197 <option>-Dudev-dir=/lib/udev</option>: This switch
198 specifies where UDev rules and hwdb files will be installed.
199 </para>
200
201 <para>
202 <option>-Ddebug-gui=false</option>: 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 <option>-Dtests=false</option>: This switch disables compilation of the
209 main tests. Even with the tests defined as false, you can still run the
210 first four minor tests, as a regular user, but one will be skipped if
211 <ulink url="https://pypi.org/project/pyparsing"/> is not installed.
212 </para>
213
214 <para>
215 <option>-Ddocumentation=false</option>: This switch disables
216 generation of the documentation. Remove if you want to generate it, and
217 you have <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
218 installed.
219 </para>
220
221 <para>
222 <option>-Dlibwacom=false</option>: Remove this
223 option if you have the external library libwacom installed.
224 </para>
225
226 </sect3>
227
228 <sect3 role="content">
229 <title>Contents</title>
230
231 <segmentedlist>
232 <segtitle>Installed Programs</segtitle>
233 <segtitle>Installed Libraries</segtitle>
234 <segtitle>Installed Directories</segtitle>
235
236 <seglistitem>
237 <seg>
238 libinput,
239 <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
240 libinput-record, libinput-replay Library Executables -->
241 </seg>
242 <seg>
243 libinput.so
244 </seg>
245 <seg>
246 $XORG_PREFIX/libexec/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>
Note: See TracBrowser for help on using the repository browser.