mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2025-12-20 03:20:05 +01:00
4ef14e14e4
This adds the public API to configure an eraser button on a tablet tool to emulate a normal button. In DEFAULT mode the eraser button will simply do whatever it does by default (i.e. toggle to eraser). In BUTTON mode the eraser button will be converted to a regular tool button event, with libinput handling the underlying proximity event madness. Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1218>
161 lines
5.4 KiB
Groff
161 lines
5.4 KiB
Groff
.TH libinput-debug-events "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual"
|
|
.SH NAME
|
|
libinput\-debug\-events \- debug helper for libinput
|
|
.SH SYNOPSIS
|
|
.B libinput debug\-events \fI[options]\fB
|
|
.PP
|
|
.B libinput debug\-events \fI[options]\fB \-\-udev \fI<seat>\fB
|
|
.PP
|
|
.B libinput debug\-events \fI[options]\fB [\-\-device] \fI/dev/input/event0\fB [\fI/dev/input/event1\fB...]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The
|
|
.B "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 \-\-device \fI/dev/input/event0\fR
|
|
Use the given device(s) with the path backend. The \fB\-\-device\fR argument may be
|
|
omitted.
|
|
.TP 8
|
|
.B \-\-grab
|
|
Exclusively grab all opened devices. This will prevent events from being
|
|
delivered to the host system.
|
|
.TP 8
|
|
.B \-\-help
|
|
Print help
|
|
.TP 8
|
|
.B \-\-quiet
|
|
Only print libinput messages, don't print anything from this tool. This is
|
|
useful in combination with --verbose for internal state debugging.
|
|
.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.
|
|
.TP 8
|
|
.B \-\-udev \fI<seat>\fR
|
|
Use the udev backend to listen for device notifications on the given seat.
|
|
The default behavior is equivalent to \-\-udev "seat0".
|
|
.TP 8
|
|
.B \-\-verbose
|
|
Use verbose output
|
|
.SS libinput configuration options
|
|
.TP 8
|
|
.B \-\-apply-to="pattern"
|
|
Configuration options are only applied where the device name matches the
|
|
pattern. This pattern has no effect on the \fB\-\-disable-sendevents\fR
|
|
option.
|
|
.TP 8
|
|
.B \-\-disable-sendevents="pattern"
|
|
Set the send-events option to disabled for the devices matching patterns.
|
|
This option is not affected by the \fB\-\-apply-to="pattern"\fR option.
|
|
.TP 8
|
|
.B \-\-enable-drag|\-\-disable\-drag
|
|
Enable or disable tap-and-drag
|
|
.TP 8
|
|
.B \-\-enable\-drag\-lock|\-\-disable\-drag\-lock
|
|
Enable (in timeout mode) or disable drag-lock
|
|
.B \-\-enable\-drag\-lock=[sticky|timeout]
|
|
Enable drag-lock in sticky or timeout mode
|
|
.TP 8
|
|
.B \-\-enable\-dwt|\-\-disable\-dwt
|
|
Enable or disable disable-while-typing
|
|
.TP 8
|
|
.B \-\-enable\-dwtp|\-\-disable\-dwtp
|
|
Enable or disable disable-while-trackpointing
|
|
.TP 8
|
|
.B \-\-enable\-left\-handed|\-\-disable\-left\-handed
|
|
Enable or disable left handed button configuration
|
|
.TP 8
|
|
.B \-\-enable\-middlebutton|\-\-disable\-middlebutton
|
|
Enable or disable middle button emulation
|
|
.TP 8
|
|
.B \-\-enable\-natural\-scrolling|\-\-disable\-natural\-scrolling
|
|
Enable or disable natural scrolling
|
|
.TP 8
|
|
.B \-\-enable\-scroll-button-lock|\-\-disable\-scroll-button-lock
|
|
Enable or disable the scroll button lock
|
|
.TP 8
|
|
.B \-\-enable\-tap|\-\-disable\-tap
|
|
Enable or disable tap-to-click
|
|
.TP 8
|
|
.B \-\-set\-area="x1/y1 x2/y2"
|
|
Set the tablet area to the rectangle described by the two points x1/y1 and x2/y2. All
|
|
coordinates must be in the range [0.0, 1.0].
|
|
.TP 8
|
|
.B \-\-set\-calibration="1.0 0.0 0.0 0.0 1.0 0.0"
|
|
Set the first 6 elements of a 3x3 matrix to use for calibration. The third row of the
|
|
matrix is always "0.0 0.0 0.1".
|
|
.TP 8
|
|
.B \-\-set\-click\-method=[none|clickfinger|buttonareas]
|
|
Set the desired click method
|
|
.TP 8
|
|
.B \-\-set\-clickfinger\-map=[lrm|lmr]
|
|
Set button mapping for clickfinger
|
|
.TP 8
|
|
.B \-\-set\-custom\-points="<value>;...;<value>"
|
|
Sets the n points defining a custom acceleration function
|
|
The points are defined in a semicolon-separated list of floating point
|
|
non-negative numbers. Defaults to "0.0;1.0".
|
|
This only applies to the custom profile.
|
|
.TP 8
|
|
.B \-\-set\-custom\-step=<value>
|
|
Sets the distance along the x-axis between each point, starting from 0.
|
|
Defaults to 1.0.
|
|
This only applies to the custom profile.
|
|
.TP 8
|
|
.B \-\-set\-custom\-type=[fallback|motion|scroll]
|
|
Sets the type of the custom acceleration function.
|
|
Defaults to fallback.
|
|
This only applies to the custom profile.
|
|
.TP 8
|
|
.B \-\-set\-eraser\-button\-button=[BTN_STYLUS|BTN_STYLUS2|BTN_STYLUS3]
|
|
Sets the eraser button button to the given tablet tool button. Only
|
|
takes effect if combined with
|
|
.B \-\-set\-eraser\-button\-mode=on\-button\-down.
|
|
.TP 8
|
|
.B \-\-set\-eraser\-button\-mode=[default|on-button-down]
|
|
Sets the eraser button mode to the given mode.
|
|
.TP 8
|
|
.B \-\-set\-pressure\-range=<min>:<max>
|
|
Set the tablet tool pressure range to min:max. min and max must be in range [0.0, 1.0].
|
|
.TP 8
|
|
.B \-\-set\-profile=[adaptive|flat|custom]
|
|
Set pointer acceleration profile
|
|
.TP 8
|
|
.B \-\-set\-rotation\-angle=<degrees>
|
|
Set the rotation angle in degrees (0 to 360).
|
|
.TP 8
|
|
.B \-\-set\-scroll\-button=BTN_MIDDLE
|
|
Set the button to the given button code
|
|
.TP 8
|
|
.B \-\-set\-scroll\-method=[none|twofinger|edge|button]
|
|
Set the desired scroll method
|
|
.TP 8
|
|
.B \-\-set\-sendevents=[disabled|enabled|disabled-on-external-mouse]
|
|
Set the given sendevents mode. This option overrides
|
|
\fB\-\-disable-sendevents="pattern"\fR for any devices it matches
|
|
via the \fB\-\-apply-to="pattern"\fR option.
|
|
.TP 8
|
|
.B \-\-set\-speed=<value>
|
|
Set pointer acceleration speed. The allowed range is [-1, 1].
|
|
This only applies to the flat or adaptive profile.
|
|
.TP 8
|
|
.B \-\-set\-tap\-map=[lrm|lmr]
|
|
Set button mapping for tapping
|
|
.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.
|
|
.SH LIBINPUT
|
|
Part of the
|
|
.B libinput(1)
|
|
suite
|