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 .\"     $DragonFly: src/share/man/man4/ums.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  33 .\"
  34 .Dd April 11, 1999
  35 .Dt UMS 4
  36 .Os
  37 .Sh NAME
  38 .Nm ums
  39 .Nd USB mouse driver
  40 .Sh SYNOPSIS
  41 .Cd "device ums"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for mice that attach to the USB port.
  46 Supported are
  47 mice with any number of buttons and mice with a wheel.
  48 .Nm usb
  49 and one of
  50 .Nm uhci
  51 or
  52 .Nm ohci
  53 must be configured in the kernel as well.
  54 .Pp
  55 The /dev/ums device presents the mouse as a
  56 .Ar sysmouse
  57 or
  58 .Ar mousesystems
  59 type device.
  60 See
  61 .Nm moused
  62 for an explanation of these mouse types.
  63 .Sh FILES
  64 .Bl -tag -width /dev/ums0 -compact
  65 .It Pa /dev/ums0
  66 blocking device node
  67 .El
  68 .Sh EXAMPLES
  69 .Dl device ums
  70 .Pp
  71 Add the
  72 .Nm
  73 driver to the kernel.
  74 .Pp
  75 .Dl moused -p /dev/ums0 -t auto
  76 .Pp
  77 Use the first
  78 .Nm USB
  79 mouse on the system as your console mouse.
  80 .Pp
  81 Change the "Pointer" section in
  82 .Nm XF86Config
  83 to the following
  84 .Pp
  85 .Dl Device "/dev/ums0"
  86 .Dl Protocol "Auto"
  87 .Pp
  88 to be able to use the USB mouse under X. When using the XiG accelerated X
  89 server, change the mouse device to /dev/ums0 and the mouse type to
  90 "MouseSystems".
  91 .Pp
  92 If you want to be able to use the mouse in both virtual consoles as well
  93 as in X change it to:
  94 .Pp
  95 .Dl Device "/dev/sysmouse"
  96 .Dl Protocol "Auto"
  97 .Pp
  98 For XFree86 3.3.1 the entry should be:
  99 .Pp
 100 .Dl Device "/dev/sysmouse"
 101 .Dl Protocol "MouseSystems"
 102 .Sh SEE ALSO
 103 .Xr ohci 4 ,
 104 .Xr sysmouse 4 ,
 105 .Xr uhci 4 ,
 106 .Xr usb 4 ,
 107 .Xr XF86Config 5 ,
 108 .Xr moused 8
 109 .\".Sh HISTORY
 110 .Sh AUTHORS
 111 .An -nosplit
 112 The
 113 .Nm
 114 driver was written by
 115 .An Lennart Augustsson Aq augustss@cs.chalmers.se
 116 for
 117 .Nx
 118 and was adopted for
 119 .Fx
 120 by
 121 .An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
 122 .Pp
 123 This manual page was written by
 124 .An Nick Hibma Aq n_hibma@FreeBSD.org
 125 with input from
 126 .An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .