share/man/man4/uep.4

   1 .\" Copyright (c) 2010 Gleb Smirnoff <glebius@FreeBSD.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 August 5, 2018
  28 .Dt UEP 4
  29 .Os
  30 .Sh NAME
  31 .Nm uep
  32 .Nd eGalax touchscreen driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel, place the following lines into
  35 your kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device uep"
  38 .Cd "device usb"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 uep_load="YES"
  46 .Ed
  47 .Pp
  48 To compile this driver with evdev support enabled, place the
  49 following lines into the kernel configuration file:
  50 .Bd -ragged -offset indent
  51 .Cd "options EVDEV_SUPPORT"
  52 .Cd "device evdev"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for the eGalax onscreen touch panels.
  58 .Pp
  59 The driver is a stub.
  60 It just probes and attaches to USB device, creates a device entry
  61 and feeds reassembled packets from the hardware to it.
  62 Depending on compile-time kernel options it supports either native
  63 or evdev operation modes.
  64 .Pp
  65 To get the mouse working in
  66 .Xr X 7
  67 in native mode, install
  68 .Pa ports/x11-drivers/xf86-input-egalax .
  69 .Pp
  70 To get the mouse working in
  71 .Xr X 7
  72 in evdev mode, install
  73 .Pa ports/x11-drivers/xf86-input-evdev .
  74 .Sh FILES
  75 .Nm
  76 creates a blocking pseudo-device file,
  77 .Pa /dev/uep0
  78 in native mode or
  79 .Pa /dev/input/eventN
  80 in evdev mode.
  81 .Sh SEE ALSO
  82 .Xr usb 4 ,
  83 .Xr loader.conf 5 ,
  84 .Xr xorg.conf 5 Pq Pa ports/x11/xorg ,
  85 .Xr egalax 4 Pq Pa ports/x11-drivers/xf86-input-egalax ,
  86 .Xr evdev 4 Pq Pa ports/x11-drivers/xf86-input-evdev .
  87 .Sh AUTHORS
  88 .An -nosplit
  89 The
  90 .Nm
  91 driver was written by
  92 .An Gleb Smirnoff Aq Mt glebius@FreeBSD.org .
  93 .Sh BUGS
  94 .Nm
  95 cannot act like
  96 .Xr sysmouse 4 ,
  97 as
  98 .Xr sysmouse 4
  99 does not support absolute motion events.