Module Name: src
Committed By: blymn
Date: Tue Nov 6 09:14:08 UTC 2018
Modified Files:
src/share/man/man4: pms.4
Log Message:
Update man page to document z-axis emulation.
To generate a diff of this commit:
cvs rdiff -u -r1.31 -r1.32 src/share/man/man4/pms.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/pms.4
diff -u src/share/man/man4/pms.4:1.31 src/share/man/man4/pms.4:1.32
--- src/share/man/man4/pms.4:1.31 Sun Feb 4 18:17:59 2018
+++ src/share/man/man4/pms.4 Tue Nov 6 09:14:08 2018
@@ -1,4 +1,4 @@
-.\" $NetBSD: pms.4,v 1.31 2018/02/04 18:17:59 christos Exp $
+.\" $NetBSD: pms.4,v 1.32 2018/11/06 09:14:08 blymn Exp $
.\"
.\" Copyright (c) 1993 Christopher G. Demetriou
.\" All rights reserved.
@@ -144,12 +144,15 @@ If set to 1, two-finger events generate
If set to 2, two-finger events generate a middle button click.
.It Dv hw.synaptics.scale_x
.It Dv hw.synaptics.scale_y
+.It Dv hw.synaptics.scale_z
Scale factor used to divide movement deltas derived from Synaptics
-coordinates (0-6143) to yield more reasonable values (default 16).
+coordinates (0-6143) to yield more reasonable values (default 16 for x
+and y, 1 for z).
.It Dv hw.synaptics.max_speed_x
.It Dv hw.synaptics.max_speed_y
+.It Dv hw.synaptics.max_speed_z
Limits pointer rate of change (after scaling) per reported movement
-event (default 32).
+event (default 32 for x and y, 2 for z).
.It Dv hw.synaptics.movement_threshold
Movements of less than this value (in Synaptics coordinates) are
ignored (default 4).
@@ -175,6 +178,29 @@ 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 that occur outside the button emulation region.
+.It Dv hw.synaptics.finger_scroll-min
+The minimum finger width at which the driver will start reporting
+vertical movements as Z axis events.
+Effectively, this emulates a mouse scroll wheel by the user using two
+fingers together on the click pad.
+The default value is 5, this value cannot be less than 5 due to the way
+the clickpad reports finger width.
+.It Dv hw.synaptics.finger_scroll-max
+The maximum finger width at which the driver will report finger
+movement as Z axis events.
+The default value is 12 and cannot be greater than 14.
+.It Dv hw.synaptics.finger_scroll-hysteresis
+This defines the number of packets to continue with the Z axis emulation.
+Due to the nature of the clickpad maintaining constant contact can be
+difficult.
+This hysteresis value prevents the driver flipping between two finger
+scroll and normal mouse movement erratically.
+Each time a valid finger scroll width is detected the packet count is
+reset.
+If this variable is set too high then mouse movements will be interpreted
+as Z-axis events after the two finger scoll has finished.
+If the variable is set too low then there will be mouse movements observed
+during the two finger scroll.
.El
.Pp
The following
