source: x/installing/libinput.xml@ f8cde65

trunk
Last change on this file since f8cde65 was f8cde65, checked in by Xi Ruoyao <xry111@…>, 3 months ago

libwacom and libinput: remove -Dudev-dir (merged /usr)

  • Property mode set to 100644
File size: 12.0 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.17.2">
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 "4e55a1f9585b39ff1394891bf5a1cd3a">
12 <!ENTITY libinput-size "600 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 <date>$Date$</date>
22 </sect2info>
23
24 <title>libinput-&libinput-version;</title>
25
26 <indexterm zone="libinput">
27 <primary sortas="a-libinput">libinput</primary>
28 </indexterm>
29
30 <sect3 role="package">
31 <title>Introduction to libinput</title>
32
33 <para>
34 <application>libinput</application> is a library that handles
35 input devices for display servers and other applications that
36 need to directly deal with input devices.
37 </para>
38
39 &lfs101_checked;
40
41 <bridgehead renderas="sect4">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&libinput-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&libinput-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &libinput-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &libinput-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &libinput-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &libinput-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect4">libinput Dependencies</bridgehead>
76
77 <bridgehead renderas="sect5">Required</bridgehead>
78 <para role="required">
79 <xref linkend="libevdev"/> and
80 <xref linkend="mtdev"/>
81 </para>
82
83 <bridgehead renderas="sect5">Optional</bridgehead>
84 <para role="optional">
85 <xref linkend="valgrind"/> (to run the tests),
86 <ulink url="http://sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
87 <xref linkend="gtk3"/> (to build the GUI event viewer),
88 <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests),
89 <xref linkend="libwacom"/>, and
90 <ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
91 </para>
92
93 <para condition="html" role="usernotes">
94 User Notes: <ulink url="&blfs-wiki;/libinput"/>
95 </para>
96 </sect3>
97
98 <sect3 role="kernel" id="libinput-kernel">
99 <title>kernel configuration for running the libinput testsuite</title>
100
101 <para>
102 Although libinput works with the same kernel configuration used by <xref
103 linkend="libevdev"/>, its extensive testsuite requires the presence of
104 <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
105 and <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>).
106 </para>
107
108 <para>
109 If you wish to run the full tests, enable the following option in the kernel
110 configuration and recompile the kernel if necessary:
111 </para>
112
113<screen><literal>Device Drivers ---&gt;
114 Input device support ---&gt;
115 Miscellaneous Devices ---&gt;
116 &lt;*/M&gt; User level driver support [CONFIG_INPUT_UINPUT]</literal></screen>
117
118 <para>
119 If you build this as a module, it needs to be inserted before the testsuite
120 runs.
121 </para>
122
123 <para>
124 On an Xorg system you will also need to prevent the events generated
125 during the testsuite from interfering with your desktop. Copy the
126 file <filename>test/50-litest.conf</filename> into
127 <filename class="directory">${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
128 and restart X. For further information see
129 <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
130 </para>
131
132 <indexterm zone="libinput libinput-kernel">
133 <primary sortas="d-libinput">libinput</primary>
134 </indexterm>
135 </sect3>
136
137 <sect3 role="installation">
138 <title>Installation of libinput</title>
139
140 <para>
141 Install <application>libinput</application> by running the following
142 commands:
143 </para>
144
145<screen><userinput>mkdir build &amp;&amp;
146cd build &amp;&amp;
147
148meson --prefix=$XORG_PREFIX \
149 -Ddebug-gui=false \
150 -Dtests=false \
151 -Ddocumentation=false \
152 -Dlibwacom=false \
153 .. &amp;&amp;
154ninja</userinput></screen>
155
156 <note>
157 <para>
158 If you want to run the full tests, remove -Dtests from the
159 <command>meson</command> command above. Please read "kernel
160 configuration for running the libinput testsuite" (above).
161 </para>
162
163 <para>
164 If you have enabled the full tests, you can run the main tests
165 <emphasis>as the root user</emphasis> by executing:
166 <command>ninja test</command>. A very large number of tests will
167 be run, about 20 fail (at least on an Xorg system).
168 </para>
169 </note>
170
171 <para>
172 Now, as the <systemitem class="username">root</systemitem> user:
173 </para>
174
175<screen role="root"><userinput>ninja install</userinput></screen>
176
177 <para>
178 If <xref linkend="doxygen"/>, <xref linkend="graphviz"/>, and
179 <ulink url="http://sphinx-doc.org/">Sphinx</ulink> were
180 present during the build, you can install the generated documentation
181 by running the following commands as the <systemitem
182 class="username">root</systemitem> user:
183 </para>
184
185<screen role="root"
186 remap="doc"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version;/{html,api} &amp;&amp;
187cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html &amp;&amp;
188cp -rv api/* /usr/share/doc/libinput-&libinput-version;/api</userinput></screen>
189
190 </sect3>
191
192 <sect3 role="commands">
193 <title>Command Explanations</title>
194
195 <para>
196 <parameter>-Dudev-dir=/lib/udev</parameter>: This switch
197 specifies where UDev rules and hwdb files will be installed.
198 </para>
199
200 <para>
201 <parameter>-Ddebug-gui=false</parameter>: This switch
202 disables creation of a visual debug helper for libinput. Remove
203 if you want it, and you have <xref linkend="gtk3"/> installed.
204 </para>
205
206 <para>
207 <parameter>-Dtests=false</parameter>: This switch disables compilation of
208 the main tests. Even with the tests defined as false, you can still run
209 the first four minor tests, as a regular user, but one will be skipped if
210 <ulink url="https://pypi.org/project/pyparsing">PyParsing</ulink> is not
211 installed.
212 </para>
213
214 <para>
215 <parameter>-Ddocumentation=false</parameter>: 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 <parameter>-Dlibwacom=false</parameter>: Remove this option if you
223 have <xref linkend="libwacom"/> installed, or if you are installing
224 GNOME.
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 /etc/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.