xref: /freebsd/share/man/man4/wsp.4 (revision ee7231c92936b17c592ad9d4dd92a560ff320191)
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 hid"
39.Cd "device usb"
40.Ed
41.Pp
42Alternatively, to load the driver as a module at boot time,
43place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46wsp_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver provides support for the Apple Internal Trackpad
52device found in many Apple laptops.
53.Pp
54The driver simulates a three-button mouse using multi-finger tap
55detection.
56A single-finger press generates a left button click.
57A two-finger tap maps to the right button; whereas a three-finger tap
58gets treated as a middle button click.
59.Pp
60.Nm
61supports dynamic reconfiguration using
62.Xr sysctl 8
63through nodes under
64.Nm hw.usb.wsp .
65Pointer sensitivity can be controlled using the sysctl tunable
66.Nm hw.usb.wsp.scale_factor .
67Tap to left-click can be controlled using the sysctl tunable
68.Nm hw.usb.wsp.enable_single_tap_clicks ,
69set to 0 to disable single tap clicks or 1 to enable them (default).
70.Sh FILES
71.Nm
72creates a blocking pseudo-device file,
73.Pa /dev/wsp0 ,
74which presents the mouse as a
75.Em sysmouse
76or
77.Em mousesystems
78type device--see
79.Xr moused 8
80for an explanation of these mouse
81types.
82.Sh SEE ALSO
83.Xr sysmouse 4 ,
84.Xr usb 4 ,
85.Xr loader.conf 5 ,
86.Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
87.Xr moused 8 ,
88.Xr sysctl 8
89.Sh AUTHORS
90.An -nosplit
91The
92.Nm
93driver was written by
94.An Huang Wen Hui Aq Mt huanghwh@gmail.com .
95