[f97d5f6] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[fd1a0a33] | 7 | <!ENTITY libinput-version "1.9.1">
|
---|
[f97d5f6] | 8 |
|
---|
[8dfc5c3] | 9 | <!ENTITY libinput-download-http "https://www.freedesktop.org/software/libinput/libinput-&libinput-version;.tar.xz">
|
---|
[f97d5f6] | 10 | <!ENTITY libinput-download-ftp " ">
|
---|
[fd1a0a33] | 11 | <!ENTITY libinput-md5sum "ce677ef7f209a2290a40ad1a73503f1c">
|
---|
[c28df1a9] | 12 | <!ENTITY libinput-size "448 KB">
|
---|
[fd1a0a33] | 13 | <!ENTITY libinput-buildsize "28 MB (with docs)">
|
---|
| 14 | <!ENTITY libinput-time "0.2 SBU (with docs)">
|
---|
[f97d5f6] | 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect2 id="libinput" xreflabel="libinput-&libinput-version;">
|
---|
| 18 | <?dbhtml filename="libinput.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect2info>
|
---|
| 21 | <othername>$LastChangedBy: renodr $</othername>
|
---|
| 22 | <date>$Date: 2015-09-14 17:42:53 -0500 (Mon, 14 Sep 2015) $</date>
|
---|
| 23 | </sect2info>
|
---|
| 24 |
|
---|
| 25 | <title>libinput-&libinput-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="libinput">
|
---|
| 28 | <primary sortas="a-libinput">libinput</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect3 role="package">
|
---|
| 32 | <title>Introduction to libinput</title>
|
---|
| 33 |
|
---|
| 34 | <para>
|
---|
| 35 | <application>libinput</application> is a library that handles
|
---|
| 36 | input devices for display servers and other applications that
|
---|
[d60a445] | 37 | need to directly deal with input devices.
|
---|
[f97d5f6] | 38 | </para>
|
---|
| 39 |
|
---|
[7655fafd] | 40 | &lfs81_checked;
|
---|
[f97d5f6] | 41 |
|
---|
| 42 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&libinput-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&libinput-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &libinput-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &libinput-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &libinput-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &libinput-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">libinput Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
| 80 | <xref linkend="libevdev"/> and
|
---|
| 81 | <xref linkend="mtdev"/>
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="check"/> and
|
---|
[f885719] | 87 | <xref linkend="valgrind"/> (to run the tests),
|
---|
[f97d5f6] | 88 | <xref linkend="doxygen"/> and
|
---|
| 89 | <xref linkend="graphviz"/> (to build the documentation)
|
---|
[0098ddeb] | 90 | <xref linkend="gtk3"/> (to build the GUI event viewer),
|
---|
[fa336b9] | 91 | <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests), and
|
---|
[69a16457] | 92 | <ulink revision="sysv" url="https://sourceforge.net/projects/linuxwacom/files/libwacom/">libwacom</ulink>
|
---|
| 93 | <xref revision="systemd" linkend="libwacom"/>
|
---|
[f97d5f6] | 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <para condition="html" role="usernotes">
|
---|
| 97 | User Notes: <ulink url="&blfs-wiki;/libinput"/>
|
---|
| 98 | </para>
|
---|
| 99 | </sect3>
|
---|
| 100 |
|
---|
| 101 | <sect3 role="installation">
|
---|
| 102 | <title>Installation of libinput</title>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | Install <application>libinput</application> by running the following
|
---|
| 106 | commands:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[9885a425] | 109 | <screen><userinput>mkdir build &&
|
---|
| 110 | cd build &&
|
---|
| 111 |
|
---|
| 112 | meson --prefix=$XORG_PREFIX \
|
---|
[c28df1a9] | 113 | -Dudev-dir=/lib/udev \
|
---|
| 114 | -Ddebug-gui=false \
|
---|
| 115 | -Dtests=false \
|
---|
| 116 | -Ddocumentation=false \
|
---|
| 117 | -Dlibwacom=false \
|
---|
[9885a425] | 118 | .. &&
|
---|
[c28df1a9] | 119 | ninja</userinput></screen>
|
---|
[f97d5f6] | 120 |
|
---|
[fd1a0a33] | 121 | <!--
|
---|
[747a35d] | 122 | <note>
|
---|
[c28df1a9] | 123 | <para>If you want to run the tests, remove -Dtests from the
|
---|
| 124 | <command>meson</command> command above. The external
|
---|
[99feb0ce] | 125 | library, libunwind, must be installed.</para>
|
---|
[747a35d] | 126 |
|
---|
| 127 | <para> To run the tests for this package, valgrind requires a version of
|
---|
| 128 | the /lib/ld-2.23.so (or later) library with debugging symbols present.
|
---|
[0134954] | 129 | Normally in LFS these debugging symbols are stripped at the end of
|
---|
| 130 | Chapter 6. To get this library, glibc must be rebuilt with the current
|
---|
| 131 | glibc version using the same compiler that was used to build LFS. The
|
---|
| 132 | ld-2.23.so can then be renamed to ld-2.23.so.dbg and copied to /lib.
|
---|
[f885719] | 133 | Then a symlink needs to be changed:</para>
|
---|
| 134 |
|
---|
[b64225a3] | 135 | <screen role="nodump"><userinput>ln -sfv ld-2.23.so.dbg /lib/ld-linux-x86-64.so.2</userinput></screen>
|
---|
[f885719] | 136 |
|
---|
[747a35d] | 137 | <para>Adjust the above instruction as needed for a 32-bit system
|
---|
| 138 | or for a different version of glibc</para>
|
---|
[f885719] | 139 |
|
---|
| 140 | </note>
|
---|
| 141 |
|
---|
[f97d5f6] | 142 | <para>
|
---|
[f885719] | 143 | Running the testsuite for this package can cause problems.
|
---|
| 144 | It creates a number of dummy input devices on the currently
|
---|
[f97d5f6] | 145 | running system that can lead to crashing a local X server or
|
---|
| 146 | a desktop environment. If you understand the risks and have
|
---|
| 147 | the optional <xref linkend="check"/> and
|
---|
| 148 | <xref linkend="valgrind"/> packages installed, the regression
|
---|
| 149 | tests can be run as the <systemitem
|
---|
| 150 | class="username">root</systemitem> user with
|
---|
[fd1a0a33] | 151 | <userinput>ninja test</userinput>. Note that depending on
|
---|
[f97d5f6] | 152 | the system configuration and hardware, some tests may fail.
|
---|
| 153 | </para>
|
---|
[fd1a0a33] | 154 | -->
|
---|
| 155 | <para>
|
---|
| 156 | This package does not currently have a functioning test suite.
|
---|
| 157 | </para>
|
---|
[f97d5f6] | 158 |
|
---|
| 159 | <para>
|
---|
| 160 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 161 | </para>
|
---|
| 162 |
|
---|
[c28df1a9] | 163 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f97d5f6] | 164 |
|
---|
| 165 | <para>
|
---|
| 166 | If <xref linkend="doxygen"/> and <xref linkend="graphviz"/> were
|
---|
| 167 | present during the build, you can install the generated documentation
|
---|
| 168 | by running the following commands as the <systemitem
|
---|
| 169 | class="username">root</systemitem> user:
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
[fd1a0a33] | 172 | <screen role="root"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version; &&
|
---|
| 173 | cp -rv html/* /usr/share/doc/libinput-&libinput-version;</userinput></screen>
|
---|
[f97d5f6] | 174 |
|
---|
| 175 | </sect3>
|
---|
| 176 |
|
---|
| 177 | <sect3 role="commands">
|
---|
| 178 | <title>Command Explanations</title>
|
---|
| 179 |
|
---|
[0098ddeb] | 180 | <para>
|
---|
[c28df1a9] | 181 | <option>-Dudev-dir=/lib/udev</option>: This switch
|
---|
| 182 | specifies where UDev rules and hwdb files will be installed.
|
---|
[0098ddeb] | 183 | </para>
|
---|
[f97d5f6] | 184 |
|
---|
| 185 | <para>
|
---|
[c28df1a9] | 186 | <option>-Ddebug-gui=false</option>: This switch
|
---|
[31016b9] | 187 | disables creation of a visual debug helper for libinput. Remove
|
---|
| 188 | if you want it, and you have <xref linkend="gtk3"/> installed.
|
---|
| 189 | </para>
|
---|
| 190 |
|
---|
| 191 | <para>
|
---|
[c28df1a9] | 192 | <option>-Dtests=false</option>: This switch disables compilation
|
---|
[31016b9] | 193 | of tests. Remove if you want to run the tests, and you have the external
|
---|
[fd1a0a33] | 194 | libraries, libunwind and libwacom, installed.
|
---|
[f97d5f6] | 195 | </para>
|
---|
| 196 |
|
---|
[5325348] | 197 | <para>
|
---|
[c28df1a9] | 198 | <option>-Ddocumentation=false</option>: This switch disables
|
---|
[31016b9] | 199 | generation of the documentation. Remove if you want to generate it, and
|
---|
| 200 | you have <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
|
---|
| 201 | installed.
|
---|
| 202 | </para>
|
---|
| 203 |
|
---|
| 204 | <para>
|
---|
[c28df1a9] | 205 | <option>-Dlibwacom=false</option>: Remove this
|
---|
| 206 | option if you have the external library libwacom installed.
|
---|
[5325348] | 207 | </para>
|
---|
| 208 |
|
---|
[f97d5f6] | 209 | </sect3>
|
---|
| 210 |
|
---|
| 211 | <sect3 role="content">
|
---|
| 212 | <title>Contents</title>
|
---|
| 213 |
|
---|
| 214 | <segmentedlist>
|
---|
| 215 | <segtitle>Installed Programs</segtitle>
|
---|
| 216 | <segtitle>Installed Libraries</segtitle>
|
---|
| 217 | <segtitle>Installed Directories</segtitle>
|
---|
| 218 |
|
---|
| 219 | <seglistitem>
|
---|
| 220 | <seg>
|
---|
[5325348] | 221 | libinput,
|
---|
| 222 | libinput-debug-events, and
|
---|
| 223 | libinput-list-devices
|
---|
[f97d5f6] | 224 | </seg>
|
---|
| 225 | <seg>
|
---|
| 226 | libinput.so
|
---|
| 227 | </seg>
|
---|
| 228 | <seg>
|
---|
[5325348] | 229 | $XORG_PREFIX/libexec/libinput and
|
---|
[fd1a0a33] | 230 | /usr/share/doc/libinput-&libinput-version;
|
---|
[f97d5f6] | 231 | </seg>
|
---|
| 232 | </seglistitem>
|
---|
| 233 | </segmentedlist>
|
---|
| 234 |
|
---|
| 235 | <variablelist>
|
---|
| 236 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 237 | <?dbfo list-presentation="list"?>
|
---|
| 238 | <?dbhtml list-presentation="table"?>
|
---|
| 239 |
|
---|
| 240 | <varlistentry id="libinput-debug-events">
|
---|
| 241 | <term><command>libinput-debug-events</command></term>
|
---|
| 242 | <listitem>
|
---|
| 243 | <para>
|
---|
| 244 | is a debug helper for <application>libinput</application>.
|
---|
| 245 | </para>
|
---|
| 246 | <indexterm zone="libinput libinput-debug-events">
|
---|
| 247 | <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
|
---|
| 248 | </indexterm>
|
---|
| 249 | </listitem>
|
---|
| 250 | </varlistentry>
|
---|
| 251 |
|
---|
| 252 | <varlistentry id="libinput-list-devices">
|
---|
| 253 | <term><command>libinput-list-devices</command></term>
|
---|
| 254 | <listitem>
|
---|
| 255 | <para>
|
---|
| 256 | lists local devices as recognized by
|
---|
| 257 | <application>libinput</application>.
|
---|
| 258 | </para>
|
---|
| 259 | <indexterm zone="libinput libinput-list-devices">
|
---|
| 260 | <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
|
---|
| 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
| 265 | <varlistentry id="libinput-lib">
|
---|
| 266 | <term><filename class="libraryfile">libinput.so</filename></term>
|
---|
| 267 | <listitem>
|
---|
| 268 | <para>
|
---|
| 269 | contains API functions for handling input devices.
|
---|
| 270 | </para>
|
---|
| 271 | <indexterm zone="libinput libinput-lib">
|
---|
| 272 | <primary sortas="c-libinput">libinput.so</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
| 277 | </variablelist>
|
---|
| 278 |
|
---|
| 279 | </sect3>
|
---|
| 280 |
|
---|
| 281 | </sect2>
|
---|