Start cleaning up the documentation

Many of the files contain redundant information. The plan is to remove most of
the (maybe even all) and add the content to the man page.

1 files changed, 130 insertions, 118 deletions

diff --git a/man/synaptics.man b/man/synaptics.man
index 6e99bd0..9b733f3 100644
--- a/man/synaptics.man
+++ b/man/synaptics.man
@@ -1,16 +1,25 @@
-.TH "synaptics" "5" "0.14.6" "" ""
-.SH "NAME"
-.LP
-synaptics - Synaptics touchpad driver for XOrg/XFree86.
-.SH "INTRODUCTION"
-.LP
-This is a driver for the Synaptics TouchPad for XOrg/XFree86 4.x.
-.
-A Synaptics touchpad by default operates in compatibility mode by
-emulating a standard mouse.
-.
-However, by using a dedicated driver, more advanced features of the
-touchpad becomes available, such as:
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH SYNAPTICS __drivermansuffix__ __vendorversion__
+.SH NAME
+synaptics \- Synaptics touchpad input driver
+.SH SYNOPSIS
+.nf
+.B "Section \*qInputDevice\*q"
+.BI "  Identifier \*q" devname \*q
+.B  "  Driver \*qsynaptics\*q"
+.BI "  Option \*qDevice\*q   \*q" devpath \*q
+.BI "  Option \*qProtocol\*q \*q" auto-dev \*q
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B synaptics
+is an __xservername__ input driver for the touchpads from Synaptics
+Incorporated. Even tough these touchpads (by default, operating in a
+compatibility mode emulating a standard mouse) can be handled by the normal
+evdev or mouse drivers, this driver allows more advanced features of the
+touchpad to become available. Some benefits would be:
 .IP \(bu 4
 Movement with adjustable, non-linear acceleration and speed.
 .IP \(bu 4
@@ -54,180 +63,183 @@ 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.)
-.SH "DESCRIPTION"
-.LP
-The driver behavior can be configured with parameters.
-.
-These parameters are options in the InputDevice section in the
-XOrg/XFree86 config file.
-.
-See the INSTALL file for a working example for a synaptics touchpad.
-.
-See the README.alps file for a working example for an ALPS touchpad.
+.PP
+.SH CONFIGURATION DETAILS
+Please refer to __xconfigfile__(__filemansuffix__) for general configuration
+details and for options that can be used with all input drivers.  This
+section only covers configuration details specific to this driver.
 .
 If you have the SHMConfig parameter enabled, these parameters can also
 be changed at runtime with the synclient(1) program.
-.
-The following parameters are available:
-.TP
-\fBDevice\fR (String)
-Synaptics device.
-.TP
-\fBProtocol\fR (String)
+.PP
+The following driver
+.B Options
+are supported:
+.TP 7
+.BI "Option \*qDevice\*q \*q" string \*q
+This option specifies the device file in your \*q/dev\*q directory which will
+be used to access the physical device. Normally you should use something like
+\*q/dev/input/eventX\*q, where X is some integer.
+.TP 7
+.BI "Option \*qProtocol\*q \*q" string \*q
+Specifies which kernel driver will be used by this driver. This is the list of
+supported drivers and their default use scenarios.
 .TS
 l l.
-auto-dev	automatic, default
-psaux	raw
-event	linux 2.6 kernel events
+auto-dev	automatic, default (recommend)
+event	Linux 2.6 kernel events
+psaux	raw device access (Linux 2.4)
 psm	FreeBSD psm driver
 .TE
-.TP
-\fBSHMConfig\fR (Bool)
-Switch on/off shared memory for configuration.
-.TP
-\fBLeftEdge\fR (Integer)
+.TP 7
+.BI "Option \*qSHMConfig\*q \*q" boolean \*q
+Switch on/off shared memory for configuration. This enables the driver to be
+configured at runtime. Note that this is considered a security risk since any
+user can access the configuration.
+.TP 7
+.BI "Option \*qLeftEdge\*q \*q" integer \*q
 X coordinate for left edge.
-.TP
-\fBRightEdge\fR (Integer)
+.TP 7
+.BI "Option \*qRightEdge\*q \*q" integer \*q
 X coordinate for right edge.
-.TP
-\fBTopEdge\fR (Integer)
+.TP 7
+.BI "Option \*qTopEdge\*q \*q" integer \*q
 Y coordinate for top edge.
-.TP
-\fBBottomEdge\fR (Integer)
+.TP 7
+.BI "Option \*qBottomEdge\*q \*q" integer \*q
 Y coordinate for bottom edge.
-.TP
-\fBFingerLow\fR (Integer)
+.TP 7
+.BI "Option \*qFingerLow\*q \*q" integer \*q
 When finger pressure drops below this value, the driver counts it as a
 release.
-.TP
-\fBFingerHigh\fR (Integer)
+.TP 7
+.BI "Option \*qFingerHigh\*q \*q" integer \*q
 When finger pressure goes above this value, the driver counts it as a
 touch.
-.TP
-\fBFingerPress\fR (Integer)
+.TP 7
+.BI "Option \*qFingerPress\*q \*q" integer \*q
 When finger pressure goes above this value, the driver counts it as a
 press.
 .
 Currently a press is equivalent to putting the touchpad in trackstick
 emulation mode.
-.TP
-\fBMaxTapTime\fR (Integer)
+.TP 7
+.BI "Option \*qMaxTapTime\*q \*q" integer \*q
 Maximum time (in milliseconds) for detecting a tap.
-.TP
-\fBMaxTapMove\fR (Integer)
+.TP 7
+.BI "Option \*qBMaxTapMove\*q \*q" integer \*q
 Maximum movement of the finger for detecting a tap.
-.TP
-\fBMaxDoubleTapTime\fR (Integer)
+.TP 7
+.BI "Option \*qMaxDoubleTapTime\*q \*q" integer \*q
 Maximum time (in milliseconds) for detecting a double tap.
-.TP
-\fBClickTime\fR (Integer)
+.TP 7
+.BI "Option \*qClickTime\*q \*q" integer \*q
 The duration of the mouse click generated by tapping.
-.TP
-\fBFastTaps\fR (Bool)
+.TP 7
+.BI "Option \*qFastTaps\*q \*q" boolean \*q
 Makes the driver react faster to a single tap, but also makes double
 clicks caused by double tapping slower.
-.TP
-\fBVertEdgeScroll\fR (Bool)
+.TP 7
+.BI "Option \*qVertEdgeScroll\*q \*q" boolean \*q
 Enable vertical scrolling when dragging along the right edge.
-.TP
-\fBHorizEdgeScroll\fR (Bool)
+.TP 7
+.BI "Option \*qHorizEdgeScroll\*q \*q" boolean \*q
 Enable horizontal scrolling when dragging along the bottom edge.
-.TP
-\fBCornerCoasting\fR (Bool)
+.TP 7
+.BI "Option \*qCornerCoasting\*q \*q" boolean \*q
 Enable edge scrolling to continue while the finger stays in an edge corner.
-.TP
-\fBVertTwoFingerScroll\fR (Bool)
+.TP 7
+.BI "Option \*qVertTwoFingerScroll\*q \*q" boolean \*q
 Enable vertical scrolling when dragging with two fingers anywhere on
 the touchpad.
-.TP
-\fBHorizTwoFingerScroll\fR (Bool)
+.TP 7
+.BI "Option \*qHorizTwoFingerScroll\*q \*q" boolean \*q
 Enable horizontal scrolling when dragging with two fingers anywhere on
 the touchpad.
-.TP
-\fBVertScrollDelta\fR (Integer)
+.TP 7
+.BI "Option \*qVertScrollDelta\*q \*q" integer \*q
 Move distance of the finger for a scroll event.
-.TP
-\fBHorizScrollDelta\fR (Integer)
+.TP 7
+.BI "Option \*qHorizScrollDelta\*q \*q" integer \*q
 Move distance of the finger for a scroll event.
-.TP
-\fBEdgeMotionMinZ\fR (Integer)
+.TP 7
+.BI "Option \*qEdgeMotionMinZ\*q \*q" integer \*q
 Finger pressure at which minimum edge motion speed is set.
 .TP
-\fBEdgeMotionMaxZ\fR (Integer)
+.BI "Option \*qEdgeMotionMaxZ\*q \*q" integer \*q
 Finger pressure at which maximum edge motion speed is set.
 .TP
-\fBEdgeMotionMinSpeed\fR (Integer)
+.BI "Option \*qEdgeMotionMinSpeed\*q \*q" integer \*q
 Slowest setting for edge motion speed.
 .TP
-\fBEdgeMotionMaxSpeed\fR (Integer)
+.BI "Option \*qEdgeMotionMaxSpeed\*q \*q" integer \*q
 Fastest setting for edge motion speed.
 .TP
-\fBEdgeMotionUseAlways\fR (Bool)
+.BI "Option \*qEdgeMotionUseAlways\*q \*q" boolean \*q
 If on, edge motion is also used for normal movements.
 .
 If off, egde motion is used only when dragging.
 .TP
-\fBRepeater\fR (String)
+.BI "Option \*qRepeater\*q \*q" string \*q
 Repeater device.
 .TP
-\fBMinSpeed\fR (Float)
+.BI "Option \*qMinSpeed\*q \*q" float \*q
 Minimum speed factor.
 .TP
-\fBMaxSpeed\fR (Float)
+.BI "Option \*qMaxSpeed\fR (\*q \*q" float \*q)
 Maximum speed factor.
 .TP
