| 1 |
|
| 2 |
.. toctree:: |
| 3 |
:maxdepth: 2 |
| 4 |
:hidden: |
| 5 |
|
| 6 |
what-is-libinput |
| 7 |
features |
| 8 |
configuration |
| 9 |
building |
| 10 |
faqs |
| 11 |
reporting-bugs |
| 12 |
troubleshooting |
| 13 |
contributing |
| 14 |
development |
| 15 |
lua-plugins |
| 16 |
API documentation <@HTTP_DOC_LINK@/api/> |
| 17 |
|
| 18 |
|
| 19 |
++++++++++++++++++++++++++++++ |
| 20 |
libinput |
| 21 |
++++++++++++++++++++++++++++++ |
| 22 |
|
| 23 |
libinput is a library that provides a full input stack for display servers |
| 24 |
and other applications that need to handle input devices provided by the |
| 25 |
kernel. |
| 26 |
|
| 27 |
libinput provides device detection, event handling and abstraction to |
| 28 |
minimize the amount of custom input code the user of libinput need to |
| 29 |
provide the common set of functionality that users expect. Input event |
| 30 |
processing includes scaling touch coordinates, generating |
| 31 |
relative pointer events from touchpads, pointer acceleration, etc. |
| 32 |
|
| 33 |
libinput is not used directly by applications. Think of it more as a device |
| 34 |
driver than an application library. See :ref:`what_is_libinput` for more details. |
| 35 |
|
| 36 |
-------------------- |
| 37 |
Users and Developers |
| 38 |
-------------------- |
| 39 |
|
| 40 |
Please use the side-bar to navigate through the various documentation items. |
| 41 |
|
| 42 |
----------------- |
| 43 |
API documentation |
| 44 |
----------------- |
| 45 |
|
| 46 |
The API documentation is available here: |
| 47 |
https://wayland.freedesktop.org/libinput/doc/latest/api/ |
| 48 |
|
| 49 |
.. note:: This documentation is generally only needed by authors of Wayland |
| 50 |
compositors or other developers dealing with input events directly. |
| 51 |
|
| 52 |
------- |
| 53 |
License |
| 54 |
------- |
| 55 |
|
| 56 |
libinput is licensed under the MIT license |
| 57 |
|
| 58 |
.. code-block:: none |
| 59 |
|
| 60 |
Permission is hereby granted, free of charge, to any person obtaining a |
| 61 |
copy of this software and associated documentation files (the "Software"), |
| 62 |
to deal in the Software without restriction, including without limitation |
| 63 |
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 64 |
and/or sell copies of the Software, and to permit persons to whom the |
| 65 |
Software is furnished to do so, subject to the following conditions: [...] |
| 66 |
|
| 67 |
See the |
| 68 |
`COPYING <https://gitlab.freedesktop.org/libinput/libinput/tree/master/COPYING>`_ |
| 69 |
file for the full license information. |
| 70 |
|
| 71 |
..... |
| 72 |
About |
| 73 |
..... |
| 74 |
Documentation generated from |git_version| |