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