index.rst 2.1 KB

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