glfs/shareddeps/dps/x/libinput.xml

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

<!--  <!ENTITY libinput-download-http "https://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">-->
  <!ENTITY libinput-download-http "https://gitlab.freedesktop.org/libinput/libinput/-/archive/&libinput-version;/libinput-&libinput-version;.tar.gz"
>
  <!ENTITY libinput-download-ftp  " ">
]>

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

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

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

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

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

      &lfs121_checked;

      <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>
      </itemizedlist>

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

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

    </sect3>

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

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

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

meson setup --prefix=$XORG_PREFIX    \
            --buildtype=release      \
            -Ddebug-gui=false        \
            -Dtests=false            \
            -Dlibwacom=false         \
            -Dudev-dir=/usr/lib/udev \
            ..                      &amp;&amp;
ninja</userinput></screen>

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

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

      <para>
        If you have passed <option>-Ddocumentation=true</option> to
        <command>meson</command>, you can install the generated documentation
        by running the following commands as the <systemitem
        class="username">root</systemitem> user:
      </para>

<!-- seems the api doc is not generated because the directory is not a git
     repository... -->
<screen role="root"
        remap="doc"><userinput>install -v -dm755      /usr/share/doc/libinput-&libinput-version;/html &amp;&amp;
cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html</userinput></screen>

    </sect3>

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

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

      <para>
        <parameter>-Ddebug-gui=false</parameter>: This switch
        disables creation of a visual debug helper for libinput. Remove
        if you want it, and you have GTK3 installed.
      </para>

      <para>
        <parameter>-Dlibwacom=false</parameter>: Remove this option if you
        have libwacom installed, or if you are installing
        GNOME.
      </para>

      <para>
        <parameter>-Dudev-dir=/usr/lib/udev</parameter>: In case that the
        value of <envar>XORG_PREFIX</envar> is not set to
        <filename class='directory'>/usr</filename>, this option prevents
        the package from installing Udev rules and helpers into
        <filename class='directory'>$XORG_PREFIX/lib/udev</filename> which
        is not searched by Udev daemon.  This option is not needed for
        systems with <envar>XORG_PREFIX</envar> set to
        <filename class='directory'>/usr</filename>, but does no harm.
      </para>

    </sect3>

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

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

        <seglistitem>
          <seg>
            libinput
            <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
            libinput-record, libinput-replay Library Executables -->
          </seg>
          <seg>
            libinput.so
          </seg>
          <seg>
            /etc/libinput,
            $XORG_PREFIX/libexec/libinput,
            $XORG_PREFIX/share/libinput, and (optionally)
            $XORG_PREFIX/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-prog">
          <term><command>libinput</command></term>
          <listitem>
            <para>
              is a set of tools to interface with the
              <application>libinput</application> library
            </para>
            <indexterm zone="libinput libinput-prog">
              <primary sortas="b-libinput-prog">libinput</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-lib">libinput.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>