README.md

   1 libinput
   2 ========
   3
   4 libinput is a library that provides a full input stack for display servers
   5 and other applications that need to handle input devices provided by the
   6 kernel.
   7
   8 libinput provides device detection, event handling and abstraction to
   9 minimize the amount of custom input code the user of libinput needs to
  10 provide the common set of functionality that users expect. Input event
  11 processing includes scaling touch coordinates, generating
  12 relative pointer events from touchpads, pointer acceleration, etc.
  13
  14 User documentation
  15 ------------------
  16
  17 Documentation explaining features available in libinput is available
  18 [here](https://wayland.freedesktop.org/libinput/doc/latest/features.html).
  19
  20 This includes the [FAQ](https://wayland.freedesktop.org/libinput/doc/latest/faqs.html)
  21 and the instructions on
  22 [reporting bugs](https://wayland.freedesktop.org/libinput/doc/latest/reporting-bugs.html).
  23
  24
  25 Source code
  26 -----------
  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.html
  36
  37 Reporting Bugs
  38 --------------
  39
  40 Bugs can be filed on freedesktop.org GitLab:
  41 https://gitlab.freedesktop.org/libinput/libinput/issues/
  42
  43 Where possible, please provide the `libinput record` output
  44 of the input device and/or the event sequence in question.
  45
  46 See https://wayland.freedesktop.org/libinput/doc/latest/reporting-bugs.html
  47 for more info.
  48
  49 Documentation
  50 -------------
  51
  52 - Developer API documentation: https://wayland.freedesktop.org/libinput/doc/latest/development.html
  53 - High-level documentation about libinput's features:
  54   https://wayland.freedesktop.org/libinput/doc/latest/features.html
  55 - Build instructions:
  56   https://wayland.freedesktop.org/libinput/doc/latest/building.html
  57 - Documentation for previous versions of libinput: https://wayland.freedesktop.org/libinput/doc/
  58
  59 Examples of how to use libinput are the debugging tools in the libinput
  60 repository. Developers are encouraged to look at those tools for a
  61 real-world (yet simple) example on how to use libinput.
  62
  63 - A commandline debugging tool: https://gitlab.freedesktop.org/libinput/libinput/tree/master/tools/libinput-debug-events.c
  64 - A GTK application that draws cursor/touch/tablet positions: https://gitlab.freedesktop.org/libinput/libinput/tree/master/tools/libinput-debug-gui.c
  65
  66 License
  67 -------
  68
  69 libinput is licensed under the MIT license.
  70
  71 > Permission is hereby granted, free of charge, to any person obtaining a
  72 > copy of this software and associated documentation files (the "Software"),
  73 > to deal in the Software without restriction, including without limitation
  74 > the rights to use, copy, modify, merge, publish, distribute, sublicense,
  75 > and/or sell copies of the Software, and to permit persons to whom the
  76 > 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 About
  82 -----
  83
  84 Documentation generated from git commit [__GIT_VERSION__](https://gitlab.freedesktop.org/libinput/libinput/commit/__GIT_VERSION__)