source: x/installing/libinput.xml@ f521a414

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 f521a414 was f521a414, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Update to xterm-337
Update to xf86-video-ati-18.1.0
Update to xf86-video-amdgpu-18.1.0
Update to libepoxy-1.5.3
Update to libinput-1.12.1

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20584 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.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 "0b6fff34e30cf7aafc33c8f884806960">
12 <!ENTITY libinput-size "508 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 &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 <xref linkend="doxygen"/> and
88 <xref linkend="graphviz"/> (to build the documentation)
89 <xref linkend="gtk3"/> (to build the GUI event viewer),
90 <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests),
91 <ulink revision="sysv" url="https://sourceforge.net/projects/linuxwacom/files/libwacom/">libwacom</ulink>
92 <xref revision="systemd" linkend="libwacom"/>
93 <!-- commas outside the rev get rendered on either version -->
94 , and
95 <ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
96 </para>
97
98 <para condition="html" role="usernotes">
99 User Notes: <ulink url="&blfs-wiki;/libinput"/>
100 </para>
101 </sect3>
102
103 <sect3 role="kernel" id="libinput-kernel">
104 <title>kernel configuration for running the libinput testsuite</title>
105
106 <para>
107 Although libinput works with the same kernel configuration used by <xref
108 linkend="libevdev"/>, its extensive testsuite requires the presence of
109 <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
110 and <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>).
111 </para>
112
113 <para>
114 If you wish to run the full tests, enable the following option in the kernel
115 configuration and recompile the kernel if necessary:
116 </para>
117
118<screen><literal>Device Drivers ---&gt;
119 Input device support ---&gt;
120 Miscellaneous Devices ---&gt;
121 &lt;*/M&gt; User level driver support [CONFIG_INPUT_UINPUT]</literal></screen>
122
123 <para>
124 If you build this as a module, it needs to be inserted before the testsuite
125 runs.
126 </para>
127
128 <para>
129 On an Xorg system you will also need to prevent the events generated
130 during the testsuite from interfering with your desktop. Copy the
131 file <filename>test/50-litest.conf</filename> into
132 <filename class="directory"> ${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
133 and restart X. For further information see
134 <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
135 </para>
136
137 <indexterm zone="libinput libinput-kernel">
138 <primary sortas="d-libinput">libinput</primary>
139 </indexterm>
140 </sect3>
141
142 <sect3 role="installation">
143 <title>Installation of libinput</title>
144
145 <para>
146 Install <application>libinput</application> by running the following
147 commands:
148 </para>
149
150<screen><userinput>mkdir build &amp;&amp;
151cd build &amp;&amp;
152
153meson --prefix=$XORG_PREFIX \
154 -Dudev-dir=/lib/udev \
155 -Ddebug-gui=false \
156 -Dtests=false \
157 -Ddocumentation=false \
158 -Dlibwacom=false \
159 .. &amp;&amp;
160ninja</userinput></screen>
161
162 <note>
163 <para>If you want to run the full tests, remove -Dtests from the
164 <command>meson</command> command above. Please read "kernel configuration
165 for running the libinput testsuite" (above).
166 </para>
167
168 <para>
169 If you have enabled the full tests, you can run the main tests
170 <emphasis>as the root user</emphasis> by executing:
171 <command>ninja test</command>. A very large number of tests will
172 be run, about 20 fail (at least on an Xorg system).
173 </para>
174 </note>
175
176 <para>
177 Now, as the <systemitem class="username">root</systemitem> user:
178 </para>
179
180<screen role="root"><userinput>ninja install</userinput></screen>
181
182 <para>
183 If <xref linkend="doxygen"/> and <xref linkend="graphviz"/> were
184 present during the build, you can install the generated documentation
185 by running the following commands as the <systemitem
186 class="username">root</systemitem> user:
187 </para>
188
189<screen role="root"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version; &amp;&amp;
190cp -rv html/* /usr/share/doc/libinput-&libinput-version;</userinput></screen>
191
192 </sect3>
193
194 <sect3 role="commands">
195 <title>Command Explanations</title>
196
197 <para>
198 <option>-Dudev-dir=/lib/udev</option>: This switch
199 specifies where UDev rules and hwdb files will be installed.
200 </para>
201
202 <para>
203 <option>-Ddebug-gui=false</option>: 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 <option>-Dtests=false</option>: This switch disables compilation of the
210 main tests. Even with the tests defined as false, you can still run the
211 first four minor tests, as a regular user, but one will be skipped if
212 <ulink url="https://pypi.org/project/pyparsing"/> is not installed.
213 </para>
214
215 <para>
216 <option>-Ddocumentation=false</option>: 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 <option>-Dlibwacom=false</option>: Remove this
224 option if you have the external library libwacom installed.
225 </para>
226
227 </sect3>
228
229 <sect3 role="content">
230 <title>Contents</title>
231
232 <segmentedlist>
233 <segtitle>Installed Programs</segtitle>
234 <segtitle>Installed Libraries</segtitle>
235 <segtitle>Installed Directories</segtitle>
236
237 <seglistitem>
238 <seg>
239 libinput,
240 <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
241 libinput-record, libinput-replay Library Executables -->
242 </seg>
243 <seg>
244 libinput.so
245 </seg>
246 <seg>
247 $XORG_PREFIX/libexec/libinput,
248 /usr/share/libinput, and (optionally)
249 /usr/share/doc/libinput-&libinput-version;
250 </seg>
251 </seglistitem>
252 </segmentedlist>
253
254 <variablelist>
255 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
256 <?dbfo list-presentation="list"?>
257 <?dbhtml list-presentation="table"?>
258
259 <varlistentry id="libinput-prog">
260 <term><command>libinput</command></term>
261 <listitem>
262 <para>
263 is a set of tools to interface with the
264 <application>libinput</application> library.
265 </para>
266 <indexterm zone="libinput libinput-prog">
267 <primary sortas="b-libinput-prog">libinput</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271<!--
272 <varlistentry id="libinput-debug-events">
273 <term><command>libinput-debug-events</command></term>
274 <listitem>
275 <para>
276 is a debug helper for <application>libinput</application>.
277 </para>
278 <indexterm zone="libinput libinput-debug-events">
279 <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="libinput-list-devices">
285 <term><command>libinput-list-devices</command></term>
286 <listitem>
287 <para>
288 lists local devices as recognized by
289 <application>libinput</application>.
290 </para>
291 <indexterm zone="libinput libinput-list-devices">
292 <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="libinput-measure">
298 <term><command>libinput-measure</command></term>
299 <listitem>
300 <para>
301 is the entry to a set of debugging programs to measure
302 the properties of one or more devices.
303 </para>
304 <indexterm zone="libinput libinput-measure">
305 <primary sortas="b-libinput-measure">libinput-measure</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="libinput-record">
311 <term><command>libinput-record</command></term>
312 <listitem>
313 <para>
314 records kernel events from a device in a form that can later be
315 replayed by libinput-replay.
316 </para>
317 <indexterm zone="libinput libinput-record">
318 <primary sortas="b-libinput-record">libinput-record</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="libinput-replay">
324 <term><command>libinput-replay</command></term>
325 <listitem>
326 <para>
327 replays kernel events from a recording made by libinput-record.
328 </para>
329 <indexterm zone="libinput libinput-replay">
330 <primary sortas="b-libinput-replay">libinput-replay</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334-->
335 <varlistentry id="libinput-lib">
336 <term><filename class="libraryfile">libinput.so</filename></term>
337 <listitem>
338 <para>
339 contains API functions for handling input devices.
340 </para>
341 <indexterm zone="libinput libinput-lib">
342 <primary sortas="c-libinput-lib">libinput.so</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 </variablelist>
348
349 </sect3>
350
351</sect2>
Note: See TracBrowser for help on using the repository browser.