[src/trunk]: src/share/man/man4 Add documentation for clickpad mouse button e...

[blymn <blymn%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/eb8d12dd78d9
branches:  trunk
changeset: 357348:eb8d12dd78d9
user:      blymn <blymn%NetBSD.org@localhost>
date:      Mon Nov 06 21:11:17 2017 +0000

description:
Add documentation for clickpad mouse button emulation.

diffstat:

 share/man/man4/pms.4 |  23 ++++++++++++++++++++++-
 1 files changed, 22 insertions(+), 1 deletions(-)

diffs (37 lines):

diff -r f1fe3d3a6c15 -r eb8d12dd78d9 share/man/man4/pms.4
--- a/share/man/man4/pms.4      Mon Nov 06 21:07:17 2017 +0000
+++ b/share/man/man4/pms.4      Mon Nov 06 21:11:17 2017 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: pms.4,v 1.28 2017/09/06 17:15:54 wiz Exp $
+.\" $NetBSD: pms.4,v 1.29 2017/11/06 21:11:17 blymn Exp $
 .\"
 .\" Copyright (c) 1993 Christopher G. Demetriou
 .\" All rights reserved.
@@ -153,6 +153,27 @@
 .It Dv hw.synaptics.movement_threshold
 Movements of less than this value (in Synaptics coordinates) are
 ignored (default 4).
+.It Dv hw.synaptics.button_boundary
+Sets the top edge of the button emulation region on a clickpad.
+Since a clickpad only reports left clicks this region is used to emulate
+two or three buttons by detecting the finger location and reporting
+either a button 2 or button 3 click iff the the click occurs within
+the region bounded by button_boundary and the bottom of the clickpad.
+.It Dv hw.synaptics.button3_edge
+This defines the left hand edige of the button 3 region.
+If a click occurs in the region bounded by button_boundary, button3_edge
+the right hand edge of the click pad then the click will be reported
+as a button3 event.  Button 3 emulation can be disabled by setting
+button3_edge to the right hand edge of the clickpad.
+.It Dv hw.synaptics.button2_edge
+This defines the left hand edge of the button 2 region.
+The button 2 region is bounded by button2_edge, button3_edge and
+button_boundary.
+If a click occurs in this region then it will be reported as a button2
+event.
+For completeness, the region between the left hand side of the clickpad,
+button2_edge and button_boundary will be reported as a button1 event
+as will any clicks htat occur outside the button emulation region.
 .El
 .Pp
 The following