Added description info to man file
[xf86-input-tuio.git] / man / tuio.man
blobae718474088bd3b143961f7e3d0fac81880d7992
1 .\" shorthand for double quote that works everywhere.
2 .ds q \N'34'
3 .TH TUIO __drivermansuffix__ __vendorversion__
5 .SH NAME
6 tuio \- Multitouch TUIO Linux input driver
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
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 currently there is no 
25 way to send native multitouch events, regular input events must be sent through
26 multiple devices. To facilitate this, the driver will create 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).
31 For more information on the TUIO protocol, see http://www.tuio.org/
32 .PP
34 .SH SUPPORTED HARDWARE
35 TUIO based devices (this is more of a software requirement than anything)
36 .PP
38 .SH CONFIGURATION DETAILS
39 TODO
40 .PP
42 .SH SUPPORTED PROPERTIES
43 The following properties are provided by the
44 .B tuio
45 driver.
47 Currently none.
49 .SH AUTHORS
50 Ryan Huffman <ryanhuffman@gmail.com>
52 .SH "SEE ALSO"
53 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__),