xref: /freebsd/share/man/man4/wsp.4 (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd January 15, 2018
28.Dt WSP 4
29.Os
30.Sh NAME
31.Nm wsp
32.Nd Wellspring touchpad driver
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines into
35your kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device wsp"
38.Cd "device usb"
39.Ed
40.Pp
41Alternatively, to load the driver as a module at boot time,
42place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45wsp_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for the Apple Internal Trackpad
51device found in many Apple laptops.
52.Pp
53The driver simulates a three-button mouse using multi-finger tap
54detection.
55A single-finger press generates a left button click.
56A two-finger tap maps to the right button; whereas a three-finger tap
57gets treated as a middle button click.
58.Pp
59.Nm
60supports dynamic reconfiguration using
61.Xr sysctl 8
62through nodes under
63.Nm hw.usb.wsp .
64Pointer sensitivity can be controlled using the sysctl tunable
65.Nm hw.usb.wsp.scale_factor .
66Tap to left-click can be controlled using the sysctl tunable
67.Nm hw.usb.wsp.enable_single_tap_clicks ,
68set to 0 to disable single tap clicks or 1 to enable them (default).
69.Sh FILES
70.Nm
71creates a blocking pseudo-device file,
72.Pa /dev/wsp0 ,
73which presents the mouse as a
74.Em sysmouse
75or
76.Em mousesystems
77type device--see
78.Xr moused 8
79for an explanation of these mouse
80types.
81.Sh SEE ALSO
82.Xr sysmouse 4 ,
83.Xr usb 4 ,
84.Xr loader.conf 5 ,
85.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
86.Xr moused 8 ,
87.Xr sysctl 8
88.Sh AUTHORS
89.An -nosplit
90The
91.Nm
92driver was written by
93.An Huang Wen Hui Aq Mt huanghwh@gmail.com .
94