Initial release of the vmmouse driver for VMware virtual machines.

1 files changed, 228 insertions, 0 deletions

diff --git a/man/vmmouse.man b/man/vmmouse.man
new file mode 100644
index 0000000..6dcf0f0
--- /dev/null
+++ b/man/vmmouse.man
@@ -0,0 +1,228 @@
+.\" $XFree86: xc/programs/Xserver/hw/xfree86/input/mouse/mouse.man,v 1.5 2002/12/17 20:55:21 dawes Exp $ 
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH MOUSE __drivermansuffix__ __vendorversion__
+.SH NAME
+mouse \- Mouse input driver
+.SH SYNOPSIS
+.nf
+.B "Section \*qInputDevice\*q"
+.BI "  Identifier \*q" idevname \*q
+.B  "  Driver \*qmouse\*q"
+.BI "  Option \*qProtocol\*q \*q" protoname \*q
+.BI "  Option \*qDevice\*q   \*q" devpath \*q
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B mouse 
+is an XFree86 input driver for mice.  The driver supports most available
+mouse types and interfaces.  USB mice are only supported on some OSs,
+and the level of support for PS/2 mice depends on the OS.
+.PP
+The
+.B mouse
+driver functions as a pointer input device, and may be used as the
+X server's core pointer.  Multiple mice are supported by multiple
+instances of this driver.
+.SH SUPPORTED HARDWARE
+There is a detailed list of hardware that the
+.B mouse
+driver supports in the
+.I README.mouse
+document.  This can be found
+in __projectroot__/lib/X11/doc/, or online at
+http://www.xfree86.org/current/mouse.html.
+.SH CONFIGURATION DETAILS
+Please refer to XF86Config(__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.
+.PP
+The driver can auto-detect the mouse type on some platforms  On some
+platforms this is limited to plug and play serial mice, and on some the
+auto-detection works for any mouse that the OS's kernel driver supports.
+On others, it is always necessary to specify the mouse protocol in the
+config file.  The
+.I README.mouse
+document contains some detailed information about this.
+.PP
+The following driver
+.B Options
+are supported:
+.TP 7
+.BI "Option \*qProtocol\*q \*q" string \*q
+Specify the mouse protocol.  Valid protocol types include:
+.PP
+.RS 12
+Auto, Microsoft, MouseSystems, MMSeries, Logitech, MouseMan, MMHitTab,
+GlidePoint, IntelliMouse, ThinkingMouse, AceCad, PS/2, ImPS/2,
+ExplorerPS/2, ThinkingMousePS/2, MouseManPlusPS/2, GlidePointPS/2,
+NetMousePS/2, NetScrollPS/2, BusMouse, SysMouse, WSMouse, USB, Xqueue.
+.RE
+.PP
+.RS 7
+Not all protocols are supported on all platforms.  The "Auto" platform
+specifies that protocol auto-detection should be attempted.  There is no
+default protocol setting, and specifying this option is mandatory.
+.RE
+.TP 7
+.BI "Option \*qDevice\*q \*q" string \*q
+Specifies the device through which the mouse can be accessed.  A common
+setting is "/dev/mouse", which is often a symbolic link to the real
+device.  This option is mandatory, and there is no default setting.
+.TP 7
+.BI "Option \*qButtons\*q \*q" integer \*q
+Specifies the number of mouse buttons.  In cases where the number of buttons
+cannot be auto-detected, the default value is 3.
+.TP 7
+.BI "Option \*qEmulate3Buttons\*q \*q" boolean \*q
+Enable/disable the emulation of the third (middle) mouse button for mice
+which only have two physical buttons.  The third button is emulated by
+pressing both buttons simultaneously.  Default: off
+.TP 7
+.BI "Option \*qEmulate3Timeout\*q \*q" integer \*q
+Sets the timeout (in milliseconds) that the driver waits before deciding
+if two buttons where pressed "simultaneously" when 3 button emulation is
+enabled.  Default: 50.
+.TP 7
+.BI "Option \*qChordMiddle\*q \*q" boolean \*q
+Enable/disable handling of mice that send left+right events when the middle
+button is used.  Default: off.
+.TP 7
+.BI "Option \*qEmulateWheel\*q \*q" boolean \*q
+Enable/disable "wheel" emulation.  Wheel emulation means emulating button
+press/release events when the mouse is moved while a specific real button
+is pressed.  Wheel button events (typically buttons 4 and 5) are
+usually used for scrolling.  Wheel emulation is useful for getting wheel-like
+behaviour with trackballs.  It can also be useful for mice with 4 or
+more buttons but no wheel.  See the description of the
+.BR EmulateWheelButton ,
+.BR EmulateWheelInertia ,
+.BR XAxisMapping ,
+and
+.B YAxisMapping
+options below.  Default: off.
+.TP 7
+.BI "Option \*qEmulateWheelButton\*q \*q" integer \*q
+Specifies which button must be held down to enable wheel emulation mode.
+While this button is down, X and/or Y pointer movement will generate button
+press/release events as specified for the
+.B XAxisMapping
+and
+.B YAxisMapping
+settings.  Default: 4.
+.TP 7
+.BI "Option \*qEmulateWheelInertia\*q \*q" integer \*q
+Specifies how far (in pixels) the pointer must move to generate button
+press/release events in wheel emulation mode.  Default: 50.
+.TP 7
+.BI "Option \*qXAxisMapping\*q \*q" "N1 N2" \*q
+Specifies which buttons are mapped to motion in the X direction in wheel
+emulation mode.  Button number
+.I N1
+is mapped to the negative X axis motion and button number
+.I N2
+is mapped to the positive X axis motion.  Default: no mapping.
+.TP 7
+.BI "Option \*qYAxisMapping\*q \*q" "N1 N2" \*q
+Specifies which buttons are mapped to motion in the Y direction in wheel
+emulation mode.  Button number
+.I N1
+is mapped to the negative Y axis motion and button number
+.I N2
+is mapped to the positive Y axis motion.  Default: "4 5".
+.TP 7
+.BI "Option \*qZAxisMapping\*q \*qX\*q"
+.TP 7
+.BI "Option \*qZAxisMapping\*q \*qY\*q"
+.TP 7
+.BI "Option \*qZAxisMapping\*q \*q" "N1 N2" \*q
+.TP 7
+.BI "Option \*qZAxisMapping\*q \*q" "N1 N2 N3 N4" \*q
+Set the mapping for the Z axis (wheel) motion to buttons or another axis
+.RB ( X
+or
+.BR Y ).
+Button number
+.I N1
+is mapped to the negative Z axis motion and button number
+.I N2
+is mapped to the positive Z axis motion.  For mice with two wheels,
+four button numbers can be specified, with the negative and positive motion
+of the second wheel mapped respectively to buttons number
+.I N3
+and
+.IR N4 .
+Default: no mapping.
+.TP 7
+.BI "Option \*qFlipXY\*q \*q" boolean \*q
+Enable/disable swapping the X and Y axes.  This transformation is applied
+after the
+.BR InvX ,
+.B InvY
+and
+.BR AngleOffset
+transformations.  Default: off.
+.TP 7
+.BI "Option \*qInvX\*q \*q" boolean \*q
+Invert the X axis.  Default: off.
+.TP 7
+.BI "Option \*qInvY\*q \*q" boolean \*q
+Invert the Y axis.  Default: off.
+.TP 7
+.BI "Option \*qAngleOffset\*q \*q" integer \*q
+Specify a clockwise angular offset (in degrees) to apply to the pointer
+motion.  This transformation is applied before the
+.BR FlipXY ,
+.B InvX
+and
+.B InvY
+transformations.  Default: 0.
+.TP 7
+.BI "Option \*qSampleRate\*q \*q" integer \*q
+Sets the number of motion/button events the mouse sends per second.  Setting
+this is only supported for some mice, including some Logitech mice and
+some PS/2 mice on some platforms.  Default: whatever the mouse is
+already set to.
+.TP 7
+.BI "Option \*qResolution\*q \*q" integer \*q
+Sets the resolution of the device in counts per inch.  Setting this is
+only supported for some mice, including some PS/2 mice on some platforms.
+Default: whatever the mouse is already set to.
+.TP 7
+.BI "Option \*qDragLockButtons\*q \*q" "L1 B2 L3 B4" \*q
+Sets \*qdrag lock buttons\*q that simulate holding a button down, so
+that low dexterity people do not have to hold a buttton down at the
+same time they move a mouse cursor. Button numbers occur in pairs,
+with the lock button number occurring first, followed by the button
+number that is the target of the lock button.
+.TP 7
+.BI "Option \*qDragLockButtons\*q \*q" "M1" \*q
+Sets a \*qmaster drag lock button\*q that acts as a \*qMeta Key\*q
+indicating that the next button pressed is to be 
+\*qdrag locked\*q.
+.TP 7
+.BI "Option \*qClearDTR\*q \*q" boolean \*q
+Enable/disable clearing the DTR line on the serial port used by the mouse.
+Some dual-protocol mice require the DTR line to be cleared to operate
+in the non-default protocol.  This option is for serial mice only.
+Default: off.
+.TP 7
+.BI "Option \*qClearRTS\*q \*q" boolean \*q
+Enable/disable clearing the RTS line on the serial port used by the mouse.
+Some dual-protocol mice require the RTS line to be cleared to operate
+in the non-default protocol.  This option is for serial mice only.
+Default: off.
+.TP 7
+.BI "Option \*qBaudRate\*q \*q" integer \*q
+Set the baud rate to use for communicating with a serial mouse.  This
+option should rarely be required because the default is correct for almost
+all situations.  Valid values include: 300, 1200, 2400, 4800, 9600, 19200.
+Default: 1200.
+.PP
+There are some other options that may be used to control various parameters
+for serial port communication, but they are not documented here because
+the driver sets them correctly for each mouse protocol type.
+.SH "SEE ALSO"
+XFree86(1), XF86Config(__filemansuffix__), xf86config(1), Xserver(1), X(__miscmansuffix__),
+README.mouse.