source: x/installing/libinput.xml@ c2da37d

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

Update to cups-filters-1.22.5.
Update to cbindgen-0.8.3.
Update to libinput-1.13.1.
Update to mesa-19.0.2.

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

  • Property mode set to 100644
File size: 11.9 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.13.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 "869a7e68c4290d99868500a369645def">
12 <!ENTITY libinput-size "520 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 &lfs84_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"/>, <xref linkend="graphviz"/>, and
183 <ulink url="http://sphinx-doc.org/">Sphinx</ulink> 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;/{html,api} &amp;&amp;
190cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html &amp;&amp;
191cp -rv api/* /usr/share/doc/libinput-&libinput-version;/api</userinput></screen>
192
193 </sect3>
194
195 <sect3 role="commands">
196 <title>Command Explanations</title>
197
198 <para>
199 <option>-Dudev-dir=/lib/udev</option>: This switch
200 specifies where UDev rules and hwdb files will be installed.
201 </para>
202
203 <para>
204 <option>-Ddebug-gui=false</option>: This switch
205 disables creation of a visual debug helper for libinput. Remove
206 if you want it, and you have <xref linkend="gtk3"/> installed.
207 </para>
208
209 <para>
210 <option>-Dtests=false</option>: This switch disables compilation of the
211 main tests. Even with the tests defined as false, you can still run the
212 first four minor tests, as a regular user, but one will be skipped if
213 <ulink url="https://pypi.org/project/pyparsing">PyParsing</ulink> is not installed.
214 </para>
215
216 <para>
217 <option>-Ddocumentation=false</option>: 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 revision="sysv">
224 <option>-Dlibwacom=false</option>: Remove this
225 option if you have the external library libwacom installed.
226 </para>
227
228 <para revision="systemd">
229 <option>-Dlibwacom=false</option>: Remove this option if you
230 have <xref linkend="libwacom"/> installed, or if you are installing
231 GNOME.
232 </para>
233
234 </sect3>
235
236 <sect3 role="content">
237 <title>Contents</title>
238
239 <segmentedlist>
240 <segtitle>Installed Programs</segtitle>
241 <segtitle>Installed Libraries</segtitle>
242 <segtitle>Installed Directories</segtitle>
243
244 <seglistitem>
245 <seg>
246 libinput
247 <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
248 libinput-record, libinput-replay Library Executables -->
249 </seg>
250 <seg>
251 libinput.so
252 </seg>
253 <seg>
254 $XORG_PREFIX/libexec/libinput,
255 /usr/share/libinput, and (optionally)
256 /usr/share/doc/libinput-&libinput-version;
257 </seg>
258 </seglistitem>
259 </segmentedlist>
260
261 <variablelist>
262 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
263 <?dbfo list-presentation="list"?>
264 <?dbhtml list-presentation="table"?>
265
266 <varlistentry id="libinput-prog">
267 <term><command>libinput</command></term>
268 <listitem>
269 <para>
270 is a set of tools to interface with the
271 <application>libinput</application> library.
272 </para>
273 <indexterm zone="libinput libinput-prog">
274 <primary sortas="b-libinput-prog">libinput</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278<!--
279 <varlistentry id="libinput-debug-events">
280 <term><command>libinput-debug-events</command></term>
281 <listitem>
282 <para>
283 is a debug helper for <application>libinput</application>.
284 </para>
285 <indexterm zone="libinput libinput-debug-events">
286 <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="libinput-list-devices">
292 <term><command>libinput-list-devices</command></term>
293 <listitem>
294 <para>
295 lists local devices as recognized by
296 <application>libinput</application>.
297 </para>
298 <indexterm zone="libinput libinput-list-devices">
299 <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="libinput-measure">
305 <term><command>libinput-measure</command></term>
306 <listitem>
307 <para>
308 is the entry to a set of debugging programs to measure
309 the properties of one or more devices.
310 </para>
311 <indexterm zone="libinput libinput-measure">
312 <primary sortas="b-libinput-measure">libinput-measure</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="libinput-record">
318 <term><command>libinput-record</command></term>
319 <listitem>
320 <para>
321 records kernel events from a device in a form that can later be
322 replayed by libinput-replay.
323 </para>
324 <indexterm zone="libinput libinput-record">
325 <primary sortas="b-libinput-record">libinput-record</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="libinput-replay">
331 <term><command>libinput-replay</command></term>
332 <listitem>
333 <para>
334 replays kernel events from a recording made by libinput-record.
335 </para>
336 <indexterm zone="libinput libinput-replay">
337 <primary sortas="b-libinput-replay">libinput-replay</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341-->
342 <varlistentry id="libinput-lib">
343 <term><filename class="libraryfile">libinput.so</filename></term>
344 <listitem>
345 <para>
346 contains API functions for handling input devices.
347 </para>
348 <indexterm zone="libinput libinput-lib">
349 <primary sortas="c-libinput-lib">libinput.so</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 </variablelist>
355
356 </sect3>
357
358</sect2>
Note: See TracBrowser for help on using the repository browser.