-\fBAccelFactor\fR (Float)
+.BI "Option \*qAccelFactor\fR (\*q \*q" float \*q)
 Acceleration factor for normal pointer movements.
 .TP
-\fBTrackstickSpeed\fR (Float)
+.BI "Option \*qTrackstickSpeed\fR (\*q \*q" float \*q)
 Speed scale when in trackstick emulation mode.
 .TP
-\fBPressureMotionMinZ\fR (Integer)
+.BI "Option \*qPressureMotionMinZ\*q \*q" integer \*q
 Finger pressure at which minimum pressure motion factor is applied.
 .TP
-\fBPressureMotionMaxZ\fR (Integer)
+.BI "Option \*qPressureMotionMaxZ\*q \*q" integer \*q
 Finger pressure at which maximum pressure motion factor is applied.
 .TP
-\fBPressureMotionMinFactor\fR (Integer)
+.BI "Option \*qPressureMotionMinFactor\*q \*q" integer \*q
 Lowest setting for pressure motion factor.
 .TP
-\fBPressureMotionMaxFactor\fR (Integer)
+.BI "Option \*qPressureMotionMaxFactor\*q \*q" integer \*q
 Greatest setting for pressure motion factor.
 .TP
-\fBUpDownScrolling\fR (Bool)
+.BI "Option \*qUpDownScrolling\*q \*q" boolean \*q
 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.
 .TP
