1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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.26.2">
|
---|
8 |
|
---|
9 | <!-- <!ENTITY libinput-download-http "https://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">-->
|
---|
10 | <!ENTITY libinput-download-http "https://gitlab.freedesktop.org/libinput/libinput/-/archive/&libinput-version;/libinput-&libinput-version;.tar.gz"
|
---|
11 | >
|
---|
12 | <!ENTITY libinput-download-ftp " ">
|
---|
13 | <!ENTITY libinput-md5sum "65bfce1b15c7b2375d4df4f390a9233f">
|
---|
14 | <!ENTITY libinput-size "1.0 MB">
|
---|
15 | <!ENTITY libinput-buildsize "11 MB (add 23 MB for documentation and 9.6 MB for tests)">
|
---|
16 | <!ENTITY libinput-time "0.1 SBU (add 0.1 SBU for documentation and 4.9 SBU for tests)">
|
---|
17 | ]>
|
---|
18 |
|
---|
19 | <sect2 id="libinput" xreflabel="libinput-&libinput-version;">
|
---|
20 | <?dbhtml filename="libinput.html"?>
|
---|
21 |
|
---|
22 | <sect2info>
|
---|
23 | <date>$Date$</date>
|
---|
24 | </sect2info>
|
---|
25 |
|
---|
26 | <title>libinput-&libinput-version;</title>
|
---|
27 |
|
---|
28 | <indexterm zone="libinput">
|
---|
29 | <primary sortas="a-libinput">libinput</primary>
|
---|
30 | </indexterm>
|
---|
31 |
|
---|
32 | <sect3 role="package">
|
---|
33 | <title>Introduction to Libinput</title>
|
---|
34 |
|
---|
35 | <para>
|
---|
36 | <application>libinput</application> is a library that handles
|
---|
37 | input devices for display servers and other applications that
|
---|
38 | need to directly deal with input devices.
|
---|
39 | </para>
|
---|
40 |
|
---|
41 | &lfs122_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (HTTP): <ulink url="&libinput-download-http;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download (FTP): <ulink url="&libinput-download-ftp;"/>
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download MD5 sum: &libinput-md5sum;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download size: &libinput-size;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated disk space required: &libinput-buildsize;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Estimated build time: &libinput-time;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | </itemizedlist>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">libinput Dependencies</bridgehead>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
80 | <para role="required">
|
---|
81 | <xref linkend="libevdev"/> and
|
---|
82 | <xref linkend="mtdev"/>
|
---|
83 | </para>
|
---|
84 |
|
---|
85 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
86 | <para role="optional">
|
---|
87 | <xref linkend="valgrind"/> (to run the tests),
|
---|
88 | <xref linkend="gtk3"/> (to build the GUI event viewer),
|
---|
89 | <xref linkend="libunwind"/> (required for tests),
|
---|
90 | <xref linkend="libwacom"/>,
|
---|
91 | <xref linkend="sphinx"/> (required to build documentation), and
|
---|
92 | <xref linkend="pyparsing"/> (for one non-root test)
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | </sect3>
|
---|
96 |
|
---|
97 | <sect3 role="kernel" id="libinput-kernel">
|
---|
98 | <title>Kernel Configuration for Running the Libinput Test Suite</title>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | Although libinput works with the same kernel configuration used by <xref
|
---|
102 | linkend="libevdev"/>, its extensive test suite requires the presence of
|
---|
103 | <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
|
---|
104 | and <xref linkend="libunwind"/>).
|
---|
105 | </para>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | If you wish to run the full tests, enable the following option in the kernel
|
---|
109 | configuration and recompile the kernel if necessary:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <!-- Yes, "libevdev" is not a typo. libinput test suite needs the
|
---|
113 | same option as libevdev. -->
|
---|
114 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
115 | href="libevdev-test-kernel.xml"/>
|
---|
116 |
|
---|
117 | <para>
|
---|
118 | If you build this as a module, it needs to be inserted before the test suite
|
---|
119 | runs.
|
---|
120 | </para>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | On an Xorg system you will also need to prevent the events generated
|
---|
124 | during the test suite from interfering with your desktop. Copy the
|
---|
125 | file <filename>test/50-litest.conf</filename> into
|
---|
126 | <filename class="directory">${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
|
---|
127 | and restart X. For further information see
|
---|
128 | <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <indexterm zone="libinput libinput-kernel">
|
---|
132 | <primary sortas="d-libinput">libinput</primary>
|
---|
133 | </indexterm>
|
---|
134 | </sect3>
|
---|
135 |
|
---|
136 | <sect3 role="installation">
|
---|
137 | <title>Installation of Libinput</title>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | Install <application>libinput</application> by running the following
|
---|
141 | commands:
|
---|
142 | </para>
|
---|
143 |
|
---|
144 | <screen><userinput>mkdir build &&
|
---|
145 | cd build &&
|
---|
146 |
|
---|
147 | meson setup .. \
|
---|
148 | --prefix=$XORG_PREFIX \
|
---|
149 | --buildtype=release \
|
---|
150 | -D debug-gui=false \
|
---|
151 | -D tests=false \
|
---|
152 | -D libwacom=false \
|
---|
153 | -D udev-dir=/usr/lib/udev &&
|
---|
154 | ninja</userinput></screen>
|
---|
155 |
|
---|
156 | <note>
|
---|
157 | <para>
|
---|
158 | If you want to run the full tests, remove -D tests from the
|
---|
159 | <command>meson</command> command above. Please read "kernel
|
---|
160 | configuration for running the libinput test suite" (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. One test fails on wayland.
|
---|
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 you have passed <option>-D documentation=true</option> to
|
---|
179 | <command>meson</command>, you can install the generated documentation
|
---|
180 | by running the following commands as the <systemitem
|
---|
181 | class="username">root</systemitem> user:
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <!-- seems the api doc is not generated because the directory is not a git
|
---|
185 | repository... -->
|
---|
186 | <screen role="root"
|
---|
187 | remap="doc"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version;/html &&
|
---|
188 | cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html</userinput></screen>
|
---|
189 |
|
---|
190 | </sect3>
|
---|
191 |
|
---|
192 | <sect3 role="commands">
|
---|
193 | <title>Command Explanations</title>
|
---|
194 |
|
---|
195 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
196 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
197 |
|
---|
198 | <para>
|
---|
199 | <parameter>-D debug-gui=false</parameter>: This switch
|
---|
200 | disables creation of a visual debug helper for libinput. Remove
|
---|
201 | if you want it, and you have <xref linkend="gtk3"/> installed.
|
---|
202 | </para>
|
---|
203 |
|
---|
204 | <para>
|
---|
205 | <parameter>-D tests=false</parameter>: This switch disables compilation of
|
---|
206 | the main tests. Even with the tests defined as false, you can still run
|
---|
207 | the first four minor tests, as a regular user, but one will be skipped if
|
---|
208 | <xref linkend="pyparsing"/> is not installed.
|
---|
209 | </para>
|
---|
210 |
|
---|
211 | <para>
|
---|
212 | <parameter>-D libwacom=false</parameter>: Remove this option if you
|
---|
213 | have <xref linkend="libwacom"/> installed, or if you are installing
|
---|
214 | GNOME.
|
---|
215 | </para>
|
---|
216 |
|
---|
217 | <para>
|
---|
218 | <parameter>-D udev-dir=/usr/lib/udev</parameter>: In case that the
|
---|
219 | value of <envar>XORG_PREFIX</envar> is not set to
|
---|
220 | <filename class='directory'>/usr</filename>, this option prevents
|
---|
221 | the package from installing Udev rules and helpers into
|
---|
222 | <filename class='directory'>$XORG_PREFIX/lib/udev</filename> which
|
---|
223 | is not searched by Udev daemon. This option is not needed for
|
---|
224 | systems with <envar>XORG_PREFIX</envar> set to
|
---|
225 | <filename class='directory'>/usr</filename>, but does no harm.
|
---|
226 | </para>
|
---|
227 |
|
---|
228 | <para>
|
---|
229 | <option>-D documentation=true</option>: This switch enables
|
---|
230 | generation of the documentation. Add it if you want to generate
|
---|
231 | the documentation. You must have <xref linkend="doxygen"/> and
|
---|
232 | <xref linkend="graphviz"/> installed.
|
---|
233 | </para>
|
---|
234 |
|
---|
235 | </sect3>
|
---|
236 |
|
---|
237 | <sect3 role="content">
|
---|
238 | <title>Contents</title>
|
---|
239 |
|
---|
240 | <segmentedlist>
|
---|
241 | <segtitle>Installed Programs</segtitle>
|
---|
242 | <segtitle>Installed Libraries</segtitle>
|
---|
243 | <segtitle>Installed Directories</segtitle>
|
---|
244 |
|
---|
245 | <seglistitem>
|
---|
246 | <seg>
|
---|
247 | libinput
|
---|
248 | <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
|
---|
249 | libinput-record, libinput-replay Library Executables -->
|
---|
250 | </seg>
|
---|
251 | <seg>
|
---|
252 | libinput.so
|
---|
253 | </seg>
|
---|
254 | <seg>
|
---|
255 | /etc/libinput,
|
---|
256 | $XORG_PREFIX/libexec/libinput,
|
---|
257 | $XORG_PREFIX/share/libinput, and (optionally)
|
---|
258 | $XORG_PREFIX/share/doc/libinput-&libinput-version;
|
---|
259 | </seg>
|
---|
260 | </seglistitem>
|
---|
261 | </segmentedlist>
|
---|
262 |
|
---|
263 | <variablelist>
|
---|
264 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
265 | <?dbfo list-presentation="list"?>
|
---|
266 | <?dbhtml list-presentation="table"?>
|
---|
267 |
|
---|
268 | <varlistentry id="libinput-prog">
|
---|
269 | <term><command>libinput</command></term>
|
---|
270 | <listitem>
|
---|
271 | <para>
|
---|
272 | is a set of tools to interface with the
|
---|
273 | <application>libinput</application> library
|
---|
274 | </para>
|
---|
275 | <indexterm zone="libinput libinput-prog">
|
---|
276 | <primary sortas="b-libinput-prog">libinput</primary>
|
---|
277 | </indexterm>
|
---|
278 | </listitem>
|
---|
279 | </varlistentry>
|
---|
280 |
|
---|
281 | <varlistentry id="libinput-lib">
|
---|
282 | <term><filename class="libraryfile">libinput.so</filename></term>
|
---|
283 | <listitem>
|
---|
284 | <para>
|
---|
285 | contains API functions for handling input devices
|
---|
286 | </para>
|
---|
287 | <indexterm zone="libinput libinput-lib">
|
---|
288 | <primary sortas="c-libinput-lib">libinput.so</primary>
|
---|
289 | </indexterm>
|
---|
290 | </listitem>
|
---|
291 | </varlistentry>
|
---|
292 |
|
---|
293 | </variablelist>
|
---|
294 |
|
---|
295 | </sect3>
|
---|
296 |
|
---|
297 | </sect2>
|
---|