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