tools: update man page for debug-events --show-keycodes flag
authorPeter Hutterer <peter.hutterer@who-t.net>
Thu, 20 Apr 2017 01:04:44 +0000 (11:04 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Thu, 20 Apr 2017 03:52:31 +0000 (13:52 +1000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
tools/libinput-debug-events.man

index bb39399..dfc9a45 100644 (file)
@@ -2,7 +2,7 @@
 .SH NAME
 libinput-debug-events \- debug helper for libinput
 .SH SYNOPSIS
-.B libinput-debug-events [--help]
+.B libinput-debug-events [--help] [--show-keycodes]
 .SH DESCRIPTION
 .PP
 The
@@ -18,6 +18,12 @@ This tool usually needs to be run as root to have access to the
 .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.
@@ -25,7 +31,3 @@ removed at any time.
 .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.
-.PP
-Events shown by this tool include key codes in plain text. Anything you type
-while this tool is running will show up in the output, including your
-passwords.