1 files changed, 33 insertions, 0 deletions
diff --git a/tools/libinput-debug-events.1 b/tools/libinput-debug-events.1
new file mode 100644
index 0000000..dfc9a45
--- /dev/null
+++ b/tools/libinput-debug-events.1
@@ -0,0 +1,33 @@
+.TH LIBINPUT-DEBUG-EVENTS "1"
+.SH NAME
+libinput-debug-events \- debug helper for libinput
+.SH SYNOPSIS
+.B libinput-debug-events [--help] [--show-keycodes]
+.SH DESCRIPTION
+.PP
+The
+.I libinput-debug-events
+tool creates a libinput context and prints all events from these devices.
+.PP
+This is a debugging tool only, its output may change at any time. Do not
+rely on the output.
+.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
+.TP 8
+.B --show-keycodes
+Key events shown by this tool are partially obfuscated to avoid passwords
+and other sensitive information showing up in the output. Use the
+.B --show-keycodes
+argument to make all keycodes visible.
+.PP
+For all other options, see the output from --help. Options may be added or
+removed at any time.
+.SH NOTES
+.PP
+Events shown by this tool may not correspond to the events seen by a
+different user of libinput. This tool initializes a separate context.