source: x/installing/libevdev.xml@ b73999c

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since b73999c was c8013f54, checked in by Pierre Labastie <pierre.labastie@…>, 23 months ago

Fix setting of "documentation" in libevedev meson

It is not a boolean, but a string which can be "auto", "enabled", or
"disabled".

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