xref: /freebsd/share/man/man4/ums.4 (revision 251c176f415c9dc57b7c8c063aec4208bfc2efa6)
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$
32.\"
33.Dd April 11, 1999
34.Dt UMS 4
35.Os FreeBSD
36.Sh NAME
37.Nm ums
38.Nd USB mouse driver
39.Sh SYNOPSIS
40.Cd "device ums"
41.Sh DESCRIPTION
42The
43.Nm
44driver provides support for mice that attach to the USB port.
45Supported are
46mice with any number of buttons and mice with a wheel.
47.Nm usb
48and one of
49.Nm uhci
50or
51.Nm ohci
52must be configured in the kernel as well.
53.Pp
54The /dev/ums device presents the mouse as a
55.Ar sysmouse
56or
57.Ar mousesystems
58type device.
59See
60.Nm moused
61for an explanation of these mouse types.
62.Sh FILES
63.Bl -tag -width /dev/ums0 -compact
64.It Pa /dev/ums0
65blocking device node
66.Sh EXAMPLES
67.Dl device ums
68.Pp
69Add the
70.Nm ums
71driver to the kernel.
72.Pp
73.Dl moused -p /dev/ums0 -t auto
74.Pp
75Use the first
76.Nm USB
77mouse on the system as your console mouse.
78.Pp
79Change the "Pointer" section in
80.Nm XF86Config
81to the following
82.Pp
83.Dl Device "/dev/ums0"
84.Dl Protocol "Auto"
85.Pp
86to be able to use the USB mouse under X. When using the XiG accelerated X
87server, change the mouse device to /dev/ums0 and the mouse type to
88"MouseSystems".
89.Pp
90If you want to be able to use the mouse in both virtual consoles as well
91as in X change it to:
92.Pp
93.Dl Device "/dev/sysmouse"
94.Dl Protocol "Auto"
95.Pp
96For XFree86 3.3.1 the entry should be:
97.Pp
98.Dl Device "/dev/sysmouse"
99.Dl Protocol "MouseSystems"
100.Pp
101.Sh SEE ALSO
102.Xr ohci 4 ,
103.Xr sysmouse 4 ,
104.Xr uhci 4 ,
105.Xr usb 4 ,
106.Xr XF86Config 5 ,
107.Xr moused 8
108.\".Sh HISTORY
109.Sh AUTHORS
110The
111.Nm ums
112driver was written by
113.An Lennart Augustsson Aq augustss@cs.chalmers.se
114for
115.Nx
116and was adopted for
117.Fx
118by
119.An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
120.Pp
121This manual page was written by
122.An Nick Hibma Aq n_hibma@FreeBSD.org
123with input from
124.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .
125