bionic (4) aiptek.4.gz

Provided by: xserver-xorg-input-aiptek_1.4.1-2build1_amd64 bug

NAME

       aiptek - Aiptek USB Digital Tablet Input Driver for Linux

SYNOPSIS

       Section "InputDevice"
         Identifier "idevname"
         Driver "aiptek"
         Option "Device"   "devpath"
         ...
       EndSection

DESCRIPTION

       aiptek  is  an Xorg input driver for Aiptek HyperPen USB-based tablet devices.  This driver only supports
       the USB protocol, and only under Linux; for RS-232C-based HyperPens, please see the "hyperpen" driver.

       The aiptek driver functions as a pointer input device, and may be used as the X server's core pointer.

SUPPORTED HARDWARE

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

CONFIGURATION DETAILS

       Please  refer to xorg.conf(5) for general configuration details and for options that can be used with all
       input drivers.  This section only covers configuration details specific to this driver.

       Multiple instances of the Aiptek devices can cohabit. It can be useful to define  multiple  devices  with
       different active zones. Each device supports the following entries:

               Option "Type" "stylus"|"eraser"|"cursor"
                   sets the type of tool the device represent. This option is mandatory.

               Option "Device" "path"
                   sets  the  path to the special file which represents serial line where the tablet is plugged.
                   You have to specify it for each subsection with the same value if you want to  have  multiple
                   devices with the same tablet.  This option is mandatory.

               Option "USB" "on"
                   specifies  that  you  are using the USB bus to communicate with your tablet.  This setting is
                   mandatory, as USB is the only protocol supported by this driver.

               Option "DeviceName" "name"
                   sets the name of the X device.

               Option "Mode" "Relative"|"Absolute"
                   sets the mode of the device.

               Option "HistorySize" "number"
                   sets the motion history size. By default the value is zero.

               Option "AlwaysCore" "on"
                   enables the sharing of the core pointer. When this feature is enabled, the device  will  take
                   control  of  the  core  pointer (and thus will emit core events) and at the same time will be
                   able, when asked so, to report extended events.  You  can  use  the  last  available  integer
                   feedback  to  control  this  feature.  When the value of the feedback is zero, the feature is
                   disabled. The feature is enabled for any other value.

               Option "XTop" "number"
                   First of three sets of parameters to set the active zone. This sets the X coordinate  of  the
                   top corner of the active zone. "TopX" is a synonym.

               Option "YTop" "number"
                   First  of  three sets of parameters to set the active zone. This sets the Y coordinate of the
                   top corner of the active zone. "TopY" is a synonym.

               Option "XBottom" "Inumber"
                   First of three sets of parameters to set the active zone. This sets the X coordinate  of  the
                   bottom corner of the active zone. "BottomX" is a synonym.

               Option "YBottom" "number"
                   First  of  three sets of parameters to set the active zone. This sets the Y coordinate of the
                   bottom corner of the active zone. "BottomY" is a synonym.

               Option "XMax" "number"
                   Second of three sets of parameters to set the active zone. This sets the the X coordinate  of
                   the  bottom corner of the active zone. The Top X corner's coordinate is fixed at 0. "MaxX" is
                   a synonym.

               Option "YMax" "number"
                   Second of three sets of parameters to set the active zone. This sets the the Y coordinate  of
                   the  bottom corner of the active zone. The Top Y corner's coordinate is fixed at 0. "MaxY" is
                   a synonym.

               Option "XOffset" "number"
                   Third of three sets of parameters to set the active zone. This sets the X coordinate  of  the
                   top corner of the active zone. "OffsetX" is a synonym.

               Option "YOffset" "number"
                   Third  of  three sets of parameters to set the active zone. This sets the Y coordinate of the
                   top corner of the active zone. "OffsetY" is a synonym.

               Option "XSize" "number"
                   Third of three sets of parameters to set the active zone. This sets the X coordinate  of  the
                   bottom  corner  of  the  active  zone. Unlike others, this parameter is expressed in relative
                   coordinates from the "XOffset" parameter. "XSize" is a synonym.

               Option "YSize" "number"
                   Third of three sets of parameters to set the active zone. This sets the Y coordinate  of  the
                   bottom  corner  of  the  active  zone. Unlike others, this parameter is expressed in relative
                   coordinates from the "YOffset" parameter. "YSize" is a synonym.

               Option "ZMin" "number"
                   Minimum pressure reading that will be accepted from the Stylus tool. "MinZ" is a synonym.

               Option "ZMax" "number"
                   Maximum pressure reading that will be accepted from the Stylus tool. "MaxZ" is a synonym.

               Option "XThreshold" "number"
                   Minimal change in X coordinate position that will be accepted as data input.  "ThresholdX" is
                   a synonym.

               Option "YThreshold" "number"
                   Minimal change in Y coordinate position that will be accepted as data input.  "ThresholdY" is
                   a synonym.

               Option "ZThreshold" "number"
                   Minimal change in pressure reading that will be accepted as data input.   "ThresholdZ"  is  a
                   synonym.

               Option "InvX" "on"
                   Inverts X coordinate reports. "XInv" is a synonym.

               Option "InvY" "on"
                   Inverts Y coordinate reports. "YInv" is a synonym.

               Option "Pressure" "soft"|"hard"|"linear"
                   Pressure  reports  either delivered in linearly incremental values (default), or perturbed by
                   one of two log-linear algorithms ("soft" or "hard".)

               Option "KeepShape" "on"
                   When this option is enabled, the active zone  begins according to TopX and TopY.  The  bottom
                   corner  is  adjusted to keep the ratio width/height of the active zone the same as the screen
                   while  maximizing  the   area   described   by   the   active   area   set   of   parameters,
                   XTop/YTop/XBottom/YBottom, XMax/YMax, or XOffset/YOffset/XSize/YSize.

               Option "DebugLevel" number
                   sets the level of debugging info reported.

       This driver is currently Linux specific.

SEE ALSO

       Xorg(1), xorg.conf(5), Xserver(1), X(7), hyperpen(4).

AUTHORS

       Bryan W. Headley <bheadley@earthlink.net>

PROJECT PAGE

       http://aiptektablet.sourceforge.net  tracks  ongoing development of this driver, the Linux kernel driver,
       and a GUI front-end application that works in concert with the above.