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 libwacom-download-http "https://github.com/linuxwacom/libwacom/releases/download/libwacom-&libwacom-version;/libwacom-&libwacom-version;.tar.xz">
|
---|
8 | <!ENTITY libwacom-download-ftp " ">
|
---|
9 | <!ENTITY libwacom-md5sum "7005d961cc44995d8c04d586fa060c63">
|
---|
10 | <!ENTITY libwacom-size "152 KB">
|
---|
11 | <!ENTITY libwacom-buildsize "7.9 MB (with tests)">
|
---|
12 | <!ENTITY libwacom-time "less than 0.1 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libwacom" xreflabel="libwacom-&libwacom-version;">
|
---|
16 | <?dbhtml filename="libwacom.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>libwacom-&libwacom-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="libwacom">
|
---|
22 | <primary sortas="a-libwacom">libwacom</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to libwacom</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>libwacom</application> package contains a library used
|
---|
30 | to identify graphics tablets from Wacom or various other vendors and
|
---|
31 | their model-specific features.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs121_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&libwacom-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&libwacom-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &libwacom-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &libwacom-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &libwacom-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &libwacom-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">libwacom Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="libevdev"/> and
|
---|
75 | <xref linkend="libgudev"/>
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
79 | <para role="recommended">
|
---|
80 | <xref linkend="libxml2"/>
|
---|
81 | </para>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
84 | <para role="optional">
|
---|
85 | <xref linkend="doxygen"/>,
|
---|
86 | <xref linkend="git"/>,
|
---|
87 | <xref linkend="librsvg"/>,
|
---|
88 | <xref linkend="valgrind"/> (optional for some tests), and
|
---|
89 | <xref linkend="pytest"/> with
|
---|
90 | <ulink url="https://pypi.org/project/libevdev/">python-libevdev</ulink> and
|
---|
91 | <ulink url="https://pypi.org/project/pyudev/">pyudev</ulink>
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of libwacom</title>
|
---|
98 |
|
---|
99 | <!-- Fixed in libwacom-1.7
|
---|
100 | <para>
|
---|
101 | First, adapt the udev rules to upstream udev/kernel changes:
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <screen><userinput remap="pre">sed -i 's/ACTION!="add|change"/ACTION=="remove"/' tools/65-libwacom.rules.in</userinput></screen>
|
---|
105 | -->
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Install <application>libwacom</application> by running the following
|
---|
109 | commands:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen><userinput>mkdir build &&
|
---|
113 | cd build &&
|
---|
114 |
|
---|
115 | meson setup .. \
|
---|
116 | --prefix=/usr \
|
---|
117 | --buildtype=release \
|
---|
118 | -D tests=disabled &&
|
---|
119 | ninja</userinput></screen>
|
---|
120 |
|
---|
121 | <para>
|
---|
122 | To test the results, issue: <command>ninja test</command>.
|
---|
123 | To run additional tests, install
|
---|
124 | <xref linkend="pytest"/>, python-libevdev, and pyudev, then remove
|
---|
125 | the "-D tests=disabled" option from the meson line above.
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <!-- The duplicated match is causing many mutter test failures if
|
---|
129 | unfixed. It also prevents running any of the utilities -->
|
---|
130 | <para>
|
---|
131 | If upgrading from a previous version of libwacom, remove the old
|
---|
132 | device database installation to prevent a potential duplicated match
|
---|
133 | of devices in case some old database files are not overwritten:
|
---|
134 | </para>
|
---|
135 |
|
---|
136 | <screen role="root"><userinput>rm -rf /usr/share/libwacom</userinput></screen>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
140 | </para>
|
---|
141 |
|
---|
142 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
143 |
|
---|
144 | </sect2>
|
---|
145 |
|
---|
146 | <sect2 role="commands">
|
---|
147 | <title>Command Explanations</title>
|
---|
148 |
|
---|
149 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
150 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
151 |
|
---|
152 | <para>
|
---|
153 | <parameter>-D tests=disabled</parameter>: This parameter disables some of
|
---|
154 | the more advanced tests because they require <xref linkend="pytest"/> and
|
---|
155 | other two Python modules beyond the scope of BLFS to work properly.
|
---|
156 | </para>
|
---|
157 |
|
---|
158 | </sect2>
|
---|
159 |
|
---|
160 | <sect2 role="content">
|
---|
161 | <title>Contents</title>
|
---|
162 |
|
---|
163 | <segmentedlist>
|
---|
164 | <segtitle>Installed Programs</segtitle>
|
---|
165 | <segtitle>Installed Libraries</segtitle>
|
---|
166 | <segtitle>Installed Directories</segtitle>
|
---|
167 |
|
---|
168 | <seglistitem>
|
---|
169 | <seg>
|
---|
170 | libwacom-list-devices,
|
---|
171 | libwacom-list-local-devices,
|
---|
172 | libwacom-show-stylus, and
|
---|
173 | libwacom-update-db
|
---|
174 | </seg>
|
---|
175 | <seg>
|
---|
176 | libwacom.so
|
---|
177 | </seg>
|
---|
178 | <seg>
|
---|
179 | /usr/include/libwacom-1.0 and
|
---|
180 | /usr/share/libwacom
|
---|
181 | </seg>
|
---|
182 | </seglistitem>
|
---|
183 | </segmentedlist>
|
---|
184 |
|
---|
185 | <variablelist>
|
---|
186 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
187 | <?dbfo list-presentation="list"?>
|
---|
188 | <?dbhtml list-presentation="table"?>
|
---|
189 |
|
---|
190 | <varlistentry id="libwacom-list-devices">
|
---|
191 | <term><command>libwacom-list-devices</command></term>
|
---|
192 | <listitem>
|
---|
193 | <para>
|
---|
194 | lists all tablet devices that are supported by libwacom
|
---|
195 | </para>
|
---|
196 | <indexterm zone="libwacom libwacom-list-devices">
|
---|
197 | <primary sortas="b-libwacom-list-devices">libwacom-list-devices</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | <varlistentry id="libwacom-list-local-devices">
|
---|
203 | <term><command>libwacom-list-local-devices</command></term>
|
---|
204 | <listitem>
|
---|
205 | <para>
|
---|
206 | lists tablet devices that are connected to the system
|
---|
207 | </para>
|
---|
208 | <indexterm zone="libwacom libwacom-list-local-devices">
|
---|
209 | <primary sortas="b-libwacom-list-local-devices">libwacom-list-local-devices</primary>
|
---|
210 | </indexterm>
|
---|
211 | </listitem>
|
---|
212 | </varlistentry>
|
---|
213 |
|
---|
214 | <varlistentry id="libwacom-show-stylus">
|
---|
215 | <term><command>libwacom-show-stylus</command></term>
|
---|
216 | <listitem>
|
---|
217 | <para>
|
---|
218 | lists tablet stylus IDs
|
---|
219 | </para>
|
---|
220 | <indexterm zone="libwacom libwacom-show-stylus">
|
---|
221 | <primary sortas="b-libwacom-show-stylus">libwacom-show-stylus</primary>
|
---|
222 | </indexterm>
|
---|
223 | </listitem>
|
---|
224 | </varlistentry>
|
---|
225 |
|
---|
226 | <varlistentry id="libwacom-update-db">
|
---|
227 | <term><command>libwacom-update-db</command></term>
|
---|
228 | <listitem>
|
---|
229 | <para>
|
---|
230 | updates the system according to the current set of tablet data files
|
---|
231 | </para>
|
---|
232 | <indexterm zone="libwacom libwacom-update-db">
|
---|
233 | <primary sortas="b-libwacom-update-db">libwacom-update-db</primary>
|
---|
234 | </indexterm>
|
---|
235 | </listitem>
|
---|
236 | </varlistentry>
|
---|
237 |
|
---|
238 | <varlistentry id="libwacom-lib">
|
---|
239 | <term><filename class="libraryfile">libwacom.so</filename></term>
|
---|
240 | <listitem>
|
---|
241 | <para>
|
---|
242 | contains functions used for accessing Wacom information
|
---|
243 | </para>
|
---|
244 | <indexterm zone="libwacom libwacom-lib">
|
---|
245 | <primary sortas="c-libwacom">libwacom.so</primary>
|
---|
246 | </indexterm>
|
---|
247 | </listitem>
|
---|
248 | </varlistentry>
|
---|
249 |
|
---|
250 | </variablelist>
|
---|
251 |
|
---|
252 | </sect2>
|
---|
253 |
|
---|
254 | </sect1>
|
---|