xref: /netbsd-src/share/man/man4/wsmouse.4 (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1.\" $NetBSD: wsmouse.4,v 1.14 2005/10/25 02:27:18 wiz Exp $
2.\"
3.\" Copyright (c) 1999
4.\" 	Matthias Drochner.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd May 25, 2004
28.Os
29.Dt WSMOUSE 4
30.Sh NAME
31.Nm wsmouse
32.Nd generic mouse support in wscons
33.Sh SYNOPSIS
34.Cd "wsmouse*   at pms? mux 0"
35(PS/2 mouse, including ``IntelliMouse''-compatible wheel mice)
36.Cd "wsmouse*   at ums? mux 0"
37(USB mouse)
38.Cd "wsmouse*   at lms? mux 0"
39(Logitech bus mouse, i386 only)
40.Cd "wsmouse*   at mms? mux 0"
41(Microsoft InPort mouse, i386 only)
42.Cd "wsmouse0   at ams? mux 0"
43(Apple ADB mouse)
44.Sh DESCRIPTION
45The
46.Nm
47driver is an abstraction layer for mice within the
48.Xr wscons 4
49framework.
50It is attached to the hardware specific mouse drivers and
51provides a character device interface which returns
52.Fa struct wscons_event
53via
54.Xr read 2 .
55For use with X servers,
56.Dq mouse events
57can be generated.
58.Pp
59The
60.Nm
61driver provides a number of ioctl functions to control
62various parameters.
63A complete list is in
64.Pa /usr/include/dev/wscons/wsconsio.h .
65The
66.Xr wsconsctl 8
67utility gives access to these variables.
68.Sh FILES
69.Bl -item
70.It
71.Pa /dev/wsmouse*
72.It
73.Pa /usr/include/dev/wscons/wsconsio.h .
74.El
75.Sh SEE ALSO
76.Xr lms 4 ,
77.Xr mms 4 ,
78.Xr pms 4 ,
79.Xr uep 4 ,
80.Xr ums 4 ,
81.Xr wscons 4 ,
82.Xr wsmux 4 ,
83.Xr moused 8 ,
84.Xr wsconsctl 8 ,
85.Xr wsmoused 8 ,
86.Xr wsmouse 9
87