README.md 3.18 KB
Newer Older
Jonas Ådahl's avatar
Jonas Ådahl committed
1
libinput
2
========
Jonas Ådahl's avatar
Jonas Ådahl committed
3

4 5 6
libinput is a library that provides a full input stack for display servers
and other applications that need to handle input devices provided by the
kernel.
Jonas Ådahl's avatar
Jonas Ådahl committed
7

8 9 10 11 12
libinput provides device detection, event handling and abstraction so
minimize the amount of custom input code the user of libinput need to
provide the common set of functionality that users expect. Input event
processing includes scaling touch coordinates, generating
relative pointer events from touchpads, pointer acceleration, etc.
13

14 15 16 17 18 19 20 21 22 23 24
User documentation
------------------

Documentation explaining features available in libinput is available
[here](https://wayland.freedesktop.org/libinput/doc/latest/pages.html).

This includes the [FAQ](https://wayland.freedesktop.org/libinput/doc/latest/faq.html)
and the instructions on
[reporting bugs](https://wayland.freedesktop.org/libinput/doc/latest/reporting_bugs.html).


25 26
Source code
-----------
Jonas Ådahl's avatar
Jonas Ådahl committed
27 28

The source code of libinput can be found at:
29
https://gitlab.freedesktop.org/libinput/libinput
30

31
For a list of current and past releases visit:
32
https://www.freedesktop.org/wiki/Software/libinput/
33

34
Build instructions:
35
https://wayland.freedesktop.org/libinput/doc/latest/building_libinput.html
36

37 38 39
Reporting Bugs
--------------

40 41
Bugs can be filed on freedesktop.org GitLab:
https://gitlab.freedesktop.org/libinput/libinput/issues/
42

43 44
Where possible, please provide the `libinput record` output
of the input device and/or the event sequence in question.
45

46 47
See https://wayland.freedesktop.org/libinput/doc/latest/reporting-bugs.html
for more info.
48

49 50 51
Documentation
-------------

52
- Developer API documentation: https://wayland.freedesktop.org/libinput/doc/latest/modules.html
53
- High-level documentation about libinput's features:
54
  https://wayland.freedesktop.org/libinput/doc/latest/pages.html
55
- Build instructions:
56
  https://wayland.freedesktop.org/libinput/doc/latest/building_libinput.html
57
- Documentation for previous versions of libinput: https://wayland.freedesktop.org/libinput/doc/
58

59 60 61 62
Examples of how to use libinput are the debugging tools in the libinput
repository. Developers are encouraged to look at those tools for a
real-world (yet simple) example on how to use libinput.

63 64
- A commandline debugging tool: https://gitlab.freedesktop.org/libinput/libinput/tree/master/tools/libinput-debug-events.c
- A GTK application that draws cursor/touch/tablet positions: https://gitlab.freedesktop.org/libinput/libinput/tree/master/tools/libinput-debug-gui.c
65

66 67 68 69 70
License
-------

libinput is licensed under the MIT license.

71 72 73 74 75 76
> Permission is hereby granted, free of charge, to any person obtaining a
> copy of this software and associated documentation files (the "Software"),
> to deal in the Software without restriction, including without limitation
> the rights to use, copy, modify, merge, publish, distribute, sublicense,
> and/or sell copies of the Software, and to permit persons to whom the
> Software is furnished to do so, subject to the following conditions: [...]
77

78
See the [COPYING](https://gitlab.freedesktop.org/libinput/libinput/tree/master/COPYING)
79
file for the full license information.
80 81 82 83 84

About
-----

Documentation generated by from git commit [__GIT_VERSION__](https://gitlab.freedesktop.org/libinput/libinput/commit/__GIT_VERSION__)