[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 |
|
---|
[44d67a6f] | 7 | <!ENTITY libinput-version "1.18.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 " ">
|
---|
[44d67a6f] | 11 | <!ENTITY libinput-md5sum "17057507ddbcad69ecc5de0dd9a05e47">
|
---|
| 12 | <!ENTITY libinput-size "608 KB">
|
---|
| 13 | <!ENTITY libinput-buildsize "13 MB">
|
---|
[9dac80b] | 14 | <!ENTITY libinput-time "less than 0.1 SBU">
|
---|
[f97d5f6] | 15 | ]>
|
---|
| 16 |
|
---|
[4c24eb0a] | 17 | <sect2 id="libinput" xreflabel="libinput-&libinput-version;">
|
---|
| 18 | <?dbhtml filename="libinput.html"?>
|
---|
[f97d5f6] | 19 |
|
---|
[4c24eb0a] | 20 | <sect2info>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect2info>
|
---|
[f97d5f6] | 23 |
|
---|
[4c24eb0a] | 24 | <title>libinput-&libinput-version;</title>
|
---|
[f97d5f6] | 25 |
|
---|
[4c24eb0a] | 26 | <indexterm zone="libinput">
|
---|
| 27 | <primary sortas="a-libinput">libinput</primary>
|
---|
| 28 | </indexterm>
|
---|
[f97d5f6] | 29 |
|
---|
[4c24eb0a] | 30 | <sect3 role="package">
|
---|
| 31 | <title>Introduction to libinput</title>
|
---|
[f97d5f6] | 32 |
|
---|
[4c24eb0a] | 33 | <para>
|
---|
| 34 | <application>libinput</application> is a library that handles
|
---|
| 35 | input devices for display servers and other applications that
|
---|
| 36 | need to directly deal with input devices.
|
---|
| 37 | </para>
|
---|
[f97d5f6] | 38 |
|
---|
[34a6571] | 39 | &lfs110a_checked;
|
---|
[f97d5f6] | 40 |
|
---|
[4c24eb0a] | 41 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&libinput-download-http;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&libinput-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download MD5 sum: &libinput-md5sum;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Download size: &libinput-size;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated disk space required: &libinput-buildsize;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>
|
---|
| 70 | Estimated build time: &libinput-time;
|
---|
| 71 | </para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">libinput Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 78 | <para role="required">
|
---|
| 79 | <xref linkend="libevdev"/> and
|
---|
| 80 | <xref linkend="mtdev"/>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
| 85 | <xref linkend="valgrind"/> (to run the tests),
|
---|
| 86 | <ulink url="http://sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
|
---|
| 87 | <xref linkend="gtk3"/> (to build the GUI event viewer),
|
---|
| 88 | <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink> (required for tests),
|
---|
| 89 | <xref linkend="libwacom"/>, and
|
---|
| 90 | <ulink url="https://pypi.org/project/pyparsing/">PyParsing</ulink> (for one non-root test)
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <para condition="html" role="usernotes">
|
---|
| 94 | User Notes: <ulink url="&blfs-wiki;/libinput"/>
|
---|
| 95 | </para>
|
---|
| 96 | </sect3>
|
---|
| 97 |
|
---|
| 98 | <sect3 role="kernel" id="libinput-kernel">
|
---|
| 99 | <title>kernel configuration for running the libinput testsuite</title>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | Although libinput works with the same kernel configuration used by <xref
|
---|
| 103 | linkend="libevdev"/>, its extensive testsuite requires the presence of
|
---|
| 104 | <filename>/dev/uinput</filename> (as well as both <xref linkend="valgrind"/>
|
---|
| 105 | and <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>).
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <para>
|
---|
| 109 | If you wish to run the full tests, enable the following option in the kernel
|
---|
| 110 | configuration and recompile the kernel if necessary:
|
---|
| 111 | </para>
|
---|
[2f2ca343] | 112 |
|
---|
| 113 | <screen><literal>Device Drivers --->
|
---|
| 114 | Input device support --->
|
---|
| 115 | Miscellaneous Devices --->
|
---|
| 116 | <*/M> User level driver support [CONFIG_INPUT_UINPUT]</literal></screen>
|
---|
| 117 |
|
---|
[4c24eb0a] | 118 | <para>
|
---|
| 119 | If you build this as a module, it needs to be inserted before the testsuite
|
---|
| 120 | runs.
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <para>
|
---|
| 124 | On an Xorg system you will also need to prevent the events generated
|
---|
| 125 | during the testsuite from interfering with your desktop. Copy the
|
---|
| 126 | file <filename>test/50-litest.conf</filename> into
|
---|
| 127 | <filename class="directory">${XORG_PREFIX}/share/X11/xorg.conf.d</filename>
|
---|
| 128 | and restart X. For further information see
|
---|
| 129 | <ulink url="https://wayland.freedesktop.org/libinput/doc/&libinput-version;/test-suite.html">libinput test suite</ulink>.
|
---|
| 130 | </para>
|
---|
[2f2ca343] | 131 |
|
---|
[4c24eb0a] | 132 | <indexterm zone="libinput libinput-kernel">
|
---|
| 133 | <primary sortas="d-libinput">libinput</primary>
|
---|
| 134 | </indexterm>
|
---|
| 135 | </sect3>
|
---|
[f97d5f6] | 136 |
|
---|
[4c24eb0a] | 137 | <sect3 role="installation">
|
---|
| 138 | <title>Installation of libinput</title>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | Install <application>libinput</application> by running the following
|
---|
| 142 | commands:
|
---|
| 143 | </para>
|
---|
[f97d5f6] | 144 |
|
---|
[9885a425] | 145 | <screen><userinput>mkdir build &&
|
---|
| 146 | cd build &&
|
---|
| 147 |
|
---|
| 148 | meson --prefix=$XORG_PREFIX \
|
---|
[adf17153] | 149 | --buildtype=release \
|
---|
[c28df1a9] | 150 | -Ddebug-gui=false \
|
---|
| 151 | -Dtests=false \
|
---|
| 152 | -Ddocumentation=false \
|
---|
| 153 | -Dlibwacom=false \
|
---|
[9885a425] | 154 | .. &&
|
---|
[c28df1a9] | 155 | ninja</userinput></screen>
|
---|
[f97d5f6] | 156 |
|
---|
[4c24eb0a] | 157 | <note>
|
---|
| 158 | <para>
|
---|
| 159 | If you want to run the full tests, remove -Dtests from the
|
---|
| 160 | <command>meson</command> command above. Please read "kernel
|
---|
| 161 | configuration for running the libinput testsuite" (above).
|
---|
| 162 | </para>
|
---|
| 163 |
|
---|
| 164 | <para>
|
---|
| 165 | If you have enabled the full tests, you can run the main tests
|
---|
| 166 | <emphasis>as the root user</emphasis> by executing:
|
---|
| 167 | <command>ninja test</command>. A very large number of tests will
|
---|
| 168 | be run, about 20 fail (at least on an Xorg system).
|
---|
| 169 | </para>
|
---|
| 170 | </note>
|
---|
[2f2ca343] | 171 |
|
---|
| 172 | <para>
|
---|
[4c24eb0a] | 173 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[2f2ca343] | 174 | </para>
|
---|
[f97d5f6] | 175 |
|
---|
[c28df1a9] | 176 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f97d5f6] | 177 |
|
---|
[4c24eb0a] | 178 | <para>
|
---|
| 179 | If <xref linkend="doxygen"/>, <xref linkend="graphviz"/>, and
|
---|
| 180 | <ulink url="http://sphinx-doc.org/">Sphinx</ulink> were
|
---|
| 181 | present during the build, you can install the generated documentation
|
---|
| 182 | by running the following commands as the <systemitem
|
---|
| 183 | class="username">root</systemitem> user:
|
---|
| 184 | </para>
|
---|
[f97d5f6] | 185 |
|
---|
[a42c273] | 186 | <screen role="root"
|
---|
| 187 | remap="doc"><userinput>install -v -dm755 /usr/share/doc/libinput-&libinput-version;/{html,api} &&
|
---|
[2b40bf6] | 188 | cp -rv Documentation/* /usr/share/doc/libinput-&libinput-version;/html &&
|
---|
| 189 | cp -rv api/* /usr/share/doc/libinput-&libinput-version;/api</userinput></screen>
|
---|
[f97d5f6] | 190 |
|
---|
[4c24eb0a] | 191 | </sect3>
|
---|
[f97d5f6] | 192 |
|
---|
[4c24eb0a] | 193 | <sect3 role="commands">
|
---|
| 194 | <title>Command Explanations</title>
|
---|
[f97d5f6] | 195 |
|
---|
[adf17153] | 196 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 197 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[2f2ca343] | 198 |
|
---|
[4c24eb0a] | 199 | <para>
|
---|
| 200 | <parameter>-Ddebug-gui=false</parameter>: This switch
|
---|
| 201 | disables creation of a visual debug helper for libinput. Remove
|
---|
| 202 | if you want it, and you have <xref linkend="gtk3"/> installed.
|
---|
| 203 | </para>
|
---|
[2f2ca343] | 204 |
|
---|
[4c24eb0a] | 205 | <para>
|
---|
| 206 | <parameter>-Dtests=false</parameter>: This switch disables compilation of
|
---|
| 207 | the main tests. Even with the tests defined as false, you can still run
|
---|
| 208 | the first four minor tests, as a regular user, but one will be skipped if
|
---|
| 209 | <ulink url="https://pypi.org/project/pyparsing">PyParsing</ulink> is not
|
---|
| 210 | installed.
|
---|
| 211 | </para>
|
---|
[f97d5f6] | 212 |
|
---|
[4c24eb0a] | 213 | <para>
|
---|
| 214 | <parameter>-Ddocumentation=false</parameter>: This switch disables
|
---|
| 215 | generation of the documentation. Remove if you want to generate it, and
|
---|
| 216 | you have <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
|
---|
| 217 | installed.
|
---|
| 218 | </para>
|
---|
[f97d5f6] | 219 |
|
---|
[4c24eb0a] | 220 | <para>
|
---|
| 221 | <parameter>-Dlibwacom=false</parameter>: Remove this option if you
|
---|
| 222 | have <xref linkend="libwacom"/> installed, or if you are installing
|
---|
| 223 | GNOME.
|
---|
| 224 | </para>
|
---|
[f97d5f6] | 225 |
|
---|
[4c24eb0a] | 226 | </sect3>
|
---|
| 227 |
|
---|
| 228 | <sect3 role="content">
|
---|
| 229 | <title>Contents</title>
|
---|
| 230 |
|
---|
| 231 | <segmentedlist>
|
---|
| 232 | <segtitle>Installed Programs</segtitle>
|
---|
| 233 | <segtitle>Installed Libraries</segtitle>
|
---|
| 234 | <segtitle>Installed Directories</segtitle>
|
---|
| 235 |
|
---|
| 236 | <seglistitem>
|
---|
| 237 | <seg>
|
---|
| 238 | libinput
|
---|
| 239 | <!-- libinput-debug-events, libinput-list-devices, libinput-measure*,
|
---|
| 240 | libinput-record, libinput-replay Library Executables -->
|
---|
| 241 | </seg>
|
---|
| 242 | <seg>
|
---|
| 243 | libinput.so
|
---|
| 244 | </seg>
|
---|
| 245 | <seg>
|
---|
| 246 | $XORG_PREFIX/libexec/libinput,
|
---|
[37ede2a] | 247 | /etc/libinput,
|
---|
[4c24eb0a] | 248 | /usr/share/libinput, and (optionally)
|
---|
| 249 | /usr/share/doc/libinput-&libinput-version;
|
---|
| 250 | </seg>
|
---|
| 251 | </seglistitem>
|
---|
| 252 | </segmentedlist>
|
---|
| 253 |
|
---|
| 254 | <variablelist>
|
---|
| 255 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 256 | <?dbfo list-presentation="list"?>
|
---|
| 257 | <?dbhtml list-presentation="table"?>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="libinput-prog">
|
---|
| 260 | <term><command>libinput</command></term>
|
---|
| 261 | <listitem>
|
---|
| 262 | <para>
|
---|
| 263 | is a set of tools to interface with the
|
---|
| 264 | <application>libinput</application> library
|
---|
| 265 | </para>
|
---|
| 266 | <indexterm zone="libinput libinput-prog">
|
---|
| 267 | <primary sortas="b-libinput-prog">libinput</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
| 271 | <!--
|
---|
| 272 | <varlistentry id="libinput-debug-events">
|
---|
| 273 | <term><command>libinput-debug-events</command></term>
|
---|
| 274 | <listitem>
|
---|
| 275 | <para>
|
---|
| 276 | is a debug helper for <application>libinput</application>.
|
---|
| 277 | </para>
|
---|
| 278 | <indexterm zone="libinput libinput-debug-events">
|
---|
| 279 | <primary sortas="b-libinput-debug-events">libinput-debug-events</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | <varlistentry id="libinput-list-devices">
|
---|
| 285 | <term><command>libinput-list-devices</command></term>
|
---|
| 286 | <listitem>
|
---|
| 287 | <para>
|
---|
| 288 | lists local devices as recognized by
|
---|
| 289 | <application>libinput</application>.
|
---|
| 290 | </para>
|
---|
| 291 | <indexterm zone="libinput libinput-list-devices">
|
---|
| 292 | <primary sortas="b-libinput-list-devices">libinput-list-devices</primary>
|
---|
| 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
| 296 |
|
---|
| 297 | <varlistentry id="libinput-measure">
|
---|
| 298 | <term><command>libinput-measure</command></term>
|
---|
| 299 | <listitem>
|
---|
| 300 | <para>
|
---|
| 301 | is the entry to a set of debugging programs to measure
|
---|
| 302 | the properties of one or more devices.
|
---|
| 303 | </para>
|
---|
| 304 | <indexterm zone="libinput libinput-measure">
|
---|
| 305 | <primary sortas="b-libinput-measure">libinput-measure</primary>
|
---|
| 306 | </indexterm>
|
---|
| 307 | </listitem>
|
---|
| 308 | </varlistentry>
|
---|
| 309 |
|
---|
| 310 | <varlistentry id="libinput-record">
|
---|
| 311 | <term><command>libinput-record</command></term>
|
---|
| 312 | <listitem>
|
---|
| 313 | <para>
|
---|
| 314 | records kernel events from a device in a form that can later be
|
---|
| 315 | replayed by libinput-replay.
|
---|
| 316 | </para>
|
---|
| 317 | <indexterm zone="libinput libinput-record">
|
---|
| 318 | <primary sortas="b-libinput-record">libinput-record</primary>
|
---|
| 319 | </indexterm>
|
---|
| 320 | </listitem>
|
---|
| 321 | </varlistentry>
|
---|
| 322 |
|
---|
| 323 | <varlistentry id="libinput-replay">
|
---|
| 324 | <term><command>libinput-replay</command></term>
|
---|
| 325 | <listitem>
|
---|
| 326 | <para>
|
---|
| 327 | replays kernel events from a recording made by libinput-record.
|
---|
| 328 | </para>
|
---|
| 329 | <indexterm zone="libinput libinput-replay">
|
---|
| 330 | <primary sortas="b-libinput-replay">libinput-replay</primary>
|
---|
| 331 | </indexterm>
|
---|
| 332 | </listitem>
|
---|
| 333 | </varlistentry>
|
---|
| 334 | -->
|
---|
| 335 | <varlistentry id="libinput-lib">
|
---|
| 336 | <term><filename class="libraryfile">libinput.so</filename></term>
|
---|
| 337 | <listitem>
|
---|
| 338 | <para>
|
---|
| 339 | contains API functions for handling input devices
|
---|
| 340 | </para>
|
---|
| 341 | <indexterm zone="libinput libinput-lib">
|
---|
| 342 | <primary sortas="c-libinput-lib">libinput.so</primary>
|
---|
| 343 | </indexterm>
|
---|
| 344 | </listitem>
|
---|
| 345 | </varlistentry>
|
---|
| 346 |
|
---|
| 347 | </variablelist>
|
---|
| 348 |
|
---|
| 349 | </sect3>
|
---|
| 350 |
|
---|
| 351 | </sect2>
|
---|