summaryrefslogtreecommitdiff
path: root/tools/libinput-record.man
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2019-11-26 10:07:51 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2019-11-27 10:34:18 +1000
commiteb16ce2520b687a309a2236b64f72e45ebbf060a (patch)
tree6f8cebb1f40d66446b434f295b72f17402e4d6ea /tools/libinput-record.man
parent5a275ef171e2510f73e247675abf03f031737b18 (diff)
downloadlibinput-eb16ce2520b687a309a2236b64f72e45ebbf060a.tar.gz
tools: libinput-record: drop the explicit --multiple argument
If we want to record multiple events, let's just specify multiple event nodes. No need for a specific extra argument here. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'tools/libinput-record.man')
-rw-r--r--tools/libinput-record.man33
1 files changed, 12 insertions, 21 deletions
diff --git a/tools/libinput-record.man b/tools/libinput-record.man
index bed3d16f..17cf5d3e 100644
--- a/tools/libinput-record.man
+++ b/tools/libinput-record.man
@@ -2,7 +2,7 @@
.SH NAME
libinput\-record \- record kernel events
.SH SYNOPSIS
-.B libinput record [options] [\fI/dev/input/event0\fB]
+.B libinput record [options] [\fI/dev/input/event0\fB [\fI/dev/input/event1\fB ...]]
.SH DESCRIPTION
.PP
The \fBlibinput record\fR tool records kernel events from a device and
@@ -15,9 +15,9 @@ By default it prints to stdout unless the \fB-o\fR option is given.
The events recorded are independent of libinput itself, updating or
removing libinput will not change the event stream.
.SH OPTIONS
-If a device node is given, this tool opens that device node. Otherwise,
-a list of devices is presented and the user can select the device to record.
-If unsure, run without any arguments.
+If one or more device nodes are given, this tool opens those device nodes.
+Otherwise, a list of devices is presented and the user can select the device
+to record. If unsure, run without any arguments.
.TP 8
.B \-\-help
Print help
@@ -25,10 +25,9 @@ Print help
.B \-\-all
Record all \fI/dev/input/event*\fR devices available on the system. This
option should be used in exceptional cases only, the output file is almost
-always too noisy and replaying the recording may not be possible. Use
-\fB\-\-multiple\fR instead.
-This option requires that a \fB\-\-output-file\fR is specified and may not
-be used together with \fB\-\-multiple\fR.
+always too noisy and replaying the recording may not be possible.
+This option requires \fB\-\-output-file\fR and no device
+nodes may be provided on the commandline.
.TP 8
.B \-\-autorestart=s
Terminate the current recording after
@@ -43,15 +42,8 @@ greater than 0.
.TP 8
.B \-\-output-file=filename.yml
.PD 1
-Specifies the output file to use. If \fB\-\-autorestart\fR or
-\fB\-\-multiple\fR is given, the filename is used as prefix only.
-.TP 8
-.B \-\-multiple
-Record multiple devices at once, see section
-.B RECORDING MULTIPLE DEVICES
-This option requires that a
-\fB\-\-output-file\fR is specified and that all devices to be recorded are
-given on the commandline.
+Specifies the output file to use. If \fB\-\-autorestart\fR is given,
+the filename is used as prefix only.
.TP 8
.B \-\-show\-keycodes
Show keycodes as-is in the recording. By default, common keys are obfuscated
@@ -67,16 +59,15 @@ for more details.
.SH RECORDING MULTIPLE DEVICES
Sometimes it is necessary to record the events from multiple devices
simultaneously, e.g. when an interaction between a touchpad and a keyboard
-causes a bug. The \fB\-\-multiple\fR option records multiple devices with
+causes a bug. \fBlibinput record\fR records multiple devices with
an identical time offset, allowing for correct replay of the interaction.
.PP
-The \fB\-\-multiple\fR option requires that an output filename is given.
-This filename is used as prefix, with the event node number appended.
+If multiple devices are recorded, an output filename must be provided.
.PP
All devices to be recorded must be provided on the commandline, an example
invocation is:
-.B libinput record \-\-multiple \-o tap-bug /dev/input/event3 /dev/input/event7
+.B libinput record \-o tap-bug /dev/input/event3 /dev/input/event7
Note that when recording multiple devices, only the first device is printed
immediately, all other devices and their events are printed on exit.