source: general/genlib/libwacom.xml@ 4dbe57c

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libwacom-download-http "https://github.com/linuxwacom/libwacom/releases/download/libwacom-&libwacom-version;/libwacom-&libwacom-version;.tar.xz">
  <!ENTITY libwacom-download-ftp  " ">
  <!ENTITY libwacom-md5sum        "7005d961cc44995d8c04d586fa060c63">
  <!ENTITY libwacom-size          "152 KB">
  <!ENTITY libwacom-buildsize     "7.9 MB (with tests)">
  <!ENTITY libwacom-time          "less than 0.1 SBU (with tests)">
]>

<sect1 id="libwacom" xreflabel="libwacom-&libwacom-version;">
  <?dbhtml filename="libwacom.html"?>


  <title>libwacom-&libwacom-version;</title>

  <indexterm zone="libwacom">
    <primary sortas="a-libwacom">libwacom</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libwacom</title>

    <para>
      The <application>libwacom</application> package contains a library used
      to identify graphics tablets from Wacom or various other vendors and
      their model-specific features.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libwacom-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libwacom-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libwacom-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libwacom-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libwacom-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libwacom-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libwacom Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libevdev"/> and
      <xref linkend="libgudev"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>,
      <xref linkend="git"/>,
      <xref linkend="librsvg"/>,
      <xref linkend="valgrind"/> (optional for some tests), and
      <xref linkend="pytest"/> with
      <ulink url="https://pypi.org/project/libevdev/">python-libevdev</ulink> and
      <ulink url="https://pypi.org/project/pyudev/">pyudev</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libwacom</title>

<!--  Fixed in libwacom-1.7
    <para>
      First, adapt the udev rules to upstream udev/kernel changes:
    </para>

<screen><userinput remap="pre">sed -i 's/ACTION!="add|change"/ACTION=="remove"/' tools/65-libwacom.rules.in</userinput></screen>
-->

    <para>
      Install <application>libwacom</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -D tests=disabled    &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      To run additional tests, install
      <xref linkend="pytest"/>, python-libevdev, and pyudev, then remove
      the "-D tests=disabled" option from the meson line above.
    </para>

    <!-- The duplicated match is causing many mutter test failures if
         unfixed. It also prevents running any of the utilities -->
    <para>
      If upgrading from a previous version of libwacom, remove the old
      device database installation to prevent a potential duplicated match
      of devices in case some old database files are not overwritten:
    </para>

    <screen role="root"><userinput>rm -rf /usr/share/libwacom</userinput></screen>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <parameter>-D tests=disabled</parameter>: This parameter disables some of
      the more advanced tests because they require <xref linkend="pytest"/> and
      other two Python modules beyond the scope of BLFS to work properly.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libwacom-list-devices,
          libwacom-list-local-devices,
          libwacom-show-stylus, and
          libwacom-update-db
        </seg>
        <seg>
          libwacom.so
        </seg>
        <seg>
          /usr/include/libwacom-1.0 and
          /usr/share/libwacom
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libwacom-list-devices">
        <term><command>libwacom-list-devices</command></term>
        <listitem>
          <para>
            lists all tablet devices that are supported by libwacom
          </para>
          <indexterm zone="libwacom libwacom-list-devices">
            <primary sortas="b-libwacom-list-devices">libwacom-list-devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwacom-list-local-devices">
        <term><command>libwacom-list-local-devices</command></term>
        <listitem>
          <para>
            lists tablet devices that are connected to the system
          </para>
          <indexterm zone="libwacom libwacom-list-local-devices">
            <primary sortas="b-libwacom-list-local-devices">libwacom-list-local-devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwacom-show-stylus">
        <term><command>libwacom-show-stylus</command></term>
        <listitem>
          <para>
            lists tablet stylus IDs
          </para>
          <indexterm zone="libwacom libwacom-show-stylus">
            <primary sortas="b-libwacom-show-stylus">libwacom-show-stylus</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwacom-update-db">
        <term><command>libwacom-update-db</command></term>
        <listitem>
          <para>
            updates the system according to the current set of tablet data files
          </para>
          <indexterm zone="libwacom libwacom-update-db">
            <primary sortas="b-libwacom-update-db">libwacom-update-db</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwacom-lib">
        <term><filename class="libraryfile">libwacom.so</filename></term>
        <listitem>
          <para>
            contains functions used for accessing Wacom information
          </para>
          <indexterm zone="libwacom libwacom-lib">
            <primary sortas="c-libwacom">libwacom.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>