man/tuio.man

   1 .\" shorthand for double quote that works everywhere.
   2 .ds q \N'34'
   3 .TH TUIO __drivermansuffix__ __vendorversion__
   4
   5 .SH NAME
   6 tuio \- Multitouch TUIO Linux input driver
   7
   8 .SH SYNOPSIS
   9 .nf
  10 .B "Section \*qInputDevice\*q"
  11 .BI "  Identifier \*q\" devname \*q
  12 .B  "  Driver \*qtuio\*q"
  13 .BI "  Option \*qPort\*q   \*q" 3333 \*q
  14 .BI "  Option \*qSubDevices\*q   \*q" 5 \*q
  15 .BI "  Option \*qPostButtonEvents\*q   \*q" True \*q
  16 \ \ ...
  17 .B EndSection
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .B tuio
  22 is an __xservername__ input driver. It listens for TUIO data on a specified
  23 port (see SYNOPSIS) and relays these events as X input events across multiple
  24 subdevices.  Because TUIO is a multitouch protocol, and because there is currently no
  25 way to send native multitouch events, regular input events must be sent through
  26 multiple devices. To facilitate this, the driver creates new devices (dubbed
  27 subdevices) through HAL that it will use for the sole purpose of sending events
  28 through.  In MPX/XI2, it is most effective to attach these subdevices to their
  29 own master devices (see Tuio Monitor Daemon, or tmd, for automation of this
  30 process).
  31
  32 For more information on the TUIO protocol, see http://www.tuio.org/
  33 .PP
  34
  35 .SH SUPPORTED HARDWARE
  36 TUIO based devices (this is more of a software requirement than anything)
  37 .PP
  38
  39 .SH CONFIGURATION DETAILS
  40 This section covers configuration details for this driver.
  41 .PP
  42 The following driver options are supported:
  43 .TP 7
  44 .BI "Option \*qPort\*q \*q" integer \*q
  45 Sets the UDP port to listen for TUIO messages on.  Must be a valid
  46 port number.
  47 .TP 7
  48 .BI "Option \*qSubDevices\*q \*q" integer \*q
  49 .TP 7
  50 .BI "Option \*qPostButtonEvents\*q \*q" boolean \*q
  51 Enable/disable button down/up events.
  52
  53 .SH SUPPORTED PROPERTIES
  54 The following properties are provided by the
  55 .B tuio
  56 driver.
  57
  58 NONE
  59
  60 .SH AUTHORS
  61 Ryan Huffman <ryanhuffman@gmail.com>
  62
  63 .SH "SEE ALSO"
  64 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__),
  65 .