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