share/man/man4/wsp.4

   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
  37 To compile this driver into the kernel, place the following lines into
  38 your kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device wsp"
  41 .Cd "device usb"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a module at boot time,
  45 place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 wsp_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for the Apple Internal Trackpad
  54 device found in many Apple laptops.
  55 .Pp
  56 The driver simulates a three-button mouse using multi-finger tap
  57 detection.
  58 A single-finger press generates a left button click.
  59 A two-finger tap maps to the right button; whereas a three-finger tap
  60 gets treated as a middle button click.
  61 .Pp
  62 .Nm
  63 supports dynamic reconfiguration using
  64 .Xr sysctl 8
  65 through nodes under
  66 .Nm hw.usb.wsp .
  67 Pointer sensitivity can be controlled using the sysctl tunable
  68 .Nm hw.usb.wsp.scale_factor .
  69 .Sh FILES
  70 .Nm
  71 creates a blocking pseudo-device file,
  72 .Pa /dev/wsp0 ,
  73 which presents the mouse as a
  74 .Em sysmouse
  75 or
  76 .Em mousesystems
  77 type device--see
  78 .Xr moused 8
  79 for an explanation of these mouse
  80 types.
  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
  90 The
  91 .Nm
  92 driver was written by
  93 .An Huang Wen Hui Aq huanghwh@gmail.com