mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2025-12-20 04:30:06 +01:00
bc9f16b40e
To quote Bryce Harrington from [1]: "MIT has released software under several slightly different licenses, including the old 'X11 License' or 'MIT License'. Some code under this license was in fact included in X.org's Xserver in the past. However, X.org now prefers the MIT Expat License as the standard (which, confusingly, is also referred to as the 'MIT License'). See http://cgit.freedesktop.org/xorg/xserver/tree/COPYING When Wayland started, it was Kristian Høgsberg's intent to license it compatibly with X.org. "I wanted Wayland to be usable (license-wise) whereever X was usable." But, the text of the older X11 License was taken for Wayland, rather than X11's current standard. This patch corrects this by swapping in the intended text." libinput is a fork of weston and thus inherited the original license intent and the license boilerplate itself. See this thread on wayland-devel here for a discussion: http://lists.freedesktop.org/archives/wayland-devel/2015-May/022301.html [1] http://lists.freedesktop.org/archives/wayland-devel/2015-June/022552.html Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Hans de Goede <hdegoede@redhat.com> Acked-by: Benjamin Tissoires <benjamin.tissoires@gmail.com> Acked-by: Jonas Ådahl <jadahl@gmail.com>
83 lines
2.7 KiB
Text
83 lines
2.7 KiB
Text
/*!@mainpage
|
|
|
|
libinput
|
|
========
|
|
|
|
libinput is a library that handles input devices for display servers and other
|
|
applications that need to directly deal with input devices.
|
|
|
|
It provides device detection, device handling, input device event processing
|
|
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
|
|
pointer events from touchpads, pointer acceleration, etc.
|
|
|
|
libinput originates from
|
|
[weston](http://cgit.freedesktop.org/wayland/weston/), the Wayland reference
|
|
compositor.
|
|
|
|
Architecture
|
|
------------
|
|
|
|
libinput is not used directly by applications, rather it is used by the
|
|
xf86-input-libinput X.Org driver or wayland compositors. The typical
|
|
software stack for a system running Wayland is:
|
|
|
|
@dotfile libinput-stack-wayland.gv
|
|
|
|
Where the Wayland compositor may be Weston, mutter, KWin, etc. Note that
|
|
Wayland encourages the use of toolkits, so the Wayland client (your
|
|
application) does not usually talk directly to the compositor but rather
|
|
employs a toolkit (e.g. GTK) to do so.
|
|
|
|
The simplified software stack for a system running X.Org is:
|
|
|
|
@dotfile libinput-stack-xorg.gv
|
|
|
|
Again, on a modern system the application does not usually talk directly to
|
|
the X server using Xlib but rather employs a toolkit to do so.
|
|
|
|
Source code
|
|
-----------
|
|
|
|
The source code of libinput can be found at:
|
|
http://cgit.freedesktop.org/wayland/libinput
|
|
|
|
For a list of current and past releases visit:
|
|
http://www.freedesktop.org/wiki/Software/libinput/
|
|
|
|
Reporting Bugs
|
|
--------------
|
|
|
|
Bugs can be filed in the libinput component of Wayland:
|
|
https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland&component=libinput
|
|
|
|
Where possible, please provide an
|
|
[evemu](http://www.freedesktop.org/wiki/Evemu/) recording of the input
|
|
device and/or the event sequence in question.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Developer API documentation:
|
|
http://wayland.freedesktop.org/libinput/doc/latest/modules.html
|
|
|
|
High-level documentation about libinput's features:
|
|
http://wayland.freedesktop.org/libinput/doc/latest/pages.html
|
|
|
|
License
|
|
-------
|
|
|
|
libinput is licensed under the MIT license.
|
|
|
|
> 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: [...]
|
|
|
|
See the [COPYING](http://cgit.freedesktop.org/wayland/libinput/tree/COPYING)
|
|
file for the full license information.
|
|
|
|
*/
|