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$ 26.\" 27.Dd April 24, 2018 28.Dt UMS 4 29.Os 30.Sh NAME 31.Nm ums 32.Nd USB mouse driver 33.Sh SYNOPSIS 34To compile this driver into the kernel, 35place the following lines in your 36kernel 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 44Alternatively, to load the driver as a 45module at boot time, place the following line in 46.Xr loader.conf 5 : 47.Bd -literal -offset indent 48ums_load="YES" 49.Ed 50.Sh DESCRIPTION 51The 52.Nm 53driver provides support for mice that attach to the USB port. 54Supported are 55mice with any number of buttons and mice with a wheel. 56.Pp 57The 58.Pa /dev/ums0 59device presents the mouse as a 60.Ar sysmouse 61or 62.Ar mousesystems 63type device. 64See 65.Xr moused 8 66for an explanation of these mouse types. 67.Sh SYSCTL VARIABLES 68The following variables are available as both 69.Xr sysctl 8 70variables and 71.Xr loader 8 72tunables: 73.Bl -tag -width indent 74.It Va hw.usb.ums.debug 75Debug output level, where 0 is debugging disabled and larger values increase 76debug message verbosity. 77Default is 0. 78.El 79.Sh FILES 80.Bl -tag -width /dev/ums0 -compact 81.It Pa /dev/ums0 82blocking device node 83.El 84.Sh EXAMPLES 85Use the first 86USB mouse on the system as your console mouse: 87.Pp 88.Dl moused -p /dev/ums0 -t auto 89.Pp 90To be able to use the USB mouse under X, change the "Pointer" section in 91.Nm xorg.conf 92to the following: 93.Pp 94.Dl Device "/dev/ums0" 95.Dl Protocol "Auto" 96.Pp 97If you want to be able to use the mouse in both virtual consoles as well 98as in X change it to: 99.Pp 100.Dl Device "/dev/sysmouse" 101.Dl Protocol "Auto" 102.Sh SEE ALSO 103.Xr ohci 4 , 104.Xr sysmouse 4 , 105.Xr uhci 4 , 106.Xr usb 4 , 107.Xr xorg.conf 5 Pq Pa ports/x11/xorg , 108.Xr moused 8 109.Sh AUTHORS 110.An -nosplit 111The 112.Nm 113driver was written by 114.An Lennart Augustsson Aq Mt augustss@cs.chalmers.se 115for 116.Nx 117and was adopted for 118.Fx 119by 120.An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp . 121.Pp 122This manual page was written by 123.An Nick Hibma Aq Mt n_hibma@FreeBSD.org 124with input from 125.An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp . 126