fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-20 05:40:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

tools: add a man page for the touchpad-edge-detector tool

Browse source 
Requires some .gitignore pattern removal too and an autotools fix to actually
dist the man pages.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2020-10-06 09:37:52 +10:00
parent da2eea1dcb
commit f6c0a048c5
4 changed files with 51 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -31,8 +31,6 @@ mkinstalldirs
stamp-h? stamp-h?
# Edit Compile Debug Document Distribute # Edit Compile Debug Document Distribute
*~ *~
*.[0-9]
*.[0-9]x
*.bak *.bak
*.bin *.bin
core core

3
meson.build
View file

@ -123,7 +123,8 @@ executable('libevdev-tweak-device',
include_directories: [includes_include], include_directories: [includes_include],
dependencies: dep_libevdev, dependencies: dep_libevdev,
install: true) install: true)
install_man('tools/libevdev-tweak-device.1') install_man('tools/libevdev-tweak-device.1',
'tools/touchpad-edge-detector.1')
# tests # tests
dep_check = dependency('check', version: '>= 0.9.9', dep_check = dependency('check', version: '>= 0.9.9',

6
tools/Makefile.am
View file

@ -18,4 +18,8 @@ mouse_dpi_tool_LDADD = $(libevdev_ldadd)
libevdev_tweak_device_SOURCES = libevdev-tweak-device.c libevdev_tweak_device_SOURCES = libevdev-tweak-device.c
libevdev_tweak_device_LDADD = $(libevdev_ldadd) libevdev_tweak_device_LDADD = $(libevdev_ldadd)
libevdev_tweak_device_MANS = libevdev-tweak-device.1
dist_man_MANS = \
libevdev-tweak-device.1 \
touchpad-edge-detector.1 \
$(NULL)

44
tools/touchpad-edge-detector.1 Normal file
View file

@ -0,0 +1,44 @@
.TH TOUCHPAD-EDGE-DETECTOR "1"
.SH NAME
touchpad-edge-detector \- print the axis ranges for a touchpad device
.SH SYNOPSIS
.B touchpad-edge-detector [--help] \fIWxH /dev/input/eventX\fR
.SH DESCRIPTION
.PP
The
.B touchpad-edge-detector
tool reads touchpad events from the kernel and records the minimum and
maximum coordinates based on user input. This is an interactive tool, the
user must move a finger around the touchpad, attempting to trigger an
event at all edges of the touchpad.
.PP
To terminate the event collection and print a summary, press Ctrl+C. It is
recommended that the tool is run several times to guarantee a reliable
result.
.SH OPTIONS
.TP 8
.I WxH
The width and height of the touchpad in mm. For a touchpad 100mm wide and
75mm high, the argument is thus \fI100x75\fR. This is a required argument.
.TP 8
.I /dev/input/eventX
The event node of the touchpad to read events from. A list of possible event
nodes can be obtained with either one of the following commands: \fBlibinput
record\fR, \fBevemu-record\fR, or \fBevtest\fR. Alternatively the event node
for a device is listed in the \fBHandlers=\fR line \fI/proc/bus/input/devices\fR.
This is a required argument.
.TP 8
.B --help
Print a short help description
.SH NOTES
.PP
On completion, this tool prints a summary of the collected events and a
suggested udev rule. Due to rounding errors it is rare to get an exact match
for the touchpad's dimensions, but any discrepancy of more than 5mm should
be corrected with the suggested udev rule.
.PP
The udev rule should be simplified and submitted as a pull request to the
system repository at \fIhttps://github.com/systemd/systemd\fR. For further
guidance, see the file \fI/usr/lib/udev/hwdb.d/60-evdev.hwdb\fR.
.SH SEE ALSO
udev(7)