source: x/installing/libinput.xml@ 1584c8a

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 1584c8a was 1584c8a, checked in by Thomas Trepl <thomas@…>, 15 months ago

Upgrade libinput-1.16.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23457 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.16.0">
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 "b518dae7f603040872739216971ee97b">
12 <!ENTITY libinput-size "579 KB">
13 <!ENTITY libinput-buildsize "15 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$</othername>
22 <date>$Date$</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 &lfs91_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>
160 If you want to run the full tests, remove -Dtests from the
161 <command>meson</command> command above. Please read "kernel
162 configuration for running the libinput testsuite" (above).
163 </para>
164
165 <para>
166 If you have enabled the full tests, you can run the main tests
167 <emphasis>as the root user</emphasis> by executing:
168 <command>ninja test</command>. A very large number of tests will
169 be run, about 20 fail (at least on an Xorg system).
170 </para>
171 </note>
172
173 <para>
174 Now, as the <systemitem class="username">root</systemitem> user:
175 </para>
176
177<screen role="root"><userinput>ninja install</userinput></screen>
178
179 <para>
180 If <xref linkend="doxygen"/>, <xref linkend="graphviz"/>, and
181 <ulink url="http://sphinx-doc.org/">Sphinx</ulink> were
182 present during the build, you can install the generated documentation
183 by running the following commands as the <systemitem
184 class="username">root</systemitem> user:
185 </para>
186
187<screen role="root"
188 remap="doc"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version;/{html,api} &amp;&amp;
189cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html &amp;&amp;
190cp -rv api/* /usr/share/doc/libinput-&libinput-version;/api</userinput></screen>
191
192 </sect3>
193
194 <sect3 role="commands">
195 <title>Command Explanations</title>
196
197 <para>
198 <parameter>-Dudev-dir=/lib/udev</parameter>: This switch
199 specifies where UDev rules and hwdb files will be installed.
200 </para>
201
202 <para>
203 <parameter>-Ddebug-gui=false</parameter>: This switch
204 disables creation of a visual debug helper for libinput. Remove
205 if you want it, and you have <xref linkend="gtk3"/> installed.
206 </para>
207
208 <para>
209 <parameter>-Dtests=false</parameter>: This switch disables compilation of
210 the main tests. Even with the tests defined as false, you can still run
211 the first four minor tests, as a regular user, but one will be skipped if
212 <ulink url="https://pypi.org/project/pyparsing">PyParsing</ulink> is not
213 installed.
214 </para>
215
216 <para>
217 <parameter>-Ddocumentation=false</parameter>: This switch disables
218 generation of the documentation. Remove if you want to generate it, and
219 you have <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
220 installed.
221 </para>
222
223 <para>
224 <parameter>-Dlibwacom=false</parameter>: Remove this option if you
225 have <xref linkend="libwacom"/> installed, or if you are installing
226 GNOME.
227 </para>
228
229 </sect3>
230
231 <sect3 role="content">
232 <title>Contents</title>
233
234 <segmentedlist>
235 <segtitle>Installed Programs</segtitle>
236 <segtitle>Installed Libraries</segtitle>
237 <segtitle>Installed Directories</segtitle>
238
239 <seglistitem>
240 <seg>
241 libinput
242 <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
243 libinput-record, libinput-replay Library Executables -->
244 </seg>
245 <seg>
246 libinput.so
247 </seg>
248 <seg>
249 $XORG_PREFIX/libexec/libinput,
250 /usr/share/libinput, and (optionally)
251 /usr/share/doc/libinput-&libinput-version;
252 </seg>
253 </seglistitem>
254 </segmentedlist>
255
256 <variablelist>
257 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
258 <?dbfo list-presentation="list"?>
259 <?dbhtml list-presentation="table"?>
260
261 <varlistentry id="libinput-prog">
262 <term><command>libinput</command></term>
263 <listitem>
264 <para>
265 is a set of tools to interface with the
266 <application>libinput</application> library.
267 </para>
268 <indexterm zone="libinput libinput-prog">
269 <primary sortas="b-libinput-prog">libinput</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273<!--
274 <varlistentry id="libinput-debug-events">
275 <term><command>libinput-debug-events</command></term>
276 <listitem>
277 <para>
278 is a debug helper for <application>libinput</application>.
279 </para>
280 <indexterm zone="libinput libinput-debug-events">
281 <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="libinput-list-devices">
287 <term><command>libinput-list-devices</command></term>
288 <listitem>
289 <para>
290 lists local devices as recognized by
291 <application>libinput</application>.
292 </para>
293 <indexterm zone="libinput libinput-list-devices">
294 <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="libinput-measure">
300 <term><command>libinput-measure</command></term>
301 <listitem>
302 <para>
303 is the entry to a set of debugging programs to measure
304 the properties of one or more devices.
305 </para>
306 <indexterm zone="libinput libinput-measure">
307 <primary sortas="b-libinput-measure">libinput-measure</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="libinput-record">
313 <term><command>libinput-record</command></term>
314 <listitem>
315 <para>
316 records kernel events from a device in a form that can later be
317 replayed by libinput-replay.
318 </para>
319 <indexterm zone="libinput libinput-record">
320 <primary sortas="b-libinput-record">libinput-record</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="libinput-replay">
326 <term><command>libinput-replay</command></term>
327 <listitem>
328 <para>
329 replays kernel events from a recording made by libinput-record.
330 </para>
331 <indexterm zone="libinput libinput-replay">
332 <primary sortas="b-libinput-replay">libinput-replay</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336-->
337 <varlistentry id="libinput-lib">
338 <term><filename class="libraryfile">libinput.so</filename></term>
339 <listitem>
340 <para>
341 contains API functions for handling input devices.
342 </para>
343 <indexterm zone="libinput libinput-lib">
344 <primary sortas="c-libinput-lib">libinput.so</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 </variablelist>
350
351 </sect3>
352
353</sect2>
Note: See TracBrowser for help on using the repository browser.