summaryrefslogtreecommitdiff
path: root/tools/libinput-list-devices.1
diff options
context:
space:
mode:
Diffstat (limited to 'tools/libinput-list-devices.1')
-rw-r--r--tools/libinput-list-devices.137
1 files changed, 37 insertions, 0 deletions
diff --git a/tools/libinput-list-devices.1 b/tools/libinput-list-devices.1
new file mode 100644
index 0000000..99a66b5
--- /dev/null
+++ b/tools/libinput-list-devices.1
@@ -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 recognized 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.