share/man/man4/ums.4

   1 .\" Copyright (c) 1999
   2 .\"     Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL NICK HIBMA OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\"     $FreeBSD: src/share/man/man4/ums.4,v 1.9.2.7 2001/08/17 13:08:39 ru Exp $
  32 .\"
  33 .Dd April 11, 1999
  34 .Dt UMS 4
  35 .Os
  36 .Sh NAME
  37 .Nm ums
  38 .Nd USB mouse driver
  39 .Sh SYNOPSIS
  40 .Cd "device ums"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for mice that attach to the USB port.
  45 Supported are
  46 mice with any number of buttons and mice with a wheel.
  47 .Nm usb
  48 and one of
  49 .Nm uhci
  50 or
  51 .Nm ohci
  52 must be configured in the kernel as well.
  53 .Pp
  54 The /dev/ums device presents the mouse as a
  55 .Ar sysmouse
  56 or
  57 .Ar mousesystems
  58 type device.
  59 See
  60 .Nm moused
  61 for an explanation of these mouse types.
  62 .Sh FILES
  63 .Bl -tag -width /dev/ums0 -compact
  64 .It Pa /dev/ums0
  65 blocking device node
  66 .El
  67 .Sh EXAMPLES
  68 .Dl device ums
  69 .Pp
  70 Add the
  71 .Nm
  72 driver to the kernel.
  73 .Pp
  74 .Dl moused -p /dev/ums0 -t auto
  75 .Pp
  76 Use the first
  77 .Nm USB
  78 mouse on the system as your console mouse.
  79 .Pp
  80 Change the "Pointer" section in
  81 .Nm XF86Config
  82 to the following
  83 .Pp
  84 .Dl Device "/dev/ums0"
  85 .Dl Protocol "Auto"
  86 .Pp
  87 to be able to use the USB mouse under X. When using the XiG accelerated X
  88 server, change the mouse device to /dev/ums0 and the mouse type to
  89 "MouseSystems".
  90 .Pp
  91 If you want to be able to use the mouse in both virtual consoles as well
  92 as in X change it to:
  93 .Pp
  94 .Dl Device "/dev/sysmouse"
  95 .Dl Protocol "Auto"
  96 .Pp
  97 For XFree86 3.3.1 the entry should be:
  98 .Pp
  99 .Dl Device "/dev/sysmouse"
 100 .Dl Protocol "MouseSystems"
 101 .Sh SEE ALSO
 102 .Xr ohci 4 ,
 103 .Xr sysmouse 4 ,
 104 .Xr uhci 4 ,
 105 .Xr usb 4 ,
 106 .Xr XF86Config 5 ,
 107 .Xr moused 8
 108 .\".Sh HISTORY
 109 .Sh AUTHORS
 110 .An -nosplit
 111 The
 112 .Nm
 113 driver was written by
 114 .An Lennart Augustsson Aq augustss@cs.chalmers.se
 115 for
 116 .Nx
 117 and was adopted for
 118 .Fx
 119 by
 120 .An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
 121 .Pp
 122 This manual page was written by
 123 .An Nick Hibma Aq n_hibma@FreeBSD.org
 124 with input from
 125 .An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .