xref: /dflybsd-src/share/man/man4/wsp.4 (revision 47f1bb5576dd7e5fd9f728070eff9f4e2fd9927b)
1*47f1bb55SSascha Wildner.\" Copyright (c) 2014 Hans Petter Selasky <hselasky at freebsd dot org>.
2*47f1bb55SSascha Wildner.\" All rights reserved.
3*47f1bb55SSascha Wildner.\"
4*47f1bb55SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
5*47f1bb55SSascha Wildner.\" modification, are permitted provided that the following conditions
6*47f1bb55SSascha Wildner.\" are met:
7*47f1bb55SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
8*47f1bb55SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
9*47f1bb55SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
10*47f1bb55SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in the
11*47f1bb55SSascha Wildner.\"    documentation and/or other materials provided with the distribution.
12*47f1bb55SSascha Wildner.\"
13*47f1bb55SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*47f1bb55SSascha Wildner.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*47f1bb55SSascha Wildner.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*47f1bb55SSascha Wildner.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*47f1bb55SSascha Wildner.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*47f1bb55SSascha Wildner.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*47f1bb55SSascha Wildner.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*47f1bb55SSascha Wildner.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*47f1bb55SSascha Wildner.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*47f1bb55SSascha Wildner.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*47f1bb55SSascha Wildner.\" SUCH DAMAGE.
24*47f1bb55SSascha Wildner.\"
25*47f1bb55SSascha Wildner.\" $FreeBSD: head/share/man/man4/wsp.4 328027 2018-01-15 21:53:33Z kevans $
26*47f1bb55SSascha Wildner.\"
27*47f1bb55SSascha Wildner.Dd July 9, 2020
28*47f1bb55SSascha Wildner.Dt WSP 4
29*47f1bb55SSascha Wildner.Os
30*47f1bb55SSascha Wildner.Sh NAME
31*47f1bb55SSascha Wildner.Nm wsp
32*47f1bb55SSascha Wildner.Nd Wellspring touchpad driver
33*47f1bb55SSascha Wildner.Sh SYNOPSIS
34*47f1bb55SSascha WildnerTo compile this driver into the kernel, place the following lines into
35*47f1bb55SSascha Wildneryour kernel configuration file:
36*47f1bb55SSascha Wildner.Bd -ragged -offset indent
37*47f1bb55SSascha Wildner.Cd "device wsp"
38*47f1bb55SSascha Wildner.Cd "device usb"
39*47f1bb55SSascha Wildner.Ed
40*47f1bb55SSascha Wildner.Pp
41*47f1bb55SSascha WildnerAlternatively, to load the driver as a module at boot time,
42*47f1bb55SSascha Wildnerplace the following line in
43*47f1bb55SSascha Wildner.Xr loader.conf 5 :
44*47f1bb55SSascha Wildner.Bd -literal -offset indent
45*47f1bb55SSascha Wildnerwsp_load="YES"
46*47f1bb55SSascha Wildner.Ed
47*47f1bb55SSascha Wildner.Sh DESCRIPTION
48*47f1bb55SSascha WildnerThe
49*47f1bb55SSascha Wildner.Nm
50*47f1bb55SSascha Wildnerdriver provides support for the Apple Internal Trackpad
51*47f1bb55SSascha Wildnerdevice found in many Apple laptops.
52*47f1bb55SSascha Wildner.Pp
53*47f1bb55SSascha WildnerThe driver simulates a three-button mouse using multi-finger tap
54*47f1bb55SSascha Wildnerdetection.
55*47f1bb55SSascha WildnerA single-finger press generates a left button click.
56*47f1bb55SSascha WildnerA two-finger tap maps to the right button; whereas a three-finger tap
57*47f1bb55SSascha Wildnergets treated as a middle button click.
58*47f1bb55SSascha Wildner.Pp
59*47f1bb55SSascha Wildner.Nm
60*47f1bb55SSascha Wildnersupports dynamic reconfiguration using
61*47f1bb55SSascha Wildner.Xr sysctl 8
62*47f1bb55SSascha Wildnerthrough nodes under
63*47f1bb55SSascha Wildner.Nm hw.usb.wsp .
64*47f1bb55SSascha WildnerPointer sensitivity can be controlled using the sysctl tunable
65*47f1bb55SSascha Wildner.Nm hw.usb.wsp.scale_factor .
66*47f1bb55SSascha WildnerTap to left-click can be controlled using the sysctl tunable
67*47f1bb55SSascha Wildner.Nm hw.usb.wsp.enable_single_tap_clicks ,
68*47f1bb55SSascha Wildnerset to 0 to disable single tap clicks or 1 to enable them (default).
69*47f1bb55SSascha Wildner.Sh FILES
70*47f1bb55SSascha Wildner.Nm
71*47f1bb55SSascha Wildnercreates a blocking pseudo-device file,
72*47f1bb55SSascha Wildner.Pa /dev/wsp0 ,
73*47f1bb55SSascha Wildnerwhich presents the mouse as a
74*47f1bb55SSascha Wildner.Em sysmouse
75*47f1bb55SSascha Wildneror
76*47f1bb55SSascha Wildner.Em mousesystems
77*47f1bb55SSascha Wildnertype device--see
78*47f1bb55SSascha Wildner.Xr moused 8
79*47f1bb55SSascha Wildnerfor an explanation of these mouse
80*47f1bb55SSascha Wildnertypes.
81*47f1bb55SSascha Wildner.Sh SEE ALSO
82*47f1bb55SSascha Wildner.Xr sysmouse 4 ,
83*47f1bb55SSascha Wildner.Xr usb 4 ,
84*47f1bb55SSascha Wildner.Xr loader.conf 5 ,
85*47f1bb55SSascha Wildner.Xr xorg.conf 5 Pq Pa x11/xorg ,
86*47f1bb55SSascha Wildner.Xr moused 8 ,
87*47f1bb55SSascha Wildner.Xr sysctl 8
88*47f1bb55SSascha Wildner.Sh AUTHORS
89*47f1bb55SSascha Wildner.An -nosplit
90*47f1bb55SSascha WildnerThe
91*47f1bb55SSascha Wildner.Nm
92*47f1bb55SSascha Wildnerdriver was written by
93*47f1bb55SSascha Wildner.An Huang Wen Hui Aq Mt huanghwh@gmail.com .
94