summaryrefslogtreecommitdiff
path: root/tools/libinput-list-devices.man
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2017-06-29 08:40:28 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2017-07-03 11:09:03 +1000
commit5bba2dbb3ffe24c0fd18b8de5b4b88b3160534ad (patch)
treef40f1fce57f681fc0f15f13a4a3e26f8d3c23426 /tools/libinput-list-devices.man
parent24ad0082940c9a023f8f8ae66fcabbc5713f96bf (diff)
downloadlibinput-5bba2dbb3ffe24c0fd18b8de5b4b88b3160534ad.tar.gz
tools: add the libinput version to the man pages
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
Diffstat (limited to 'tools/libinput-list-devices.man')
-rw-r--r--tools/libinput-list-devices.man41
1 files changed, 41 insertions, 0 deletions
diff --git a/tools/libinput-list-devices.man b/tools/libinput-list-devices.man
new file mode 100644
index 00000000..ccb30fff
--- /dev/null
+++ b/tools/libinput-list-devices.man
@@ -0,0 +1,41 @@
+.TH libinput-list-devices "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual"
+.SH NAME
+libinput\-list\-devices \- list local devices as recognized by libinput
+.SH SYNOPSIS
+.B libinput list\-devices [\-\-help]
+.SH DESCRIPTION
+.PP
+The
+.B "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
+.B "libinput list\-devices"
+tool only shows the device's default configuration, not the current
+configuration.
+.SH LIBINPUT
+Part of the
+.B libinput(1)
+suite