[69a16457] | 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 |
|
---|
[f948b30] | 7 | <!ENTITY libwacom-download-http "https://github.com/linuxwacom/libwacom/releases/download/libwacom-&libwacom-version;/libwacom-&libwacom-version;.tar.xz">
|
---|
[69a16457] | 8 | <!ENTITY libwacom-download-ftp " ">
|
---|
[5701f4b] | 9 | <!ENTITY libwacom-md5sum "cd27b77adf6cb23939dd9d91f4b2731c">
|
---|
| 10 | <!ENTITY libwacom-size "107 KB">
|
---|
| 11 | <!ENTITY libwacom-buildsize "5.3 MB (with tests)">
|
---|
[3c0f55bd] | 12 | <!ENTITY libwacom-time "less than 0.1 SBU (with tests)">
|
---|
[69a16457] | 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="libwacom" xreflabel="libwacom-&libwacom-version;">
|
---|
[69a16457] | 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 |
|
---|
[0ddf4e7] | 36 | &lfs112_checked;
|
---|
[69a16457] | 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">
|
---|
[914049f6] | 86 | <xref linkend="doxygen"/>,
|
---|
[844770f] | 87 | <xref linkend="git"/>,
|
---|
[51718d1] | 88 | <xref linkend="librsvg"/>,
|
---|
| 89 | <xref linkend="valgrind"/> (optional for some tests), and
|
---|
[5701f4b] | 90 | <ulink url="https://docs.pytest.org/en/stable/">pytest</ulink> with
|
---|
| 91 | <ulink url="https://pypi.org/project/libevdev/">python-libevdev</ulink> and
|
---|
| 92 | <ulink url="https://pypi.org/project/pyudev/">pyudev</ulink>
|
---|
[69a16457] | 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <para condition="html" role="usernotes">
|
---|
| 96 | User Notes: <ulink url="&blfs-wiki;/libwacom"/>
|
---|
| 97 | </para>
|
---|
| 98 | </sect2>
|
---|
| 99 |
|
---|
| 100 | <sect2 role="installation">
|
---|
| 101 | <title>Installation of libwacom</title>
|
---|
| 102 |
|
---|
[51718d1] | 103 | <!-- Fixed in libwacom-1.7
|
---|
[de35807d] | 104 | <para>
|
---|
| 105 | First, adapt the udev rules to upstream udev/kernel changes:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput remap="pre">sed -i 's/ACTION!="add|change"/ACTION=="remove"/' tools/65-libwacom.rules.in</userinput></screen>
|
---|
[51718d1] | 109 | -->
|
---|
[de35807d] | 110 |
|
---|
[69a16457] | 111 | <para>
|
---|
| 112 | Install <application>libwacom</application> by running the following
|
---|
| 113 | commands:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
[914049f6] | 116 | <screen><userinput>mkdir build &&
|
---|
| 117 | cd build &&
|
---|
| 118 |
|
---|
[20f070d8] | 119 | meson --prefix=/usr --buildtype=release -Dtests=disabled .. &&
|
---|
[914049f6] | 120 | ninja</userinput></screen>
|
---|
[69a16457] | 121 |
|
---|
| 122 | <para>
|
---|
[914049f6] | 123 | To test the results, issue: <command>ninja test</command>.
|
---|
[8558044] | 124 | To run additional tests, install
|
---|
[51718d1] | 125 | <ulink url="https://docs.pytest.org/en/stable/">pytest</ulink> and remove
|
---|
| 126 | the "-Dtests=disabled" option from the meson line above.
|
---|
[69a16457] | 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
[914049f6] | 133 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[69a16457] | 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | <sect2 role="commands">
|
---|
| 138 | <title>Command Explanations</title>
|
---|
| 139 |
|
---|
[20f070d8] | 140 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 141 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 142 |
|
---|
[51718d1] | 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 |
|
---|
[69a16457] | 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>
|
---|
[70896c42] | 162 | libwacom-list-devices,
|
---|
| 163 | libwacom-list-local-devices,
|
---|
| 164 | libwacom-show-stylus, and
|
---|
| 165 | libwacom-update-db
|
---|
[69a16457] | 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 |
|
---|
[70896c42] | 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 |
|
---|
[c744d0a5] | 194 | <varlistentry id="libwacom-list-local-devices">
|
---|
| 195 | <term><command>libwacom-list-local-devices</command></term>
|
---|
| 196 | <listitem>
|
---|
| 197 | <para>
|
---|
[4c24eb0a] | 198 | lists tablet devices that are connected to the system
|
---|
[c744d0a5] | 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 |
|
---|
[5d2965c] | 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 |
|
---|
[70896c42] | 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 |
|
---|
[69a16457] | 230 | <varlistentry id="libwacom-lib">
|
---|
| 231 | <term><filename class="libraryfile">libwacom.so</filename></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
[4c24eb0a] | 234 | contains functions used for accessing Wacom information
|
---|
[69a16457] | 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>
|
---|