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