libinput/doc/user/features.rst

.. _features:

==============================================================================
libinput Features
==============================================================================

Below is a list of features supported by libinput. The availability of
features usually depends on the device type and a device's capabilities.
Not all features are user-configurable, some rely on :ref:`device-quirks`
to be useful.


.. toctree::
   :maxdepth: 1

   button-debouncing.rst
   clickpad-softbuttons.rst
   gestures.rst
   middle-button-emulation.rst
   palm-detection.rst
   touchpad-thumb-detection.rst
   scrolling.rst
   t440-support.rst
   tapping.rst
   drag-3fg.rst
   tablet-support.rst
   switches.rst
   touchpad-pressure.rst
   trackpoints.rst
dox: switch to sphinx for the user-visible documentation This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-10 17:32:35 +10:00			`.. _features:`

			`==============================================================================`
			`libinput Features`
			`==============================================================================`

			`Below is a list of features supported by libinput. The availability of`
treewide: fix typos Signed-off-by: Torstein Husebø <torstein@huseboe.net> 2020-08-27 19:52:34 +02:00			`features usually depends on the device type and a device's capabilities.`
doc/user: more documentation cleanups and fixes Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-31 18:17:48 +10:00			Not all features are user-configurable, some rely on :ref:`device-quirks`
dox: switch to sphinx for the user-visible documentation This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-10 17:32:35 +10:00			`to be useful.`


			`.. toctree::`
			`:maxdepth: 1`

doc/user: rename filenames with underscores to dashes Everything else is, let's be consistent here. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-08-02 09:44:01 +10:00			`button-debouncing.rst`
dox: switch to sphinx for the user-visible documentation This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-10 17:32:35 +10:00			`clickpad-softbuttons.rst`
			`gestures.rst`
			`middle-button-emulation.rst`
			`palm-detection.rst`
doc/user: add documentation for the new thumb detection Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2019-07-10 14:06:07 +10:00			`touchpad-thumb-detection.rst`
dox: switch to sphinx for the user-visible documentation This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-10 17:32:35 +10:00			`scrolling.rst`
			`t440-support.rst`
			`tapping.rst`
touchpad: implement support for three-finger drag Exposed via new configuration option this enables 3 and 4 finger dragging on touchpads. When enabled a 3/4 finger swipe gesture is actually a button down + motion + button up sequence. If tapping is disabled the drag starts immediately, if tapping is enabled the drag starts after the tap timeout/motion so we can distinguish between a tap and a drag. When fingers are released: - if two fingers remain -> keep dragging - if one finger remains -> release drag, switch to pointer motion When 3/4 fingers are set down immediately after releasing all fingers the drag continues, similar to the tap drag lock feature. This drag lock is not currently configurable. This matches the macos behavior for the same feature. Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1042> 2024-09-06 11:38:35 +10:00			`drag-3fg.rst`
dox: switch to sphinx for the user-visible documentation This is a large commit because it's difficult to split this up and we don't care about bisecting here anyway. doxygen is going to produce the API documentation only sphinx is going to produce the prose user (and a bit of developer) documentation. The source split is doc/api and doc/user. Steps performed: - run the doxygen-to-sphinx.sh script to convert all .dox sources to .rst - manually fixed the .rst to render correctly - add a few extra .rst documents to generate the right hierarchy - hook up sphinx-build in meson - add a new @mainpage for doxygen more aimed at developers For the build directory: - sphinx produces /Documentation - doxygen now produces /api/ These need to be manually combined in the wayland-web repo, meson doesn't support subdirectories as output paths within the build dir and the documentation doesn't need to be installed anywhere. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2018-07-10 17:32:35 +10:00			`tablet-support.rst`
			`switches.rst`
			`touchpad-pressure.rst`
			`trackpoints.rst`