1AIPTEK(4)                  Kernel Interfaces Manual                  AIPTEK(4)
2
3
4

NAME

6       aiptek - Aiptek USB Digital Tablet Input Driver for Linux
7

SYNOPSIS

9       Section "InputDevice"
10         Identifier "idevname"
11         Driver "aiptek"
12         Option "Device"   "devpath"
13         ...
14       EndSection
15

DESCRIPTION

17       aiptek  is  an  Xorg  input driver for Aiptek HyperPen USB-based tablet
18       devices.  This driver only supports the USB protocol,  and  only  under
19       Linux; for RS-232C-based HyperPens, please see the "hyperpen" driver.
20
21       The  aiptek driver functions as a pointer input device, and may be used
22       as the X server's core pointer.
23

SUPPORTED HARDWARE

25       This driver supports the Aiptek HyperPen 4000U, 5000U, 6000U, 8000U and
26       12000U USB-based input tablet on some Linux platforms.
27

CONFIGURATION DETAILS

29       Please refer to xorg.conf(5x) for general configuration details and for
30       options that can be used with all input  drivers.   This  section  only
31       covers configuration details specific to this driver.
32
33       Multiple  instances of the Aiptek devices can cohabit. It can be useful
34       to define multiple devices with different  active  zones.  Each  device
35       supports the following entries:
36
37               Option "Type" "stylus"|"eraser"|"cursor"
38                   sets  the type of tool the device represent. This option is
39                   mandatory.
40
41               Option "Device" "path"
42                   sets the path to the special file which  represents  serial
43                   line  where  the tablet is plugged.  You have to specify it
44                   for each subsection with the same value if you want to have
45                   multiple  devices  with  the  same  tablet.  This option is
46                   mandatory.
47
48               Option "USB" "on"
49                   specifies that you are using the  USB  bus  to  communicate
50                   with your tablet.  This setting is mandatory, as USB is the
51                   only protocol supported by this driver.
52
53               Option "DeviceName" "name"
54                   sets the name of the X device.
55
56               Option "Mode" "Relative"|"Absolute"
57                   sets the mode of the device.
58
59               Option "HistorySize" "number"
60                   sets the motion history size. By default the value is zero.
61
62               Option "AlwaysCore" "on"
63                   enables the sharing of the core pointer. When this  feature
64                   is  enabled,  the  device  will  take  control  of the core
65                   pointer (and thus will emit core events) and  at  the  same
66                   time  will  be  able,  when  asked  so,  to report extended
67                   events.  You can use the last available integer feedback to
68                   control  this  feature.  When  the value of the feedback is
69                   zero, the feature is disabled. The feature is  enabled  for
70                   any other value.
71
72               Option "XTop" "number"
73                   First  of  three sets of parameters to set the active zone.
74                   This sets the X coordinate of the top corner of the  active
75                   zone. "TopX" is a synonym.
76
77               Option "YTop" "number"
78                   First  of  three sets of parameters to set the active zone.
79                   This sets the Y coordinate of the top corner of the  active
80                   zone. "TopY" is a synonym.
81
82               Option "XBottom" "Inumber"
83                   First  of  three sets of parameters to set the active zone.
84                   This sets the X coordinate of  the  bottom  corner  of  the
85                   active zone. "BottomX" is a synonym.
86
87               Option "YBottom" "number"
88                   First  of  three sets of parameters to set the active zone.
89                   This sets the Y coordinate of  the  bottom  corner  of  the
90                   active zone. "BottomY" is a synonym.
91
92               Option "XMax" "number"
93                   Second  of three sets of parameters to set the active zone.
94                   This sets the the X coordinate of the bottom corner of  the
95                   active  zone.  The Top X corner's coordinate is fixed at 0.
96                   "MaxX" is a synonym.
97
98               Option "YMax" "number"
99                   Second of three sets of parameters to set the active  zone.
100                   This  sets the the Y coordinate of the bottom corner of the
101                   active zone. The Top Y corner's coordinate is fixed  at  0.
102                   "MaxY" is a synonym.
103
104               Option "XOffset" "number"
105                   Third  of  three sets of parameters to set the active zone.
106                   This sets the X coordinate of the top corner of the  active
107                   zone. "OffsetX" is a synonym.
108
109               Option "YOffset" "number"
110                   Third  of  three sets of parameters to set the active zone.
111                   This sets the Y coordinate of the top corner of the  active
112                   zone. "OffsetY" is a synonym.
113
114               Option "XSize" "number"
115                   Third  of  three sets of parameters to set the active zone.
116                   This sets the X coordinate of  the  bottom  corner  of  the
117                   active  zone. Unlike others, this parameter is expressed in
118                   relative coordinates from the "XOffset" parameter.  "XSize"
119                   is a synonym.
120
121               Option "YSize" "number"
122                   Third  of  three sets of parameters to set the active zone.
123                   This sets the Y coordinate of  the  bottom  corner  of  the
124                   active  zone. Unlike others, this parameter is expressed in
125                   relative coordinates from the "YOffset" parameter.  "YSize"
126                   is a synonym.
127
128               Option "ZMin" "number"
129                   Minimum  pressure  reading  that  will be accepted from the
130                   Stylus tool. "MinZ" is a synonym.
131
132               Option "ZMax" "number"
133                   Maximum pressure reading that will  be  accepted  from  the
134                   Stylus tool. "MaxZ" is a synonym.
135
136               Option "XThreshold" "number"
137                   Minimal  change  in  X  coordinate  position  that  will be
138                   accepted as data input.  "ThresholdX" is a synonym.
139
140               Option "YThreshold" "number"
141                   Minimal change  in  Y  coordinate  position  that  will  be
142                   accepted as data input.  "ThresholdY" is a synonym.
143
144               Option "ZThreshold" "number"
145                   Minimal change in pressure reading that will be accepted as
146                   data input.  "ThresholdZ" is a synonym.
147
148               Option "InvX" "on"
149                   Inverts X coordinate reports. "XInv" is a synonym.
150
151               Option "InvY" "on"
152                   Inverts Y coordinate reports. "YInv" is a synonym.
153
154               Option "Pressure" "soft"|"hard"|"linear"
155                   Pressure reports either delivered in  linearly  incremental
156                   values  (default),  or  perturbed  by one of two log-linear
157                   algorithms ("soft" or "hard".)
158
159               Option "KeepShape" "on"
160                   When this  option  is  enabled,  the  active  zone   begins
161                   according  to TopX and TopY.  The bottom corner is adjusted
162                   to keep the ratio width/height of the active zone the  same
163                   as  the  screen  while maximizing the area described by the
164                   active area set of  parameters,  XTop/YTop/XBottom/YBottom,
165                   XMax/YMax, or XOffset/YOffset/XSize/YSize.
166
167               Option "DebugLevel" number
168                   sets the level of debugging info reported.
169
170       This driver is currently Linux specific.
171

SEE ALSO

173       Xorg(1x),  xorg.conf(5x),  xorgconfig(1x),  Xserver(1x),  X(7),  hyper‐
174       pen(4).
175

AUTHORS

177       Bryan W. Headley <bheadley@earthlink.net>
178

PROJECT PAGE

180       http://aiptektablet.sourceforge.net tracks ongoing development of  this
181       driver,  the  Linux kernel driver, and a GUI front-end application that
182       works in concert with the above.
183
184
185
186X Version 11                xf86-input-aiptek 1.0.1                  AIPTEK(4)
Impressum