[PATCH] man: move ClickPad documentation into a single area

Peter Hutterer peter.hutterer at who-t.net
Tue Apr 17 22:30:06 PDT 2012


Having to read only one section is a tad easier than collecting the separate
options.

Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
 man/synaptics.man |   50 ++++++++++++++++++++++++++++++++------------------
 1 file changed, 32 insertions(+), 18 deletions(-)

diff --git a/man/synaptics.man b/man/synaptics.man
index 2cbe50e..7e510d0 100644
--- a/man/synaptics.man
+++ b/man/synaptics.man
@@ -144,10 +144,9 @@ The duration of the mouse click generated by tapping. Property: "Synaptics Tap
 Durations"
 .TP 7
 .BI "Option \*qClickPad\*q \*q" boolean \*q
-Whether the device is a click pad. A click pad device has button(s) integrated
-into the touchpad surface. The user must press downward on the touchpad in order
-to generated a button press. This property may be set automatically if a click
-pad device is detected at initialization time. Property: "Synaptics ClickPad"
+Whether the device is a click pad. See
+.B ClickPad support
+for more details. Property: "Synaptics ClickPad"
 .TP 7
 .BI "Option \*qFastTaps\*q \*q" boolean \*q
 Makes the driver react faster to a single tap, but also makes double
@@ -520,20 +519,15 @@ the total height of the touchpad. Property: "Synaptics Area"
 .
 .TP
 .BI "Option \*qSoftButtonAreas\*q \*q" "RBL RBR RBT RBB MBL MBR MBT MBB" \*q
-This option is only available on ClickPad devices.
-Enable soft button click area support on ClickPad devices. The first four
-parameters define the area of the right button, and the second four parameters
-define the area of the middle button. The areas are defined by the left, right,
-top, and bottom edges as sequential values of the property. If any edge is set
-to 0, the button is assumed to extend to infinity in the given direction.
-Any of the values may be given as percentage of the touchpad width or
-height, whichever applies.
-.
-When the user performs a click within the defined soft button areas, the right
-or middle click action is performed.
-.
-The use of soft button areas is disabled by setting all the values for the area
-to 0. Property: "Synaptics Soft Button Areas"
+This option is only available on ClickPad devices. 
+Enable soft button click area support on ClickPad devices. 
+The first four parameters are the left, right, top, bottom edge of the right
+button, respectively, the second four parameters are the left, right, top,
+bottom edge of the middle button, respectively. Any of the values may be
+given as percentage of the touchpad width or height, whichever applies.
+If any edge is set to 0, the button is assumed to extend to infinity in the
+given direction. Setting all values to 0 disables soft button areas.
+Property: "Synaptics Soft Button Areas"
 .
 
 .SH CONFIGURATION DETAILS
@@ -782,6 +776,26 @@ Trackstick mode is exited when the finger pressure drops below
 FingerLow or when the finger is moved further than MaxTapMove away
 from the initial position.
 
+.SS ClickPad support
+A click pad device has button(s) integrated into the touchpad surface. The
+user must press downward on the touchpad in order to generated a button
+press. ClickPad support is enabled if the option
+.B ClickPad
+is set or the property is set at runtime. On some platforms, this option
+will be set automatically if the kernel detects a matching device. On Linux,
+the device must have the INPUT_PROP_BUTTONPAD property set.
+.LP
+ClickPads do not support middle mouse button emulation. If enabling ClickPad
+support at runime, the user must also set the middle mouse button timeout to
+0. If auto-detected, middle mouse button emulation is disabled by the
+driver.
+.LP
+ClickPads provide software emulated buttons through 
+.B Option SoftButtonAreas.
+These buttons enable areas on the touchpad to perform as right or middle
+mouse button When the user performs a click within a defined soft button
+area, a right or middle click is performed.
+
 .SH "DEVICE PROPERTIES"
 Synaptics 1.0 and higher support input device properties if the driver is
 running on X server 1.6 or higher. On these driver versions, Option
-- 
1.7.10



More information about the xorg-devel mailing list