share/man/man4/man4.sun2/ms.4

   1 .\"     $NetBSD: ms.4,v 1.2 2008/04/30 13:10:56 martin Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Paul Kranenburg.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd June 22, 1996
  31 .Dt MS 4 sun2
  32 .Os
  33 .Sh NAME
  34 .Nm ms
  35 .Nd Sun workstation mouse driver
  36 .Sh SYNOPSIS
  37 .Cd "ms0 at zstty?"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides an interface to the workstation console mouse.
  42 This
  43 .Tn Mouse Systems
  44 three-button device produces five-byte blobs of the form:
  45 .Pp
  46 .Bd -literal -offset indent
  47 b dx dy dx dy
  48 .Ed
  49 .Pp
  50 where
  51 .Dq b
  52 is the button state, encoded as
  53 .Li 0x80|(~buttons)
  54 -- there are three buttons (4=left, 2=middle, 1=right) --
  55 and
  56 .Dq \&dx
  57 and
  58 .Dq \&dy
  59 are X and Y delta values, none of which are in the range
  60 .Bq Li 0x80..0x87 .
  61 .Pp
  62 The device special file
  63 .Pa /dev/mouse
  64 is used to get direct access to the mouse input stream.
  65 The following
  66 ioctl's are supported (mostly just enough to keep the
  67 .Xr X 1
  68 server going):
  69 .Bl -tag -width VUIDSFORMAT
  70 .It Dv VUIDSFORMAT
  71 Set translation mode.
  72 The argument is of type
  73 .Fa "int *" ,
  74 the only value supported is
  75 .Dv VUID_FIRM_EVENT .
  76 .It Dv VUIDGFORMAT
  77 Get translation mode.
  78 The argument is of type
  79 .Fa "int *" .
  80 .Dv VUID_FIRM_EVENT
  81 is always returned.
  82 .El
  83 .Ss OPTIONS
  84 The mouse driver can be configured using the following kernel configuration
  85 file options.
  86 .Bl -tag -width VUIDSFORMAT
  87 .It Cd options SUN_MS_BPS=integer
  88 This option causes the kernel to communicate with the mouse using the serial
  89 baud rate
  90 .Va integer .
  91 It is useful for mice which do not communicate at 1200 baud.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr kbd 4
  95 .Sh BUGS
  96 .Nm
  97 is hardwired to the built-in
  98 .Em zs1
  99 serial port.