freebsd-nq/share/man/man4/ums.4

.\" Copyright (c) 1999
.\"	Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd November 27, 2006
.Dt UMS 4
.Os
.Sh NAME
.Nm ums
.Nd USB mouse driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device ums"
.Cd "device uhci"
.Cd "device ohci"
.Cd "device usb"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
ums_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides support for mice that attach to the USB port.
Supported are
mice with any number of buttons and mice with a wheel.
.Pp
The
.Pa /dev/ums0
device presents the mouse as a
.Ar sysmouse
or
.Ar mousesystems
type device.
See
.Xr moused 8
for an explanation of these mouse types.
.Sh FILES
.Bl -tag -width /dev/ums0 -compact
.It Pa /dev/ums0
blocking device node
.El
.Sh EXAMPLES
Use the first
USB mouse on the system as your console mouse:
.Pp
.Dl moused -p /dev/ums0 -t auto
.Pp
To be able to use the USB mouse under X, change the "Pointer" section in
.Nm xorg.conf
to the following:
.Pp
.Dl Device "/dev/ums0"
.Dl Protocol "Auto"
.Pp
If you want to be able to use the mouse in both virtual consoles as well
as in X change it to:
.Pp
.Dl Device "/dev/sysmouse"
.Dl Protocol "Auto"
.Sh SEE ALSO
.Xr ohci 4 ,
.Xr sysmouse 4 ,
.Xr uhci 4 ,
.Xr usb 4 ,
.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
.Xr moused 8
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Lennart Augustsson Aq Mt augustss@cs.chalmers.se
for
.Nx
and was adopted for
.Fx
by
.An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp .
.Pp
This manual page was written by
.An Nick Hibma Aq Mt n_hibma@FreeBSD.org
with input from
.An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.\" Copyright (c) 1999`
Update @freebsd.org email addresses to @FreeBSD.org as is the precedent. 2000-10-26 15:30:44 +00:00			`.\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
Use our preferred license text (no more "voices in his head"). While here, also move to a 2-clause license. From n_hibma@: "The 3rd clause was originally there for a reason, but I guess that it is safe to assume that no one can assume endorsement by me or anyone else without prior consent on anything really, so we might as well remove that clause." Approved by: n_hibma 2010-03-04 22:06:57 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
Use our preferred license text (no more "voices in his head"). While here, also move to a 2-clause license. From n_hibma@: "The 3rd clause was originally there for a reason, but I guess that it is safe to assume that no one can assume endorsement by me or anyone else without prior consent on anything really, so we might as well remove that clause." Approved by: n_hibma 2010-03-04 22:06:57 +00:00			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.\"`
Fixed the misplaced $FreeBSD$. 2005-02-09 18:07:17 +00:00			`.\" $FreeBSD$`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.\"`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`.Dd November 27, 2006`
* remove i386 specific mark * some style and syntax fixes * some duplicated $FreeBSD$ tags removed 1999-11-15 23:14:32 +00:00			`.Dt UMS 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.Sh NAME`
			`.Nm ums`
			`.Nd USB mouse driver`
			`.Sh SYNOPSIS`
Use our standard section 4 SYNOPSIS. MFC after: 3 days 2006-11-22 21:30:02 +00:00			`To compile this driver into the kernel,`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`place the following lines in your`
Use our standard section 4 SYNOPSIS. MFC after: 3 days 2006-11-22 21:30:02 +00:00			`kernel configuration file:`
			`.Bd -ragged -offset indent`
Second round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 16:13:26 +00:00			`.Cd "device ums"`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`.Cd "device uhci"`
			`.Cd "device ohci"`
			`.Cd "device usb"`
Use our standard section 4 SYNOPSIS. MFC after: 3 days 2006-11-22 21:30:02 +00:00			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`ums_load="YES"`
			`.Ed`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`driver provides support for mice that attach to the USB port.`
			`Supported are`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`mice with any number of buttons and mice with a wheel.`
			`.Pp`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`The`
			`.Pa /dev/ums0`
			`device presents the mouse as a`
Clarified info on X release 3.3.1. Submitted/Reviewed by: Joe Touch <touch@ISI.EDU> 1999-06-18 16:53:33 +00:00			`.Ar sysmouse`
			`or`
			`.Ar mousesystems`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`type device.`
			`See`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`.Xr moused 8`
Clarified info on X release 3.3.1. Submitted/Reviewed by: Joe Touch <touch@ISI.EDU> 1999-06-18 16:53:33 +00:00			`for an explanation of these mouse types.`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.Sh FILES`
			`.Bl -tag -width /dev/ums0 -compact`
			`.It Pa /dev/ums0`
			`blocking device node`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.El`
mdoc(7) police: use certified section headers wherever possible. 2000-11-17 11:44:16 +00:00			`.Sh EXAMPLES`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`Use the first`
			`USB mouse on the system as your console mouse:`
Added information on how to use a USB mouse under XFree. Supplied by: Kazutaka YOKOTA 1999-04-11 14:27:52 +00:00			`.Pp`
			`.Dl moused -p /dev/ums0 -t auto`
			`.Pp`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`To be able to use the USB mouse under X, change the "Pointer" section in`
- replace pointers to XF86Config with xorg.conf - remove outdated XFree86 3.3.1 information - bump .Dd MFC after: 3 days 2005-02-05 14:09:09 +00:00			`.Nm xorg.conf`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`to the following:`
Added information on how to use a USB mouse under XFree. Supplied by: Kazutaka YOKOTA 1999-04-11 14:27:52 +00:00			`.Pp`
			`.Dl Device "/dev/ums0"`
			`.Dl Protocol "Auto"`
			`.Pp`
			`If you want to be able to use the mouse in both virtual consoles as well`
Clarified info on X release 3.3.1. Submitted/Reviewed by: Joe Touch <touch@ISI.EDU> 1999-06-18 16:53:33 +00:00			`as in X change it to:`
Added information on how to use a USB mouse under XFree. Supplied by: Kazutaka YOKOTA 1999-04-11 14:27:52 +00:00			`.Pp`
			`.Dl Device "/dev/sysmouse"`
			`.Dl Protocol "Auto"`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.Sh SEE ALSO`
			`.Xr ohci 4 ,`
Added information on how to use a USB mouse under XFree. Supplied by: Kazutaka YOKOTA 1999-04-11 14:27:52 +00:00			`.Xr sysmouse 4 ,`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Xr uhci 4 ,`
			`.Xr usb 4 ,`
Overhaul this manpage somewhat: - Move mentionings of required drivers to the SYNOPSIS where they belong - Remove cruft (XiG, sheesh) from the EXAMPLES section and re-arrange things to make somewhat more sense - Fix an Xref to manpage from ports to mention the corresponsing port - Remove commented out HISTORY section header MFC after: 3 days 2006-11-27 18:37:45 +00:00			`.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`.Xr moused 8`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00			`.Nm`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`driver was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Lennart Augustsson Aq Mt augustss@cs.chalmers.se`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`for`
			`.Nx`
			`and was adopted for`
			`.Fx`
			`by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp .`
Add the manpages for ums and ukbd (USB mouse and keyboards) 1999-04-11 00:15:40 +00:00			`.Pp`
			`This manual page was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Nick Hibma Aq Mt n_hibma@FreeBSD.org`
Added information on how to use a USB mouse under XFree. Supplied by: Kazutaka YOKOTA 1999-04-11 14:27:52 +00:00			`with input from`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Kazutaka YOKOTA Aq Mt yokota@zodiac.mech.utsunomiya-u.ac.jp .`