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 The default for this value is 3333.
  48 .TP 7
  49 .BI "Option \*qSubDevices\*q \*q" integer \*q
  50 Sets the number of subdevices to be created when the device is first turned
  51 on.
  52 The default for this value is 0.
  53 .TP 7
  54 .BI "Option \*qPostButtonEvents\*q \*q" boolean \*q
  55 Enable/disable button down/up events. If this is set to True, the driver will
  56 post "Left Button" down and up events when a TUIO 2Dcur is added and removed,
  57 respectively.
  58 The default for this value is True.
  59 .TP 7
  60 .BI "Option \*qFseqThreshold\*q \*q" integer \*q
  61 Sets the maximum threshold within which "old" packets will be dropped.  Each
  62 TUIO packet contains a frame sequence (fseq) number which is increased by 1
  63 for each successive new packet. If a new packet contains a lower fseq than the
  64 previously received packet, it will be dropped if it is within this threshold.
  65 The default for this value is 100.
  66
  67 .SH SUPPORTED PROPERTIES
  68 The following properties are provided by the
  69 .B tuio
  70 driver.
  71
  72 NONE
  73
  74 .SH AUTHORS
  75 Ryan Huffman <ryanhuffman@gmail.com>
  76
  77 .SH "SEE ALSO"
  78 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__),
  79 .