Restructured and updated the documentation. Created README

file that replaces the FEATURES and PARAMETER files.

1 files changed, 104 insertions, 0 deletions

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>.