summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Osterlund <petero2@telia.com>2003-11-14 20:44:58 +0100
committerPeter Osterlund <petero2@telia.com>2006-04-09 04:01:23 +0200
commitc8955366a82e863c74e835f2861eb3aa68e464a1 (patch)
tree9759b678995dbbc54846051aec326bcbf7be3dd1
parent98295fd6ca1f747c2e390692c1bcfd59370b23a3 (diff)
Restructured and updated the documentation. Created README
file that replaces the FEATURES and PARAMETER files.
-rw-r--r--FEATURES24
-rw-r--r--FILES22
-rw-r--r--PARAMETER30
-rw-r--r--README104
-rw-r--r--synaptics.c10
5 files changed, 122 insertions, 68 deletions
diff --git a/FEATURES b/FEATURES
deleted file mode 100644
index a30dd0e..0000000
--- a/FEATURES
+++ /dev/null
@@ -1,24 +0,0 @@
-The touchpad driver has the following functions (some function
-requires features from the touchpad that must be present, multifinger
-taps for example):
-- Movement with adjustable, non-linear acceleration and speed
- (Options: MinSpeed, MaxSpeed, AccelFactor)
-- Button events through short touching of the touchpad (Options:
- MaxTapTime, MaxTapMove)
-- Double-Button events through double short touching of the touchpad
-- Dragging through short touching and holding down the finger on the
- touchpad
-- Middle and right button events on the upper and lower corner of the
- touchpad (Option: Edges)
-- Scrolling (button four and five events) through moving the finger on
- the right side of the touchpad (Options: Edges, VertScrollDelta)
-- The up/down button sends button four/five events
-- The multi-buttons send button four/five events, and six/seven events
- for horizontal scrolling (needs patch for 2.6-kernels, hopefully
- being in 2.6.0-test2)
-- Adjustable finger detection (Option: Finger)
-- Ext Mouse repeater support - Alpha! (Option: Repeater)
-- Multifinger taps: two finger for middle button and three finger for
- right button events
-- Online configuration through shared memory (Option: SHMConfig)
-- Touchpad can be switched off temporarily
diff --git a/FILES b/FILES
index 9a1fd2f..a8db79b 100644
--- a/FILES
+++ b/FILES
@@ -1,9 +1,13 @@
-pc_keyb.c.diff.2.4.3 Patch for the reconnect message handling
-ps2comm.c Synaptics communication routines
-ps2comm.h see above
-synaptics.c Synaptics driver-module for xfree
-synaptics.h see above
-synclient.c Program for testing the shared-memory
- shows the x, y-coordinates of the finger
-script/usbmouse script for shutting the touchpad down if
- an external USB-mouse is attached
+pc_keyb.c.diff.2.4.3 Patch for the reconnect message handling
+ps2comm.c Synaptics communication routines
+ps2comm.h see above
+synaptics.c Synaptics driver-module for xfree
+synaptics.h see above
+synclient.c Program for testing the shared-memory
+ shows the x, y-coordinates of the finger
+script/usbmouse script for shutting the touchpad down if
+ an external USB-mouse is attached
+syndaemon.c A user space program that disables the touchpad
+ when the keyboard is used.
+alps.patch Patch for 2.6 kernels that makes it possible to
+ use the driver with an ALPS GlidePoint device.
diff --git a/PARAMETER b/PARAMETER
deleted file mode 100644
index 06975ea..0000000
--- a/PARAMETER
+++ /dev/null
@@ -1,30 +0,0 @@
-Device String Synaptics device
-Protocol String "auto-dev" (automatic, default), "psaux" (raw) or
- "event" (linux 2.5 kernel events)
-SHMConfig Bool switch on/off shared memory for configuration
-LeftEdge Int coordinates for left edge
-RightEdge Int coordinates for right edge
-TopEdge Int coordinates for top edge
-BottomEdge Int coordinates for bottom edge
-FingerLow Int When finger pressure drops below this value, the
- driver counts it as a release.
-FingerHigh Int When finger pressure goes above this value, the
- driver counts it as a touch.
-MaxTapTime Int max. time (in milliseconds) for detecting a tap
-MaxTapMove Int max. movement of the finger for detecting a tap
-VertScrollDelta Int move distance of the finger for a scroll event
-HorizScrollDelta Int move distance of the finger for a scroll event
-EdgeMotionSpeed Int edge motion speed when dragging
-Repeater String repeater device
-MinSpeed Float min. Speed factor
-MaxSpeed Float max. Speed factor
-AccelFactor Float acceleration factor
-UpDownScrolling Bool If on, the up/down buttons generate button 4/5 events.
- If off, the up button generates a double click and
- the down button generates a button 2 event.
-EmulateMidButtonTime Int max time (in milliseconds) for middle button emulation.
-TouchpadOff Bool If on, the Touchpad is switched off (useful
- if an external mouse is connected)
-LockedDrags Bool If off, a tap and drag gesture ends when you release
- the finger. If on, the gesture is active until you
- tap a second time.
diff --git a/README b/README
new file mode 100644
index 0000000..1fd0279
--- /dev/null
+++ b/README
@@ -0,0 +1,104 @@
+Synaptics TouchPad driver for XFree86
+-------------------------------------
+
+Introduction
+------------
+
+This is a driver for the Synaptics TouchPad for XFree86 4.x. A
+Synaptics touchpad by default operates in compatibility mode by
+emulating a standard mouse. However, by using a dedicated driver, more
+advance features of the touchpad becomes available, such as:
+
+- Movement with adjustable, non-linear acceleration and speed.
+- Button events through short touching of the touchpad.
+- Double-Button events through double short touching of the touchpad.
+- Dragging through short touching and holding down the finger on the
+ touchpad.
+- Middle and right button events on the upper and lower corner of
+ the touchpad.
+- Vertical scrolling (button four and five events) through moving
+ the finger on the right side of the touchpad.
+- The up/down button sends button four/five events.
+- Horizontal scrolling (button six and seven events) through moving
+ the finger on the lower side of the touchpad.
+- The multi-buttons send button four/five events, and six/seven
+ events for horizontal scrolling.
+- Adjustable finger detection.
+- Multifinger taps: two finger for middle button and three finger
+ for right button events. (Needs hardware support. Not all models
+ implement this feature.)
+- Run-time configuration using shared memory. This means you can
+ change parameter settings without restarting the X server.
+
+Note that depending on the touchpad firmware, some of these features
+might be available even without using the synaptics driver. Note also
+that some functions are not available on all touchpad models, because
+they need support from the touchpad hardware/firmware. (Multifinger
+taps for example.)
+
+
+Installation
+------------
+
+See the INSTALL file for detailed installation instructions.
+
+
+Compatibility
+-------------
+
+The driver has been reported to work on a number of different laptop
+computers. See the COMPATIBILITY file for the list. If your computer
+is not listed, please let me (petero2@telia.com) know if the driver
+works on your computer.
+
+
+Parameters
+----------
+
+The driver behavior can be configured with parameters. These
+parameters are options in the InputDevice section in the XFree86
+config file. See the INSTALL file for a working example. If you have
+the SHMConfig parameter enabled, these parameters can also be changed
+at runtime with the synclient program.
+
+Parameter: Type: Description:
+
+Device String Synaptics device
+Protocol String "auto-dev" (automatic, default), "psaux" (raw) or
+ "event" (linux 2.5 kernel events)
+SHMConfig Bool switch on/off shared memory for configuration
+LeftEdge Int coordinates for left edge
+RightEdge Int coordinates for right edge
+TopEdge Int coordinates for top edge
+BottomEdge Int coordinates for bottom edge
+FingerLow Int When finger pressure drops below this value, the
+ driver counts it as a release.
+FingerHigh Int When finger pressure goes above this value, the
+ driver counts it as a touch.
+MaxTapTime Int max. time (in milliseconds) for detecting a tap
+MaxTapMove Int max. movement of the finger for detecting a tap
+VertScrollDelta Int move distance of the finger for a scroll event
+HorizScrollDelta Int move distance of the finger for a scroll event
+EdgeMotionSpeed Int edge motion speed when dragging
+Repeater String repeater device
+MinSpeed Float min. Speed factor
+MaxSpeed Float max. Speed factor
+AccelFactor Float acceleration factor
+UpDownScrolling Bool If on, the up/down buttons generate button 4/5 events.
+ If off, the up button generates a double click and
+ the down button generates a button 2 event.
+EmulateMidButtonTime Int max time (in milliseconds) for middle button emulation.
+TouchpadOff Bool If on, the Touchpad is switched off (useful
+ if an external mouse is connected)
+LockedDrags Bool If off, a tap and drag gesture ends when you release
+ the finger. If on, the gesture is active until you
+ tap a second time.
+
+
+Authors
+-------
+
+Many people have contributed to this driver. Look at the top of
+synaptics.c and ps2comm.c for details.
+
+The current maintainer is Peter Osterlund <petero2@telia.com>.
diff --git a/synaptics.c b/synaptics.c
index c15b0cd..40aac1b 100644
--- a/synaptics.c
+++ b/synaptics.c
@@ -1,19 +1,19 @@
/*
- * 2003 Jörg Bösner <ich@joerg-boesner.de>
+ * Copyright 2003 Jörg Bösner <ich@joerg-boesner.de>
* patch for switching the touchpad off (for example, when a
* USB mouse is connected)
*
- * 2003 Hartwig Felger <hgfelger@hgfelger.de>
+ * Copyright 2003 Hartwig Felger <hgfelger@hgfelger.de>
* patch to make the horizontal wheel replacement buttons work.
*
- * 2002 Peter Osterlund <petero2@telia.com>
+ * Copyright 2002 Peter Osterlund <petero2@telia.com>
* patches for fast scrolling, palm detection, edge motion,
* horizontal scrolling
*
- * 2002 S. Lehner <sam_x@bluemail.ch>
+ * Copyright 2002 S. Lehner <sam_x@bluemail.ch>
* for newer Firmware (5.8) protocol changes for 3rd to 6th button
*
- * Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
+ * Copyright (C) 2001 Stefan Gmeiner <riddlebox@freesurf.ch>
* start merging tpconfig and gpm code to an xfree input module
* adding some changes and extensions (ex. 3rd and 4th button)
*