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 libevdev-version "1.13.3">
|
---|
8 |
|
---|
9 | <!ENTITY libevdev-download-http "https://www.freedesktop.org/software/libevdev/libevdev-&libevdev-version;.tar.xz">
|
---|
10 | <!ENTITY libevdev-download-ftp " ">
|
---|
11 | <!ENTITY libevdev-md5sum "57ee77b7d4c480747e693779bb92fb84">
|
---|
12 | <!ENTITY libevdev-size "452 KB">
|
---|
13 | <!ENTITY libevdev-buildsize "6.2 MB (with tests)">
|
---|
14 | <!ENTITY libevdev-time "less than 0.1 SBU (with tests)">
|
---|
15 | ]>
|
---|
16 |
|
---|
17 | <!-- Begin Xorg libevdev Driver -->
|
---|
18 | <sect2 id="libevdev" xreflabel="libevdev-&libevdev-version;">
|
---|
19 |
|
---|
20 | <sect2info>
|
---|
21 | <date>$Date$</date>
|
---|
22 | </sect2info>
|
---|
23 |
|
---|
24 | <title>libevdev &libevdev-version;</title>
|
---|
25 |
|
---|
26 | <indexterm zone="libevdev">
|
---|
27 | <primary sortas="a-libevdev">libevdev</primary>
|
---|
28 | </indexterm>
|
---|
29 |
|
---|
30 | <sect3 role="package">
|
---|
31 | <title>Introduction to libevdev</title>
|
---|
32 |
|
---|
33 | <para>
|
---|
34 | The <application>libevdev</application> package contains common
|
---|
35 | functions for Xorg input drivers.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs122_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&libevdev-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&libevdev-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &libevdev-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &libevdev-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &libevdev-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &libevdev-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">libevdev Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
77 | <para role="optional">
|
---|
78 | <xref linkend="doxygen"/> and
|
---|
79 | <xref linkend="valgrind"/> (optional for tests)
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | </sect3>
|
---|
83 |
|
---|
84 | <sect3 role="kernel" id="libevdev-kernel">
|
---|
85 | <title>Kernel Configuration</title>
|
---|
86 |
|
---|
87 | <para>
|
---|
88 | Enable the following options in the kernel configuration and recompile
|
---|
89 | the kernel if necessary:
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
93 | href="libevdev-kernel.xml"/>
|
---|
94 |
|
---|
95 | <para>
|
---|
96 | If you want to test this package with full coverage,
|
---|
97 | the following options are needed as well:
|
---|
98 | </para>
|
---|
99 |
|
---|
100 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
101 | href="libevdev-test-kernel.xml"/>
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | If you build this as a module, it needs to be inserted before the test suite
|
---|
105 | runs.
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <indexterm zone="libevdev libevdev-kernel">
|
---|
109 | <primary sortas="d-libevdev">libevdev</primary>
|
---|
110 | </indexterm>
|
---|
111 | </sect3>
|
---|
112 |
|
---|
113 | <sect3 role="installation">
|
---|
114 | <title>Installation of libevdev</title>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | Install <application>libevdev</application> by running the following
|
---|
118 | commands:
|
---|
119 | </para>
|
---|
120 |
|
---|
121 | <screen><userinput>mkdir build &&
|
---|
122 | cd build &&
|
---|
123 |
|
---|
124 | meson setup .. \
|
---|
125 | --prefix=$XORG_PREFIX \
|
---|
126 | --buildtype=release \
|
---|
127 | -D documentation=disabled &&
|
---|
128 | ninja</userinput></screen>
|
---|
129 |
|
---|
130 | <para>
|
---|
131 | The regression tests can be run as the <systemitem
|
---|
132 | class="username">root</systemitem> user with <command>ninja
|
---|
133 | test</command>, in a graphical session. You need to have enabled
|
---|
134 | the CONFIG_INPUT_UINPUT setting in the kernel for full test coverage.
|
---|
135 | If it is enabled as a module, the module is named
|
---|
136 | <command>uinput</command> and needs to be loaded before running the
|
---|
137 | tests. Note that on some systems, the
|
---|
138 | tests may cause a hard lockup and require a reboot. On laptops, the
|
---|
139 | system will go into Sleep and need to be woken up to finish the test
|
---|
140 | suites.
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | <para>
|
---|
144 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
145 | </para>
|
---|
146 |
|
---|
147 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
148 | </sect3>
|
---|
149 |
|
---|
150 | <sect3 role="content">
|
---|
151 | <title>Contents</title>
|
---|
152 |
|
---|
153 | <segmentedlist>
|
---|
154 | <segtitle>Installed Xorg Programs</segtitle>
|
---|
155 | <segtitle>Installed Xorg Library</segtitle>
|
---|
156 | <segtitle>Installed Xorg Directory</segtitle>
|
---|
157 |
|
---|
158 | <seglistitem>
|
---|
159 | <seg>
|
---|
160 | libevdev-tweak-device, mouse-dpi-tool, and touchpad-edge-detector
|
---|
161 | </seg>
|
---|
162 | <seg>
|
---|
163 | libevdev.so
|
---|
164 | </seg>
|
---|
165 | <seg>
|
---|
166 | $XORG_PREFIX/include/libevdev-1.0
|
---|
167 | </seg>
|
---|
168 | </seglistitem>
|
---|
169 | </segmentedlist>
|
---|
170 |
|
---|
171 | <variablelist>
|
---|
172 | <bridgehead renderas="sect4">Short Descriptions</bridgehead>
|
---|
173 | <?dbfo list-presentation="list"?>
|
---|
174 | <?dbhtml list-presentation="table"?>
|
---|
175 |
|
---|
176 | <varlistentry id="libevdev-tweak-device">
|
---|
177 | <term><command>libevdev-tweak-device</command></term>
|
---|
178 | <listitem>
|
---|
179 | <para>
|
---|
180 | is a tool to change some kernel device properties
|
---|
181 | </para>
|
---|
182 | <indexterm zone="libevdev libevdev-tweak-device">
|
---|
183 | <primary sortas="b-libevdev-tweak-device">libevdev-tweak-device</primary>
|
---|
184 | </indexterm>
|
---|
185 | </listitem>
|
---|
186 | </varlistentry>
|
---|
187 |
|
---|
188 | <varlistentry id="mouse-dpi-tool">
|
---|
189 | <term><command>mouse-dpi-tool</command></term>
|
---|
190 | <listitem>
|
---|
191 | <para>
|
---|
192 | is a tool to estimate the resolution of a mouse
|
---|
193 | </para>
|
---|
194 | <indexterm zone="libevdev mouse-dpi-tool">
|
---|
195 | <primary sortas="b-mouse-dpi-tool">mouse-dpi-tool</primary>
|
---|
196 | </indexterm>
|
---|
197 | </listitem>
|
---|
198 | </varlistentry>
|
---|
199 |
|
---|
200 | <varlistentry id="touchpad-edge-detector">
|
---|
201 | <term><command>touchpad-edge-detector</command></term>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | touchpad-edge-detector is a tool that reads the touchpad events
|
---|
205 | from the kernel and calculates the minimum and maximum for the x
|
---|
206 | and y coordinates, respectively
|
---|
207 | </para>
|
---|
208 | <indexterm zone="libevdev touchpad-edge-detector">
|
---|
209 | <primary sortas="b-touchpad-edge-detector">touchpad-edge-detector</primary>
|
---|
210 | </indexterm>
|
---|
211 | </listitem>
|
---|
212 | </varlistentry>
|
---|
213 |
|
---|
214 | <varlistentry id="libevdev-lib">
|
---|
215 | <term><filename class="libraryfile">libevdev.so</filename></term>
|
---|
216 | <listitem>
|
---|
217 | <para>
|
---|
218 | is a library of Xorg driver input functions
|
---|
219 | </para>
|
---|
220 | <indexterm zone="libevdev libevdev-lib">
|
---|
221 | <primary sortas="c-libevdev-lib">ebvdev.so</primary>
|
---|
222 | </indexterm>
|
---|
223 | </listitem>
|
---|
224 | </varlistentry>
|
---|
225 |
|
---|
226 | </variablelist>
|
---|
227 |
|
---|
228 | </sect3>
|
---|
229 |
|
---|
230 | </sect2>
|
---|