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