source: x/installing/libevdev.xml@ d9e1464

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 libevdev-version "1.13.1">

  <!ENTITY libevdev-download-http "https://www.freedesktop.org/software/libevdev/libevdev-&libevdev-version;.tar.xz">
  <!ENTITY libevdev-download-ftp  " ">
  <!ENTITY libevdev-md5sum        "58fe71aa6fd5e80d0928e9b691761311">
  <!ENTITY libevdev-size          "448 KB">
  <!ENTITY libevdev-buildsize     "6.0 MB (with tests)">
  <!ENTITY libevdev-time          "0.1 SBU (with tests)">
]>

  <!-- Begin Xorg libevdev Driver -->
  <sect2 id="libevdev" xreflabel="libevdev-&libevdev-version;">

  <sect2info>
    <date>$Date$</date>
  </sect2info>

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

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

    <sect3 role="package">
      <title>Introduction to libevdev</title>

      <para>
        The <application>libevdev</application> package contains common
        functions for Xorg input drivers.
      </para>

      &lfs113_checked;

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

      <bridgehead renderas="sect4">libevdev Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <xref linkend="doxygen"/> and
        <xref linkend="valgrind"/> (optional for tests)
      </para>

    </sect3>

    <sect3 role="kernel" id="libevdev-kernel">
      <title>Kernel Configuration</title>

      <para>
        Enable the following options in the kernel configuration and recompile
        the kernel if necessary:
      </para>

      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
        href="libevdev-kernel.xml"/>

      <para>
        The last item is not strictly required for libevdev. If it is
        compiled as a module, it is not loaded automatically.
        It is needed for full test coverage.
      </para>

      <indexterm zone="libevdev libevdev-kernel">
        <primary sortas="d-libevdev">libevdev</primary>
      </indexterm>
    </sect3>

    <sect3 role="installation">
      <title>Installation of libevdev</title>

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

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

meson setup ..                 \
      --prefix=$XORG_PREFIX    \
      --buildtype=release      \
      -Ddocumentation=disabled &amp;&amp;
ninja</userinput></screen>

      <para>
        The regression tests can be run as the <systemitem
        class="username">root</systemitem> user with <command>ninja
        test</command>, in a graphical session. You need to have enabled
        the CONFIG_INPUT_UINPUT setting in the kernel for full test coverage.
        If it is enabled as a module, the module is named
        <command>uinput</command> and needs to be loaded before running the
        tests. Note that on some systems, the
        tests may cause a hard lockup and require a reboot. On laptops, the
        system will go into Sleep and need to be woken up to finish the test
        suites.
      </para>

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

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

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

      <segmentedlist>
        <segtitle>Installed Xorg Programs</segtitle>
        <segtitle>Installed Xorg Library</segtitle>
        <segtitle>Installed Xorg Directory</segtitle>

        <seglistitem>
          <seg>
            libevdev-tweak-device, mouse-dpi-tool, and touchpad-edge-detector
          </seg>
          <seg>
            libevdev.so
          </seg>
          <seg>
            $XORG_PREFIX/include/libevdev-1.0
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="libevdev-tweak-device">
          <term><command>libevdev-tweak-device</command></term>
          <listitem>
            <para>
              is a tool to change some kernel device properties
            </para>
            <indexterm zone="libevdev libevdev-tweak-device">
              <primary sortas="b-libevdev-tweak-device">libevdev-tweak-device</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="mouse-dpi-tool">
          <term><command>mouse-dpi-tool</command></term>
          <listitem>
            <para>
              is a tool to estimate the resolution of a mouse
            </para>
            <indexterm zone="libevdev mouse-dpi-tool">
              <primary sortas="b-mouse-dpi-tool">mouse-dpi-tool</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="touchpad-edge-detector">
          <term><command>touchpad-edge-detector</command></term>
          <listitem>
            <para>
              touchpad-edge-detector is a tool that reads the touchpad events
              from the kernel and calculates the minimum and maximum for the x
              and y coordinates, respectively
            </para>
            <indexterm zone="libevdev touchpad-edge-detector">
              <primary sortas="b-touchpad-edge-detector">touchpad-edge-detector</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="libevdev-lib">
          <term><filename class="libraryfile">libevdev.so</filename></term>
          <listitem>
            <para>
              is a library of Xorg driver input functions
            </para>
            <indexterm zone="libevdev libevdev-lib">
              <primary sortas="c-libevdev-lib">ebvdev.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>