summaryrefslogtreecommitdiff
path: root/tools/libinput-list-devices.man
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2015-04-15 11:44:54 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2015-04-16 07:38:40 +1000
commitc74d07bee936d41ab887ad651f58ddaae8bc9da6 (patch)
tree3699d7943a7e9d4fd55e827cfdf9ce412b2382ac /tools/libinput-list-devices.man
parent120199514b9deeb540c59b5604cd5f9c5d0c124b (diff)
downloadlibinput-c74d07bee936d41ab887ad651f58ddaae8bc9da6.tar.gz
tools: add a tool to list local devices and the default configurations
xinput or an equivalent isn't available under wayland, but the majority of use-cases of "why doesn't my device work" or "why does feature X not work" should be covered by simply listing the local devices and their config options. Example output: Device: SynPS/2 Synaptics TouchPad Kernel: /dev/input/event4 Group: 9 Seat: seat0, default Size: 97.33x62.40mm Capabilities: pointer Tap-to-click: disabled Left-handed: disabled Nat.scrolling: disabled Calibration: n/a Scroll methods: *two-finger Click methods: *button-areas clickfinger Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Diffstat (limited to 'tools/libinput-list-devices.man')
-rw-r--r--tools/libinput-list-devices.man37
1 files changed, 37 insertions, 0 deletions
diff --git a/tools/libinput-list-devices.man b/tools/libinput-list-devices.man
new file mode 100644
index 00000000..afa90905
--- /dev/null
+++ b/tools/libinput-list-devices.man
@@ -0,0 +1,37 @@
+.TH LIBINPUT-LIST_DEVICES "1"
+.SH NAME
+libinput-list-devices \- list local devices as recognized by libinput
+.SH SYNOPSIS
+.B libinput-list-devices [--help]
+.SH DESCRIPTION
+.PP
+The
+.I libinput-list-devices
+tool creates a libinput context on the default seat "seat0" and lists all
+devices regonized by libinput. Each device shows available configurations
+the respective default configuration setting.
+.PP
+For configuration options that allow multiple different settings (e.g.
+scrolling), all available settings are listed. The default setting is
+prefixed by an asterisk (*).
+.PP
+This tool usually needs to be run as root to have access to the
+/dev/input/eventX nodes.
+.SH OPTIONS
+.TP 8
+.B --help
+Print help
+.SH NOTES
+.PP
+Some specific feature may still be available on a device even when
+no configuration is exposed, a lack of a configuration option does not
+necessarily mean that this feature does not work.
+.PP
+A device may be recognized by libinput but not handled by the X.Org libinput
+driver or the Wayland compositor.
+.PP
+An xorg.conf(5) configuration entry or Wayland compositor setting may have
+changed configurations on a device. The
+.I libinput-list-devices
+tool only shows the device's default configuration, not the current
+configuration.