source: general/genlib/libwacom.xml@ 70896c42

11.0 qt5new trunk
Last change on this file since 70896c42 was 70896c42, checked in by Douglas R. Reno <renodr@…>, 5 months ago

libwacom: update installed files and descriptions

  • Property mode set to 100644
File size: 7.2 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 libwacom-download-http "https://github.com/linuxwacom/libwacom/releases/download/libwacom-&libwacom-version;/libwacom-&libwacom-version;.tar.bz2">
8 <!ENTITY libwacom-download-ftp " ">
9 <!ENTITY libwacom-md5sum "a8b3a66adbdb6ebaf86d051a8005f5d2">
10 <!ENTITY libwacom-size "508 KB">
11 <!ENTITY libwacom-buildsize "6.2 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 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>libwacom-&libwacom-version;</title>
23
24 <indexterm zone="libwacom">
25 <primary sortas="a-libwacom">libwacom</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to libwacom</title>
30
31 <para>
32 The <application>libwacom</application> package contains a library used
33 to identify wacom tablets and their model-specific features.
34 </para>
35
36 &lfs101_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&libwacom-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&libwacom-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &libwacom-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &libwacom-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &libwacom-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &libwacom-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">libwacom Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="libgudev"/>
77 </para>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref linkend="libxml2"/>
82 </para>
83
84 <bridgehead renderas="sect4">Optional</bridgehead>
85 <para role="optional">
86 <xref linkend="doxygen"/>,
87 <xref linkend="git"/>,
88 <xref linkend="librsvg"/>,
89 <xref linkend="valgrind"/> (optional for some tests), and
90 <ulink url="https://docs.pytest.org/en/stable/">pytest</ulink>
91 </para>
92
93 <para condition="html" role="usernotes">
94 User Notes: <ulink url="&blfs-wiki;/libwacom"/>
95 </para>
96 </sect2>
97
98 <sect2 role="installation">
99 <title>Installation of libwacom</title>
100
101<!-- Fixed in libwacom-1.7
102 <para>
103 First, adapt the udev rules to upstream udev/kernel changes:
104 </para>
105
106<screen><userinput remap="pre">sed -i 's/ACTION!="add|change"/ACTION=="remove"/' tools/65-libwacom.rules.in</userinput></screen>
107-->
108
109 <para>
110 Install <application>libwacom</application> by running the following
111 commands:
112 </para>
113
114<screen><userinput>mkdir build &amp;&amp;
115cd build &amp;&amp;
116
117meson --prefix=/usr -Dudev-dir=/lib/udev -Dtests=disabled .. &amp;&amp;
118ninja</userinput></screen>
119
120 <para>
121 To test the results, issue: <command>ninja test</command>.
122 To run additional tests, install
123 <ulink url="https://docs.pytest.org/en/stable/">pytest</ulink> and remove
124 the "-Dtests=disabled" option from the meson line above.
125 </para>
126
127 <para>
128 Now, as the <systemitem class="username">root</systemitem> user:
129 </para>
130
131<screen role="root"><userinput>ninja install</userinput></screen>
132
133 </sect2>
134
135 <sect2 role="commands">
136 <title>Command Explanations</title>
137
138 <para>
139 <parameter>-Dudev-dir=/lib/udev</parameter>: This parameter sets the
140 proper installation directory for udev rules.
141 </para>
142
143 <para>
144 <parameter>-Dtests=disabled</parameter>: This parameter disables some of
145 the more advanced tests because they require
146 <ulink url="https://docs.pytest.org/en/stable/">pytest</ulink> to work
147 properly.
148 </para>
149
150 </sect2>
151
152 <sect2 role="content">
153 <title>Contents</title>
154
155 <segmentedlist>
156 <segtitle>Installed Programs</segtitle>
157 <segtitle>Installed Libraries</segtitle>
158 <segtitle>Installed Directories</segtitle>
159
160 <seglistitem>
161 <seg>
162 libwacom-list-devices,
163 libwacom-list-local-devices,
164 libwacom-show-stylus, and
165 libwacom-update-db
166 </seg>
167 <seg>
168 libwacom.so
169 </seg>
170 <seg>
171 /usr/include/libwacom-1.0 and
172 /usr/share/libwacom
173 </seg>
174 </seglistitem>
175 </segmentedlist>
176
177 <variablelist>
178 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
179 <?dbfo list-presentation="list"?>
180 <?dbhtml list-presentation="table"?>
181
182 <varlistentry id="libwacom-list-devices">
183 <term><command>libwacom-list-devices</command></term>
184 <listitem>
185 <para>
186 lists all tablet devices that are supported by libwacom
187 </para>
188 <indexterm zone="libwacom libwacom-list-devices">
189 <primary sortas="b-libwacom-list-devices">libwacom-list-devices</primary>
190 </indexterm>
191 </listitem>
192 </varlistentry>
193
194 <varlistentry id="libwacom-list-local-devices">
195 <term><command>libwacom-list-local-devices</command></term>
196 <listitem>
197 <para>
198 lists tablet devices that are connected to the system
199 </para>
200 <indexterm zone="libwacom libwacom-list-local-devices">
201 <primary sortas="b-libwacom-list-local-devices">libwacom-list-local-devices</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="libwacom-show-stylus">
207 <term><command>libwacom-show-stylus</command></term>
208 <listitem>
209 <para>
210 lists tablet stylus IDs
211 </para>
212 <indexterm zone="libwacom libwacom-show-stylus">
213 <primary sortas="b-libwacom-show-stylus">libwacom-show-stylus</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="libwacom-update-db">
219 <term><command>libwacom-update-db</command></term>
220 <listitem>
221 <para>
222 updates the system according to the current set of tablet data files
223 </para>
224 <indexterm zone="libwacom libwacom-update-db">
225 <primary sortas="b-libwacom-update-db">libwacom-update-db</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="libwacom-lib">
231 <term><filename class="libraryfile">libwacom.so</filename></term>
232 <listitem>
233 <para>
234 contains functions used for accessing Wacom information
235 </para>
236 <indexterm zone="libwacom libwacom-lib">
237 <primary sortas="c-libwacom">libwacom.so</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 </variablelist>
243
244 </sect2>
245
246</sect1>
Note: See TracBrowser for help on using the repository browser.