-\fBLeftRightScrolling\fR (Bool)
+.BI "Option \*qLeftRightScrolling\*q \*q" boolean \*q
 If on, the left/right buttons generate button 6/7 events.
 .
 If off, the left/right buttons both generate button 2 events.
 .TP
-\fBUpDownScrollRepeat\fR (Bool)
+.BI "Option \*qUpDownScrollRepeat\*q \*q" boolean \*q
 If on, and the up/down buttons are used for scrolling
 (\fBUpDownScrolling\fR), these buttons will send auto-repeating 4/5 events,
 with the delay between repeats determined by \fBScrollButtonRepeat\fR.
 .TP
-\fBLeftRightScrollRepeat\fR (Bool)
+.BI "Option \*qLeftRightScrollRepeat\*q \*q" boolean \*q
 If on, and the left/right buttons are used for scrolling
 (\fBLeftRightScrolling\fR), these buttons will send auto-repeating 6/7 events,
 with the delay between repeats determined by \fBScrollButtonRepeat\fR.
 .TP
-\fBScrollButtonRepeat\fR (Integer)
+.BI "Option \*qScrollButtonRepeat\*q \*q" integer \*q
 The number of milliseconds between repeats of button events 4-7 from the
 up/down/left/right scroll buttons.
 .TP
-\fBEmulateMidButtonTime\fR (Integer)
+.BI "Option \*qEmulateMidButtonTime\*q \*q" integer \*q
 Maximum time (in milliseconds) for middle button emulation.
 .TP
-\fBEmulateTwoFingerMinZ\fR (Integer)
+.BI "Option \*qEmulateTwoFingerMinZ\*q \*q" integer \*q
 For touchpads not capable of detecting multiple fingers (Alps), this sets the
 Z pressure threshold to emulate a two finger press.
 .TP
-\fBTouchpadOff\fR (Integer)
+.BI "Option \*qTouchpadOff\*q \*q" integer \*q
 Switch off the touchpad.
 .
 Valid values are:
@@ -238,63 +250,63 @@ l l.
 2	Only tapping and scrolling is switched off
 .TE
 .TP
-\fBGuestMouseOff\fR (Bool)
+.BI "Option \*qGuestMouseOff\*q \*q" boolean \*q
 Switch on/off guest mouse (often a stick).
 .TP
-\fBLockedDrags\fR (Bool)
+.BI "Option \*qLockedDrags\*q \*q" boolean \*q
 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, or until
 LockedDragTimeout expires.
 .TP
