glfs/x/installing/libinput.xml
Ken Moffat 6961e42346 Remove old text about symlinking a dbg version of ld: for any LFS build from the last fourteen months that will make the system both unusable and unbootable.
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20215 af4574ff-66df-0310-9fd7-8a98e5e911e0
2018-06-30 21:18:19 +00:00

281 lines
8.6 KiB
XML

<?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.10.7">
<!ENTITY libinput-download-http "https://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">
<!ENTITY libinput-download-ftp " ">
<!ENTITY libinput-md5sum "4369212564f8359f48c8f683c8c829b5">
<!ENTITY libinput-size "484 KB">
<!ENTITY libinput-buildsize "8.3 MB">
<!ENTITY libinput-time "less than 0.1 SBU">
]>
<sect2 id="libinput" xreflabel="libinput-&libinput-version;">
<?dbhtml filename="libinput.html"?>
<sect2info>
<othername>$LastChangedBy: renodr $</othername>
<date>$Date: 2015-09-14 17:42:53 -0500 (Mon, 14 Sep 2015) $</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>
&lfs82_checked;
<bridgehead renderas="sect4">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="sect4">libinput Dependencies</bridgehead>
<bridgehead renderas="sect5">Required</bridgehead>
<para role="required">
<xref linkend="libevdev"/> and
<xref linkend="mtdev"/>
</para>
<bridgehead renderas="sect5">Optional</bridgehead>
<para role="optional">
<xref linkend="valgrind"/> (to run the tests),
<xref linkend="doxygen"/> and
<xref linkend="graphviz"/> (to build the documentation)
<xref linkend="gtk3"/> (to build the GUI event viewer),
<ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests), and
<ulink revision="sysv" url="https://sourceforge.net/projects/linuxwacom/files/libwacom/">libwacom</ulink>
<xref revision="systemd" linkend="libwacom"/>
</para>
<para condition="html" role="usernotes">
User Notes: <ulink url="&blfs-wiki;/libinput"/>
</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 --prefix=$XORG_PREFIX \
-Dudev-dir=/lib/udev \
-Ddebug-gui=false \
-Dtests=false \
-Ddocumentation=false \
-Dlibwacom=false \
.. &amp;&amp;
ninja</userinput></screen>
<!--
<note>
<para>If you want to run the tests, remove -Dtests from the
<command>meson</command> command above. The external
library, libunwind, must be installed.</para>
</note>
<para>
Running the testsuite for this package can cause problems.
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>ninja test</userinput>. Note that depending on
the system configuration and hardware, some tests may fail.
</para>
-->
<para>
This package does not currently have a functioning test suite.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja 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 html/* /usr/share/doc/libinput-&libinput-version;</userinput></screen>
</sect3>
<sect3 role="commands">
<title>Command Explanations</title>
<para>
<option>-Dudev-dir=/lib/udev</option>: This switch
specifies where UDev rules and hwdb files will be installed.
</para>
<para>
<option>-Ddebug-gui=false</option>: This switch
disables creation of a visual debug helper for libinput. Remove
if you want it, and you have <xref linkend="gtk3"/> installed.
</para>
<para>
<option>-Dtests=false</option>: This switch disables compilation
of tests. Remove if you want to run the tests, and you have the external
libraries, libunwind and libwacom, installed.
</para>
<para>
<option>-Ddocumentation=false</option>: This switch disables
generation of the documentation. Remove if you want to generate it, and
you have <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
installed.
</para>
<para>
<option>-Dlibwacom=false</option>: Remove this
option if you have the external library libwacom installed.
</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, and
libinput-list-devices
</seg>
<seg>
libinput.so
</seg>
<seg>
$XORG_PREFIX/libexec/libinput and (optional)
/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-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-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-lib">libinput.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>