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