source: general/genlib/libevdev.xml@ 99673f0

<?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-download-http "http://www.freedesktop.org/software/libevdev/libevdev-&libevdev-version;.tar.xz">
  <!ENTITY libevdev-download-ftp  " ">
  <!ENTITY libevdev-md5sum        "b66443bb664cfaf2ba7b3f8c238ea951">
  <!ENTITY libevdev-size          "404 KB">
  <!ENTITY libevdev-buildsize     "8.9 MB">
  <!ENTITY libevdev-time          "Less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      <application>libevdev</application> is a wrapper library for evdev
      devices. It moves the common tasks when dealing with evdev devices
      into a library and provides a library interface to the callers,
      thus avoiding erroneous ioctls, etc.
    </para>

    &lfs78_checked;

    <bridgehead renderas="sect3">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="sect3">libevdev Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="python2"/> or
      <xref linkend="python3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="check"/>,
      <xref linkend="doxygen"/> and
      <xref linkend="valgrind"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/libevdev"/>
    </para>
  </sect2>

  <sect2 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>

<screen><literal>Device Drivers  ---&gt;
  Input device support ---&gt;
    &lt;*&gt; Generic input layer (needed for...) [CONFIG_INPUT]
    &lt;*&gt;   Event interface                   [CONFIG_INPUT_EVDEV]
    [*]   Miscellaneous devices  ---&gt;       [CONFIG_INPUT_MISC]
      &lt;*&gt;    User level driver support      [CONFIG_INPUT_UINPUT]</literal></screen>

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

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      If you have the optional <xref linkend="check"/> package installed,
      the regression tests can be run as the <systemitem 
      class="username">root</systemitem> user with
      <userinput>make check</userinput>.
    </para>

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

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

  </sect2>

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

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

  </sect2>

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

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

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

    <variablelist>
      <bridgehead renderas="sect3">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>
            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>
            contains API functions for accessing evdev devices.
          </para>
          <indexterm zone="libevdev libevdev-lib">
            <primary sortas="c-libevdev">libevdev.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>