-\fBLockedDragTimeout\fR (Integer)
+.BI "Option \*qLockedDragTimeout\*q \*q" integer \*q
 This parameter specifies how long it takes (in milliseconds) for the
 LockedDrags mode to be automatically turned off after the finger is
 released from the touchpad.
 .TP
-\fBRTCornerButton\fR (Integer)
+.BI "Option \*qRTCornerButton\*q \*q" integer \*q
 .
 Which mouse button is reported on a right top corner tap.
 .
 Set to 0 to disable.
 .TP
-\fBRBCornerButton\fR (Integer)
+.BI "Option \*qRBCornerButton\*q \*q" integer \*q
 Which mouse button is reported on a right bottom corner tap.
 .
 Set to 0 to disable.
 .TP
-\fBLTCornerButton\fR (Integer)
+.BI "Option \*qLTCornerButton\*q \*q" integer \*q
 Which mouse button is reported on a left top corner tap.
 .
 Set to 0 to disable.
 .TP
-\fBLBCornerButton\fR (Integer)
+.BI "Option \*qLBCornerButton\*q \*q" integer \*q
 Which mouse button is reported on a left bottom corner tap.
 .
 Set to 0 to disable.
 .TP
-\fBTapButton1\fR (Integer)
+.BI "Option \*qTapButton1\*q \*q" integer \*q
 Which mouse button is reported on a non-corner one-finger tap.
 .
 Set to 0 to disable.
 .TP
-\fBTapButton2\fR (Integer)
+.BI "Option \*qTapButton2\*q \*q" integer \*q
 Which mouse button is reported on a non-corner two-finger tap.
 .
 Set to 0 to disable.
 .TP
-\fBTapButton3\fR (Integer)
+.BI "Option \*qTapButton3\*q \*q" integer \*q
 Which mouse button is reported on a non-corner three-finger tap.
 .
 Set to 0 to disable.
 .TP
-\fBCircularScrolling\fR (Bool)
+.BI "Option \*qCircularScrolling\*q \*q" boolean \*q
 If on, circular scrolling is used.
 .TP
-\fBCircScrollDelta\fR (Float)
+.BI "Option \*qCircScrollDelta\fR (\*q \*q" float \*q)
 Move angle (radians) of finger to generate a scroll event.
 .TP
-\fBCircScrollTrigger\fR (Integer)
+.BI "Option \*qCircScrollTrigger\*q \*q" integer \*q
 Trigger region on the touchpad to start circular scrolling
 .TS
 l l.
@@ -309,34 +321,34 @@ l l.
 8	Top Left Corner
 .TE
 .TP
-\fBCircularPad\fR (Bool)
+.BI "Option \*qCircularPad\*q \*q" boolean \*q
 .
 Instead of being a rectangle, the edge is the ellipse enclosed by the
 Left/Right/Top/BottomEdge parameters.
 .
 For circular touchpads.
 .TP
-\fBPalmDetect\fR (Bool)
+.BI "Option \*qPalmDetect\*q \*q" boolean \*q
 If palm detection should be enabled.
 .
 Note that this also requires hardware/firmware support from the
 touchpad.
 .TP
-\fBPalmMinWidth\fR (Integer)
+.BI "Option \*qPalmMinWidth\*q \*q" integer \*q
 Minimum finger width at which touch is considered a palm.
 .TP
-\fBPalmMinZ\fR (Integer)
+.BI "Option \*qPalmMinZ\*q \*q" integer \*q
 Minimum finger pressure at which touch is considered a palm.
 .TP
-\fBCoastingSpeed\fR (Float)
+.BI "Option \*qCoastingSpeed\fR (\*q \*q" float \*q)
 Coasting threshold scrolling speed.
 .
 0 disables coasting.
 .TP
-\fBSingleTapTimeout\fR (Integer)
+.BI "Option \*qSingleTapTimeout\*q \*q" integer \*q
 Timeout after a tap to recognize it as a single tap.
 .TP
-\fBGrabEventDevice\fR (Bool)
+.BI "Option \*qGrabEventDevice\*q \*q" boolean \*q
 If GrabEventDevice is true, the driver will grab the event device for
 exclusive use when using the linux 2.6 event protocol.
 .
@@ -584,4 +596,4 @@ from the initial position.
 Peter Osterlund <petero2@telia.com> and many others.
 .SH "SEE ALSO"
 .LP
-synclient(1), syndaemon(1)
+__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__), synclient(1), syndaemon(1)