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