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