Add a manpage for mouse-dpi-tool
authorStephen Kitt <steve@sk2.org>
Sun, 14 Nov 2021 17:28:26 +0000 (18:28 +0100)
committerJihoon Kim <jihoon48.kim@samsung.com>
Fri, 17 Nov 2023 10:53:12 +0000 (19:53 +0900)
Signed-off-by: Stephen Kitt <steve@sk2.org>
tools/Makefile.am
tools/mouse-dpi-tool.1 [new file with mode: 0644]

index 65cf4cdc893c59cd0c7b0c58be966638ac097e5c..6f08e3db2d848ad9d4ac4d4c0783f4e69ba81404 100644 (file)
@@ -25,5 +25,6 @@ libevdev_tweak_device_LDADD = $(libevdev_ldadd)
 
 dist_man_MANS = \
                libevdev-tweak-device.1 \
+               mouse-dpi-tool.1 \
                touchpad-edge-detector.1 \
                $(NULL)
diff --git a/tools/mouse-dpi-tool.1 b/tools/mouse-dpi-tool.1
new file mode 100644 (file)
index 0000000..1629e0e
--- /dev/null
@@ -0,0 +1,18 @@
+.TH MOUSE-DPI-TOOL "1"
+.SH NAME
+mouse-dpi-tool \- mouse resolution estimation tool
+.SH SYNOPSIS
+.BR mouse-dpi-tool " <\fIevdev device\fP>"
+.SH DESCRIPTION
+.B mouse-dpi-tool
+reads relative events (mouse movement events) and calculates the
+distance covered and maximum frequency of the incoming events.
+Combined with a measurement of the actual distance physically covered,
+this allows the mouse's resolution to be estimated.
+.PP
+Some mouse devices provide dynamic frequencies, it is
+recommended to measure multiple times to obtain the highest value.
+.PP
+.SH OPTIONS
+.B mouse-dpi-tool
+accepts no options.