mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-25 07:42:13 +08:00
298 lines
10 KiB
XML
298 lines
10 KiB
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.25.0">
|
|
|
|
<!-- <!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 " ">
|
|
<!ENTITY libinput-md5sum "fc582c553e40be99bea49adf6d4aa669">
|
|
<!ENTITY libinput-size "996 KB">
|
|
<!ENTITY libinput-buildsize "11 MB (add 23 MB for documentation and 9.6 MB for tests)">
|
|
<!ENTITY libinput-time "0.1 SBU (add 0.1 SBU for documentation and 4.9 SBU for tests)">
|
|
]>
|
|
|
|
<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;
|
|
|
|
<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="gtk3"/> (to build the GUI event viewer),
|
|
<xref linkend="libunwind"/> (required for tests),
|
|
<xref linkend="libwacom"/>,
|
|
<xref linkend="sphinx"/> (required to build documentation), and
|
|
<xref linkend="pyparsing"/> (for one non-root test)
|
|
</para>
|
|
|
|
</sect3>
|
|
|
|
<sect3 role="kernel" id="libinput-kernel">
|
|
<title>Kernel Configuration for Running the Libinput Test Suite</title>
|
|
|
|
<para>
|
|
Although libinput works with the same kernel configuration used by <xref
|
|
linkend="libevdev"/>, its extensive test suite requires the presence of
|
|
<filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
|
|
and <xref linkend="libunwind"/>).
|
|
</para>
|
|
|
|
<para>
|
|
If you wish to run the full tests, enable the following option in the kernel
|
|
configuration and recompile the kernel if necessary:
|
|
</para>
|
|
|
|
<!-- Yes, "libevdev" is not a typo. libinput test suite needs the
|
|
same option as libevdev. -->
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
href="libevdev-test-kernel.xml"/>
|
|
|
|
<para>
|
|
If you build this as a module, it needs to be inserted before the test suite
|
|
runs.
|
|
</para>
|
|
|
|
<para>
|
|
On an Xorg system you will also need to prevent the events generated
|
|
during the test suite from interfering with your desktop. Copy the
|
|
file <filename>test/50-litest.conf</filename> into
|
|
<filename class="directory">${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
|
|
and restart X. For further information see
|
|
<ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
|
|
</para>
|
|
|
|
<indexterm zone="libinput libinput-kernel">
|
|
<primary sortas="d-libinput">libinput</primary>
|
|
</indexterm>
|
|
</sect3>
|
|
|
|
<sect3 role="installation">
|
|
<title>Installation of Libinput</title>
|
|
|
|
<para>
|
|
Install <application>libinput</application> by running the following
|
|
commands:
|
|
</para>
|
|
|
|
<screen><userinput>mkdir build &&
|
|
cd build &&
|
|
|
|
meson setup --prefix=$XORG_PREFIX \
|
|
--buildtype=release \
|
|
-Ddebug-gui=false \
|
|
-Dtests=false \
|
|
-Dlibwacom=false \
|
|
-Dudev-dir=/usr/lib/udev \
|
|
.. &&
|
|
ninja</userinput></screen>
|
|
|
|
<note>
|
|
<para>
|
|
If you want to run the full tests, remove -Dtests from the
|
|
<command>meson</command> command above. Please read "kernel
|
|
configuration for running the libinput test suite" (above).
|
|
</para>
|
|
|
|
<para>
|
|
If you have enabled the full tests, you can run the main tests
|
|
<emphasis>as the root user</emphasis> by executing:
|
|
<command>ninja test</command>. A very large number of tests will
|
|
be run. One test fails on wayland.
|
|
</para>
|
|
</note>
|
|
|
|
<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 &&
|
|
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 <xref linkend="gtk3"/> installed.
|
|
</para>
|
|
|
|
<para>
|
|
<parameter>-Dtests=false</parameter>: This switch disables compilation of
|
|
the main tests. Even with the tests defined as false, you can still run
|
|
the first four minor tests, as a regular user, but one will be skipped if
|
|
<xref linkend="pyparsing"/> is not installed.
|
|
</para>
|
|
|
|
<para>
|
|
<parameter>-Dlibwacom=false</parameter>: Remove this option if you
|
|
have <xref linkend="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>
|
|
|
|
<para>
|
|
<option>-Ddocumentation=true</option>: This switch enables
|
|
generation of the documentation. Add it if you want to generate
|
|
the documentation. You must have <xref linkend="doxygen"/> and
|
|
<xref linkend="graphviz"/> 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, 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>
|