xref: /freebsd/share/man/man4/ums.4 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\" Copyright (c) 1999
2.\"	Nick Hibma <hibma@skylink.it>. 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. Supported are
45mice with any number of buttons and mice with a wheel.
46.Nm usb
47and one of
48.Nm uhci
49or
50.Nm ohci
51must be configured in the kernel as well.
52.Pp
53The /dev/ums device presents the mouse as a
54.Ar sysmouse
55or
56.Ar mousesystems
57type device. See
58.Nm moused
59for an explanation of these mouse types.
60.Sh FILES
61.Bl -tag -width /dev/ums0 -compact
62.It Pa /dev/ums0
63blocking device node
64.Sh EXAMPLE
65.Dl device ums0
66.Pp
67Add the
68.Nm ums
69driver to the kernel.
70.Pp
71.Dl moused -p /dev/ums0 -t auto
72.Pp
73Use the first
74.Nm USB
75mouse on the system as your console mouse.
76.Pp
77Change the "Pointer" section in
78.Nm XF86Config
79to the following
80.Pp
81.Dl Device "/dev/ums0"
82.Dl Protocol "Auto"
83.Pp
84to be able to use the USB mouse under X. When using the XiG accelerated X
85server, change the mouse device to /dev/ums0 and the mouse type to
86"MouseSystems".
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.Pp
94For XFree86 3.3.1 the entry should be:
95.Pp
96.Dl Device "/dev/sysmouse"
97.Dl Protocol "MouseSystems"
98.Pp
99.Sh SEE ALSO
100.Xr ohci 4 ,
101.Xr sysmouse 4 ,
102.Xr uhci 4 ,
103.Xr usb 4 ,
104.Xr XF86Config 5 ,
105.Xr moused 8
106.\".Sh HISTORY
107.Sh AUTHORS
108The
109.Nm ums
110driver was written by
111.An Lennart Augustsson Aq augustss@cs.chalmers.se
112for
113.Nx
114and was adopted for
115.Fx
116by
117.An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp .
118.Pp
119This manual page was written by
120.An Nick Hibma Aq hibma@skylink.it
121with input from
122.An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp .
123