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.5 2008/01/26 16:33:18 swildner Exp $
  33 .\"
  34 .Dd January 26, 2008
  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
  56 .Pa /dev/ums0
  57 device presents the mouse as a
  58 .Ar sysmouse
  59 or
  60 .Ar mousesystems
  61 type device.
  62 See
  63 .Xr moused 8
  64 for an explanation of these mouse types.
  65 .Sh FILES
  66 .Bl -tag -width /dev/ums0 -compact
  67 .It Pa /dev/ums0
  68 blocking device node
  69 .El
  70 .Sh EXAMPLES
  71 Use the first
  72 USB mouse on the system as your console mouse:
  73 .Pp
  74 .Dl moused -p /dev/ums0 -t auto
  75 .Pp
  76 To be able to use the USB mouse under X, change the "Pointer" section in
  77 .Nm xorg.conf
  78 to the following:
  79 .Pp
  80 .Dl Device "/dev/ums0"
  81 .Dl Protocol "Auto"
  82 .Pp
  83 If you want to be able to use the mouse in both virtual consoles as well
  84 as in X change it to:
  85 .Pp
  86 .Dl Device "/dev/sysmouse"
  87 .Dl Protocol "Auto"
  88 .Sh SEE ALSO
  89 .Xr ohci 4 ,
  90 .Xr sysmouse 4 ,
  91 .Xr uhci 4 ,
  92 .Xr usb 4 ,
  93 .Xr xorg.conf 5 Pq Pa pkgsrc/x11/modular-xorg-server ,
  94 .Xr moused 8
  95 .Sh AUTHORS
  96 .An -nosplit
  97 The
  98 .Nm
  99 driver was written by
 100 .An Lennart Augustsson Aq augustss@cs.chalmers.se
 101 for
 102 .Nx
 103 and was adopted for
 104 .Fx
 105 by
 106 .An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
 107 .Pp
 108 This manual page was written by
 109 .An Nick Hibma Aq n_hibma@FreeBSD.org
 110 with input from
 111 .An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .