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