From: Stephen Kitt <steve@sk2.org>
Date: Sun, 14 Nov 2021 17:28:26 +0000 (+0100)
Subject: Add a manpage for mouse-dpi-tool
X-Git-Tag: accepted/tizen/unified/20231121.102917~38
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=443bcd6d3fef111d4be109f0e5c2b5b6060a61b4;p=platform%2Fupstream%2Flibevdev.git

Add a manpage for mouse-dpi-tool

Signed-off-by: Stephen Kitt <steve@sk2.org>
---

diff --git a/tools/Makefile.am b/tools/Makefile.am
index 65cf4cd..6f08e3d 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -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
index 0000000..1629e0e
--- /dev/null
+++ b/tools/mouse-dpi-tool.1
@@ -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.