xref: /freebsd/share/man/man4/wsp.4 (revision 27c43fe1f3795622c5bd4bbfc465a29a800c0799)
1.\" Copyright (c) 2014 Hans Petter Selasky <hselasky at freebsd dot org>.
2.\" 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. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"   without specific prior written permission.
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.\" $FreeBSD$
29.\"
30.Dd February 7, 2014
31.Dt WSP 4
32.Os
33.Sh NAME
34.Nm wsp
35.Nd Wellspring touchpad driver
36.Sh SYNOPSIS
37To compile this driver into the kernel, place the following lines into
38your kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device wsp"
41.Cd "device usb"
42.Ed
43.Pp
44Alternativly, to load the driver as a module at boot time,
45place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48wsp_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for the Apple Internal Trackpad
54device found in many Apple laptops.
55.Pp
56The driver simulates a three\-button mouse using multi\-finger tap
57detection.
58.
59A single\-finger press generates a left button click.
60A two\-finger tap maps to the right button; whereas a three\-finger tap
61gets treated as a middle button click.
62.
63.Pp
64.Nm
65supports dynamic reconfiguration using
66.Xr sysctl 8 ;
67through nodes under
68.Nm hw.usb.wsp .
69Pointer sensitivity can be controlled using the sysctl tunable
70.Nm hw.usb.wsp.scale_factor .
71.
72.Sh FILES
73.Nm
74creates a blocking pseudo\-device file,
75.Pa /dev/wsp0 ,
76which presents the mouse as a
77.Ar sysmouse
78or
79.Ar mousesystems
80type device\-\-see
81.Xr moused 8
82for an explanation of these mouse
83types.
84.Sh SEE ALSO
85.Xr sysmouse 4 ,
86.Xr usb 4 ,
87.Xr loader.conf 5 ,
88.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
89.Xr moused 8 ,
90.Xr sysctl 8
91.Sh AUTHORS
92.An -nosplit
93The
94.Nm
95driver was written by
96.An Huang Wen Hui Aq huanghwh@gmail.com
97