Import of the manpage of the wsmouse compatible pms and pmsi drivers from NetBSD

pmsi(4) links to pms(4). old pms(4) becomes opms(4). aaron@ ok.

1 files changed, 114 insertions, 0 deletions

diff --git a/share/man/man4/man4.i386/opms.4 b/share/man/man4/man4.i386/opms.4
new file mode 100644
index 00000000000..079efdfde9e
--- /dev/null
+++ b/share/man/man4/man4.i386/opms.4
@@ -0,0 +1,114 @@
+.\"
+.\"	$OpenBSD: opms.4,v 1.1 2001/02/20 21:29:38 jbm Exp $
+.\"
+.\" Copyright (c) 1996, Jason Downs.
+.\" Copyright (c) 1993 Christopher G. Demetriou
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"      This product includes software developed by Christopher G. Demetriou.
+.\" 3. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 10, 1999
+.Dt OPMS 4 i386
+.Os
+.Sh NAME
+.Nm opms
+.Nd
+PS/2 auxiliary port mouse driver
+.Sh SYNOPSIS
+.\" XXX this is awful hackery to get it to work right... -- cgd
+.\".Cd "pms0 at isa? port" \&"IO_KBD\&" irq 12
+.Cd "opms0 at pckbd? irq 12"
+.Sh DESCRIPTION
+This driver provides an interface to a PS/2 auxiliary port mice.  The driver
+offers two modes of operation, both a raw and the old style translated
+input stream.  The translating portion of the driver provides BusMouse
+codes; in raw mode no translations are performed.
+The
+.Nm
+driver provides three
+.Em ioctls
+for getting mouse status and changing modes.  They are defined in the
+following include:
+.Bd -literal -offset indent
+#include <machine/mouse.h>
+.Ed
+
+The
+.Dv MOUSEIOCREAD
+.Em ioctl
+is used to read the current mouse stats, and takes the
+.Dv "struct mouseinfo"
+as an argument to store the data in.
+
+The
+.Dv MOUSEIOCSRAW
+.Em ioctl
+puts the device into raw mode, if it is not already, and the
+.Dv MOUSEIOCSCOOKED
+.Em ioctl
+puts it into translated (or cooked) mode.  If the mode of the
+.Nm
+device driver changes, all pending but not yet read input is flushed.
+.Pp
+In translated mode, the
+.Nm
+driver also supports
+.Dq Intellimouse
+devices, with the wheel acting as a third button.  The kernel must currently
+be compiled with
+.Pp
+.Cd option INTELLIMOUSE
+.Pp
+specified in the config file, and the X server can be configured to use
+the translated mode of the driver.  (The output of the translated mode is
+.Em Busmouse
+compatible.)  Otherwise, the mouse works as a normal, two button, PS/2
+device.
+.Pp
+.Sh NOTES
+The translated mode of this driver is being deprecated. The raw device
+.Pa /dev/psm0
+should be used in
+.Pa /etc/XF86Config
+with the
+.Em PS/2
+protocol, or one of its variants
+.Pf ( Em IMPS/2
+for MS Intellimouse,
+.Em ThinkingMousePS/2
+for Kensington Thinking Mouse).
+.Pp
+.Sh FILES
+.Bl -tag -width /dev/pms0 -compact
+.It Pa /dev/psm0
+PS/2 mouse device file, defaulting to raw mode
+.It Pa /dev/pms0
+PS/2 mouse device file, defaulting to translating mode
+.El
+.Sh SEE ALSO
+.Xr olms 4 ,
+.Xr omms 4 ,
+.Xr XF86Config 4