source: general/genlib/libinput.xml@ d679563

<?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 libinput-version "1.1.7">

  <!ENTITY libinput-download-http "http://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">
  <!ENTITY libinput-download-ftp  " ">
  <!ENTITY libinput-md5sum        "a501715a6135ac1f772bb5f3e3183481">
  <!ENTITY libinput-size          "808 KB">
  <!ENTITY libinput-buildsize     "32 MB">
  <!ENTITY libinput-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      <application>libinput</application> is a library that handles
      input devices for display servers and other applications that
      need to directly deal with input devices.
    </para>

    &lfs77_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="check"/> and
      <xref linkend="valgrind"/> (to build the tests),
      <xref linkend="doxygen"/> and
      <xref linkend="graphviz"/> (to build the documentation)
      <xref linkend="gtk3"/> (to build the GUI event viewer) and
      <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --with-udev-dir=/lib/udev &amp;&amp;
make</userinput></screen>

    <para>
      Running the testsuite for this package can be dangerous, as
      it creates a number of dummy input devices on the currently
      running system that can lead to crashing a local X server or
      a desktop environment. If you understand the risks and have
      the optional <xref linkend="check"/> and
      <xref linkend="valgrind"/> packages installed, the regression
      tests can be run as the <systemitem
      class="username">root</systemitem> user with
      <userinput>make check</userinput>. Note that depending on
      the system configuration and hardware, some tests may fail.
    </para>

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

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

    <para>
      If <xref linkend="doxygen"/> and <xref linkend="graphviz"/> were
      present during the build, you can install the generated documentation
      by running the following commands as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version; &amp;&amp;
cp -rv doc/html/* /usr/share/doc/libinput-&libinput-version;</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"/>

    <para>
      <parameter>--with-udev-dir=/lib/udev</parameter>: This switch
      specifies where UDev rules and hwdb files will be installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          libinput-debug-events and libinput-list-devices
        </seg>
        <seg>
          libinput.so
        </seg>
        <seg>
          /usr/share/doc/libinput-&libinput-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libinput-debug-events">
        <term><command>libinput-debug-events</command></term>
        <listitem>
          <para>
            is a debug helper for <application>libinput</application>.
          </para>
          <indexterm zone="libinput libinput-debug-events">
            <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libinput-list-devices">
        <term><command>libinput-list-devices</command></term>
        <listitem>
          <para>
            lists local devices as recognized by
            <application>libinput</application>.
          </para>
          <indexterm zone="libinput libinput-list-devices">
            <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libinput-lib">
        <term><filename class="libraryfile">libinput.so</filename></term>
        <listitem>
          <para>
            contains API functions for handling input devices.
          </para>
          <indexterm zone="libinput libinput-lib">
            <primary sortas="c-libinput">libinput.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>