libinput

package: xorg-drv-libinput

title: libinput(4)

summary: libinput-based X.Org input driver

text:
# libinput(4)

## NAME
libinput - libinput-based X.Org input driver

## SYNOPSIS

```
Section "InputDevice"
  Identifier "devname"
  Driver "libinput"
  Option "Device"   "devpath"
  ...
EndSection
```

## NOTE
This is the man page for the X input driver. If you are looking for the library documentation, go to http://wayland.freedesktop.org/libinput/doc/

## DESCRIPTION
libinput is an Xorg input driver based on libinput. It therefore supports all input devices that libinput can handle, including most mice, keyboards, tablets and touchscreens.

It is recommended that libinput devices are configured through the InputClass directive (refer to xorg.conf(5)) instead of manual per-device configuration. Devices configured in the xorg.conf(5) are not hot-plug capable.

## 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.

The following driver Options are supported:

Option "AccelProfile" "string"

Sets the pointer acceleration profile to the given profile. Permitted values are adaptive, flat, custom. Not all devices support this option or all profiles. If a profile is unsupported, the default profile for this device is used. For a description on the profiles and their behavior, see the libinput documentation.

Option "AccelSpeed" "float"

Sets the pointer acceleration speed within the range [-1, 1]. This only applies to the flat or adaptive profile.

Option "AccelPointsFallback" "string"

Option "AccelPointsMotion" "string"

Option "AccelPointsScroll" "string"

Sets the points of the Fallback/Motion/Scroll acceleration functions. The string must be a space-separated list of floating point non-negative numbers, e.g. "0.0 1.0 2.4 2.5". This only applies to the custom profile. See section CUSTOM ACCELERATION PROFILE

Option "AccelStepFallback" "float"

Option "AccelStepMotion" "float"

Option "AccelStepScroll" "float"

Sets the step between the points of the Fallback/Motion/Scroll acceleration functions. When a step of 0.0 is provided, libinput's Fallback acceleration function is used. This only applies to the custom profile. See section CUSTOM ACCELERATION PROFILE

Option "ButtonMapping" "string"

Sets the logical button mapping for this device, see XSetPointerMapping(3). The string must be a space-separated list of button mappings in the order of the logical buttons on the device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deactivates the button. Multiple buttons can have the same mapping. Invalid mapping strings are discarded and the default mapping is used for all buttons. Buttons not specified in the user's mapping use the default mapping. See section BUTTON MAPPING for more details.

Option "CalibrationMatrix" "string"

A string of 9 space-separated floating point numbers, in the order "a b c d e f g h i". Sets the calibration matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi).

Option "ClickMethod" "string"

Enables a click method. Permitted values are none, buttonareas, clickfinger. Not all devices support all methods, if an option is unsupported, the default click method for this device is used.

Option "DisableWhileTyping" "bool"

Indicates if the touchpad should be disabled while typing on the keyboard (this does not apply to modifier keys such as Ctrl or Alt).

Option "Device" "string"

Specifies the device through which the device can be accessed. This will generally be of the form "/dev/input/eventX", where X is some integer. When using InputClass directives, this option is set by the server. The mapping from device node to hardware is system-dependent. Property: "Device Node" (read-only).

Option "DragLockButtons" "L1 B1 L2 B2 ..."

Sets "drag lock buttons" that simulate a button logically down even when it has been physically released. To logically release a locked button, a second click of the same button is required.

If the option is a single button number, that button acts as the "meta" locking button for the next button number. See section BUTTON DRAG LOCK for details.

If the option is a list of button number pairs, the first number of each number pair is the lock button, the second number the logical button number to be locked. See section BUTTON DRAG LOCK for details.

For both meta and button pair configuration, the button numbers are device button numbers, i.e. the ButtonMapping applies after drag lock.

Option "HighResolutionWheelScrolling" "bool"

Disables high-resolution wheel scroll events, enabled by default. When enabled, the driver forwards only high-resolution wheel scroll events from libinput. When disabled, the driver forwards legacy wheel scroll events instead.

Option "HorizontalScrolling" "bool"

Enables or disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. This does not disable horizontal scroll events from libinput; it merely discards the horizontal axis from any scroll events. Default is enabled.

Option "LeftHanded" "bool"

Enables left-handed button orientation, i.e. swapping left and right buttons.

Option "MiddleEmulation" "bool"

Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click.

Option "NaturalScrolling" "bool"

Enables or disables natural scrolling behavior.

Option "RotationAngle" "float"

Sets the rotation angle of the device to the given angle, in degrees clockwise. The angle must be between 0.0 (inclusive) and 360.0 (exclusive).

Option "ScrollButton" "int"

Designates a button as scroll button. If the ScrollMethod is button and the button is logically down, x/y axis movement is converted into scroll events.

Option "ScrollButtonLock" "bool"

Enables or disables the scroll button lock. If enabled, the ScrollButton is considered logically down after the first click and remains down until the second click of that button. If disabled (the default), the ScrollButton button is considered logically down while held down and up once physically released.

Option "ScrollMethod" "string"

Enables a scroll method. Permitted values are none, twofinger, edge, button. Not all devices support all options, if an option is unsupported, the default scroll option for this device is used.

Option "ScrollPixelDistance" "int"

Sets the movement distance, in "pixels", required to trigger one logical wheel click. This option only applies to the scroll methods twofinger, edge, button. See section SCROLL PIXEL DISTANCE for more details.

Option "SendEventsMode" "(disabled|enabled|disabled-on-external-mouse)"

Sets the send events mode to disabled, enabled, or "disable when an external mouse is connected".

Option "TabletToolPressureCurve" "x0/y0 x1/y1 x2/y2 x3/y3"

Set the pressure curve for a tablet stylus to the bezier formed by the four points. The respective x/y coordinate must be in the [0.0, 1.0] range. For more information see section TABLET STYLUS PRESSURE CURVE.

Option "TabletToolPressureRange" "min max"

Set the pressure range for a tablet stylus to the given subset of the physical range. The min/max values must be in the [0.0, 1.0] range. For example a min of 0.3 means the tablet will send 0 pressure for anything equal or below 30% of the physical pressure range and a max of 0.7 means the tablet sends its maximum pressure value for any pressure equal or higher to 70% of the physical pressure range.

Option "TabletToolAreaRatio" "w:h"

Sets the area ratio for a tablet tool. The area always starts at the origin (0/0) and expands to the largest available area with the specified aspect ratio. Events outside this area are cropped to the area. The special value "default" is used for the default mapping (i.e. the device-native mapping). For more information see section TABLET TOOL AREA RATIO.

Option "Tapping" "bool"

Enables or disables tap-to-click behavior.

Option "TappingButtonMap" "(lrm|lmr)"

Set the button mapping for 1/2/3-finger taps to left/right/middle or left/middle/right, respectively.

Option "TappingDrag" "bool"

Enables or disables drag during tapping behavior ("tap-and-drag"). When enabled, a tap followed by a finger held down causes a single button down only, all motions of that finger thus translate into dragging motion. Tap-and-drag requires option Tapping to be enabled.

Option "TappingDragLock" "bool"

Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap-and-drag will not immediately release the button. If the finger is set down again within the timeout, the dragging process continues.

For all options, the options are only parsed if the device supports that configuration option. For all options, the default value is the one used by libinput. On configuration failure, the default value is applied.

## SUPPORTED PROPERTIES
libinput exports runtime-configurable options as properties. If a property listed below is not available, the matching configuration option is not available on the device. This however does not imply that the feature is not available on the device. The following properties are provided by the libinput driver.

libinput Accel Profiles Available

3 boolean values (8 bit, 0 or 1), in order "adaptive", "flat", "custom". Indicates which acceleration profiles are available on this device.

libinput Accel Profile Enabled

3 boolean values (8 bit, 0 or 1), in order "adaptive", "flat", "custom". Indicates which acceleration profile is currently enabled on this device.

libinput Accel Speed

1 32-bit float value, defines the pointer speed. Value range -1, 1. This only applies to the flat or adaptive profile.

libinput Accel Custom Fallback Points

libinput Accel Custom Motion Points

libinput Accel Custom Scroll Points

A space-separated list of 32-bit floating point non-negative numbers, e.g. "0.0 1.0 2.4 2.5". Sets the points of the Fallback/Motion/Scroll acceleration functions. This only applies to the custom profile. See section CUSTOM ACCELERATION PROFILE

libinput Accel Custom Fallback Step

libinput Accel Custom Motion Step

libinput Accel Custom Scroll Step

1 32-bit float value, sets the step between the points of the Fallback/Motion/Scroll acceleration functions. When a step of 0.0 is provided, libinput's Fallback acceleration function is used. This only applies to the custom profile. See section CUSTOM ACCELERATION PROFILE

libinput Button Scrolling Button

1 32-bit value. Sets the button number to use for button scrolling. This setting is independent of the scroll method, to enable button scrolling the method must be set to button-scrolling and a valid button must be set.

libinput Button Scrolling Button Lock Enabled

1 boolean value. If true, the scroll button lock is enabled. This setting is independent of the scroll method or the scroll button, to enable button scrolling the method must be set to button-scrolling and a valid button must be set.

libinput Calibration Matrix

9 32-bit float values, representing a 3x3 calibration matrix, order is row 1, row 2, row 3

libinput Click Methods Available

2 boolean values (8 bit, 0 or 1), in order "buttonareas", "clickfinger". Indicates which click methods are available on this device.

libinput Click Methods Enabled

2 boolean values (8 bit, 0 or 1), in order "buttonareas", "clickfinger". Indicates which click methods are enabled on this device.

libinput Drag Lock Buttons

Either one 8-bit value specifying the meta drag lock button, or a list of button pairs. See section BUTTON DRAG LOCK for details.

libinput High Resolution Wheel Scroll Enabled

1 boolean value (8 bit, 0 or 1). Indicates whether high-resolution wheel scroll events are enabled or not.

libinput Horizontal Scroll Enabled

1 boolean value (8 bit, 0 or 1). Indicates whether horizontal scrolling events are enabled or not.

libinput Left Handed Enabled

1 boolean value (8 bit, 0 or 1). Indicates if left-handed mode is enabled or disabled.

libinput Middle Emulation Enabled

1 boolean value (8 bit, 0 or 1). Indicates if middle emulation is enabled or disabled.

libinput Natural Scrolling Enabled

1 boolean value (8 bit, 0 or 1). 1 enables natural scrolling

libinput Rotation Angle

1 32-bit float value [0.0 to 360.0). Sets the rotation angle of the device, clockwise of its natural neutral position.

libinput Scroll Methods Available

3 boolean values (8 bit, 0 or 1), in order "two-finger", "edge", "button". Indicates which scroll methods are available on this device.

libinput Scroll Method Enabled

3 boolean values (8 bit, 0 or 1), in order "two-finger", "edge", "button". Indicates which scroll method is currently enabled on this device.

libinput Scroll Pixel Distance

1 32-bit value (nonzero, with additional implementation-defined range checks). Changes the movement distance required to trigger one logical wheel click.

libinput Send Events Modes Available

2 boolean values (8 bit, 0 or 1), in order "disabled" and "disabled-on-external-mouse". Indicates which send-event modes are available on this device.

libinput Send Events Mode Enabled

2 boolean values (8 bit, 0 or 1), in order "disabled" and "disabled-on-external-mouse". Indicates which send-event modes is currently enabled on this device.

libinput Tablet Tool Pressurecurve

4 32-bit float values [0.0 to 1.0]. See section TABLET TOOL PRESSURE CURVE

libinput Tablet Tool Area Ratio

2 32-bit values, corresponding to width and height. Special value 0, 0 resets to the default ratio. See section TABLET TOOL AREA RATIO for more information.

libinput Tapping Enabled

1 boolean value (8 bit, 0 or 1). 1 enables tapping

libinput Tapping Button Mapping Enabled

2 boolean value (8 bit, 0 or 1), in order "lrm" and "lmr". Indicates which button mapping is currently enabled on this device.

libinput Tapping Drag Lock Enabled

1 boolean value (8 bit, 0 or 1). 1 enables drag lock during tapping

libinput Disable While Typing Enabled

1 boolean value (8 bit, 0 or 1). Indicates if disable while typing is enabled or disabled.

Most properties have a libinput <property name> Default equivalent that indicates the default value for this setting on this device.

## BUTTON MAPPING
X clients receive events with logical button numbers, where 1, 2, 3 are usually interpreted as left, middle, right and logical buttons 4, 5, 6, 7 are usually interpreted as scroll up, down, left, right. The fourth and fifth physical buttons on a device will thus send logical buttons 8 and 9. The ButtonMapping option adjusts the logical button mapping, it does not affect how a physical button is mapped to a logical button.

Traditionally, a device was set to left-handed button mode by applying a button mapping of "3 2 1 ..." On systems using the libinput Xorg input driver it is recommended to use the LeftHanded option instead.

The libinput Xorg input driver does not use the button mapping after setup. Use XSetPointerMapping(3) to modify the button mapping at runtime.

## BUTTON DRAG LOCK
Button drag lock holds a button logically down even when the button itself has been physically released since. Button drag lock comes in two modes.

If in "meta" mode, a meta button click activates drag lock for the next button press of any other button. A button click in the future will keep that button held logically down until a subsequent click of that same button. The meta button events themselves are discarded. A separate meta button click is required each time a drag lock should be activated for a button in the future.

If in "pairs" mode, each button can be assigned a target locking button. On button click, the target lock button is held logically down until the next click of the same button. The button events themselves are discarded and only the target button events are sent.

This feature is provided by this driver, not by libinput.

## TABLET TOOL PRESSURECURVE
The pressure curve affects how stylus pressure is reported. By default, the hardware pressure is reported as-is. By setting a pressure curve, the feel of the stylus can be adjusted to be more like e.g. a pencil or a brush.

The pressure curve is a cubic Bezier curve, drawn within a normalized range of 0.0 to 1.0 between the four points provided. This normalized range is applied to the tablet's pressure input so that the highest pressure maps to 1.0. The points must have increasing x coordinates, if x0 is larger than 0.0 all pressure values lower than x0 are equivalent to y0. If x3 is less than 1.0, all pressure values higher than x3 are equivalent to y3.

The input for a linear curve (default) is "0.0/0.0 0.0/0.0 1.0/1.0 1.0/1.0"; a slightly depressed curve (firmer) might be "0.0/0.0 0.05/0.0 1.0/0.95 1.0/1.0"; a slightly raised curve (softer) might be "0.0/0.0 0.0/0.05 0.95/1.0 1.0/1.0".

This feature is provided by this driver, not by libinput.

## TABLET TOOL AREA RATIO
By default, a tablet tool can access the whole sensor area and the tablet area is mapped to the available screen area. For external tablets like the Wacom Intuos series, the height:width ratio of the tablet may be different to that of the monitor, causing the skew of input data.

To avoid this skew of input data, an area ratio may be set to match the ratio of the screen device. For example, a ratio of 4:3 will reduce the available area of the tablet to the largest available area with a ratio of 4:3. Events within this area will scale to the tablet's announced axis range, the area ratio is thus transparent to the X server. Any events outside this area will send events equal to the maximum value of that axis. The area always starts at the device's origin in it's current rotation, i.e. it takes left-handed-ness into account.

This feature is provided by this driver, not by libinput.

## SCROLL PIXEL DISTANCE
The X server does not support per-pixel scrolling but it does support smooth scrolling. All scroll events however are based around a logical unit of scrolling (traditionally corresponding to a wheel click). It is thus not possible to scroll by 10 pixels, but it is possible for a driver to scroll by 1/10th of a logical wheel click.

libinput provides scroll data in pixels. The ScrollPixelDistance option defines the amount of movement equivalent to one wheel click. For example, a value of 50 means the user has to move a finger by 50 pixels to generate one logical click event and each pixel is 1/50th of a wheel click.

## CUSTOM ACCELERATION PROFILE
The custom pointer acceleration profile gives users full control over the acceleration behavior at different speeds. libinput exposes an acceleration function f(x) where the x-axis is the device speed in device units per millisecond and the y-axis is the pointer speed.

The custom acceleration function is defined using n points which are spaced uniformly along the x-axis, starting from 0 and continuing in constant steps. Thus the points defining the custom function are:

```
(0 * step, f[0]), (1 * step, f[1]), ..., ((n-1) * step, f[n-1])
```

When a velocity value does not lie exactly on those points, a linear interpolation/extrapolation of the two closest points will be calculated. There are 3 custom acceleration function, which are used for different movement types:

Movement type

Uses

supported by

Fallback

Catch-all default movement type

All devices

Motion

Used for pointer motion

All devices

Scroll

Used for scroll movement

Mouse, Touchpad

See libinput library documentation of more details: https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html#the-custom-acceleration-profile

## BUGS
This driver does not work with Option "Device" set to an event node in /dev/input/by-id and /dev/input/by-path. This can be usually be worked by using Section "InputClass" with an appropriate Match* statement in the xorg.conf(5).

## AUTHORS
Peter Hutterer

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)


mga

package: xorg-drv-mga

title: mga(4)

summary: Matrox video driver

text:
# mga(4)

## NAME
mga - Matrox video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "mga"
  ...
EndSection
```

## DESCRIPTION
mga is an Xorg driver for Matrox video cards. The driver is fully accelerated, and provides support for the following framebuffer depths: 8, 15, 16, 24, and an 8+24 overlay mode. All visual types are supported for depth 8, and both TrueColor and DirectColor visuals are supported for the other depths except 8+24 mode which supports PseudoColor, GrayScale and TrueColor. Multi-card configurations are supported. XVideo is supported on G200 and newer systems, with either TexturedVideo or video overlay. The second head of dual-head cards is supported for the G450 and G550.

## SUPPORTED HARDWARE
The mga driver supports PCI and AGP video cards based on the following Matrox chips. They are listed in approximate chronological order of production (with the most recent chipsets listed last), so consult this list when you are unsure whether your card is meant when references are made to ‘G200 and later’ chips, for example.

MGA2064W

MGA1064SG

Mystique

MGA2164W

Millennium II

G100

Productiva G100

G200

Millennium G200 and Mystique G200

G400

Millennium G400, Millennium G400 MAX, Millennium G450, and Marvel G450 eTV

G550

Millennium G550 and Millennium G550 Dual DVI

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details. This section only covers configuration details specific to this driver.

The driver auto-detects the chipset type, but the following ChipSet names may optionally be specified in the config file "Device" section, and will override the auto-detection:

"mga2064w", "mga1064sg", "mga2164w", "mga2164w agp", "mgag100", "mgag200", "mgag200 pci", "mgag400", "mgag550".

The G450 is Chipset "mgag400" with ChipRev 0x80.

The driver will auto-detect the amount of video memory present for all chips except the Millennium II. In the Millennium II case it defaults to 4096 kBytes. When using a Millennium II, the actual amount of video memory should be specified with a VideoRam entry in the config file "Device" section.

The following driver Options are supported:

Option "ColorKey" "integer"

Set the colormap index used for the transparency key for the depth 8 plane when operating in 8+24 overlay mode. The value must be in the range 2-255. Default: 255.

Option "HWCursor" "boolean"

Enable or disable the HW cursor. Default: on.

Option "MGASDRAM" "boolean"

Specify whether G100, G200 or G400 cards have SDRAM. The driver attempts to auto-detect this based on the card's PCI subsystem ID. This option may be used to override that auto-detection. The mga driver is not able to auto-detect the presence of of SDRAM on secondary heads in multihead configurations so this option will often need to be specified in multihead configurations. Default: auto-detected.

Option "NoAccel" "boolean"

Disable or enable acceleration. Default: acceleration is enabled.

Option "AccelMethod" "string"

Chooses between available acceleration architectures. Valid options are XAA and EXA. XAA is the traditional acceleration architecture and support for it is very stable. EXA is a newer acceleration architecture with better performance for the Render and Composite extensions, but the rendering code for it is newer and possibly unstable. The default is XAA.

Option "OverclockMem"

Set clocks to values used by some commercial X Servers (G100, G200 and G400 only). Default: off.

Option "PciRetry" "boolean"

Enable or disable PCI retries. Default: off.

Option "Rotate" "CW"

Option "Rotate" "CCW"

Rotate the display clockwise or counterclockwise. This mode is unaccelerated. Default: no rotation.

Option "ShadowFB" "boolean"

Enable or disable use of the shadow framebuffer layer. Default: off.

Option "SyncOnGreen" "boolean"

Enable or disable combining the sync signals with the green signal. Default: off.

Option "UseFBDev" "boolean"

Enable or disable use of on OS-specific fb interface (and is not supported on all OSs). See fbdevhw(4) for further information. Default: off.

Option "VideoKey" "integer"

This sets the default pixel value for the YUV video overlay key. Default: undefined.

Option "TexturedVideo" "boolean"

This has XvImage support use the texture engine rather than the video overlay. This option is only supported by G200 and later chips, and only at 16 and 32 bits per pixel. Default: off.

Option "OldDmaInit" "boolean"

This forces the driver to use the old DMA initialization path for DRI. Use this option only to support a older version of the DRI driver with a newer DRM (version 3.2 or later). This option also disables the use of direct rendering on PCI cards. Default: off.

Option "ForcePciDma" "boolean"

This forces the use of PCI DMA even if AGP DMA could be used. This option is primarily intended for testing purposes, but it could also be used on systems with a buggy or poorly function AGP implementation. Default: off.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)

## AUTHORS
Authors include: Radoslaw Kapitan, Mark Vojkovich, and also David Dawes, Guy Desbief, Dirk Hohndel, Doug Merritt, Andrew E. Mileski, Andrew van der Stock, Leonard N. Zubkoff, Andrew C. Aitchison.


nouveau

package: xorg-drv-nouveau

title: nouveau(4)

summary: NVIDIA video driver

text:
# nouveau(4)

## NAME
nouveau - NVIDIA video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "nouveau"
  ...
EndSection
```

## DESCRIPTION
nouveau is an Xorg driver for NVIDIA video cards. The driver supports 2D acceleration and provides support for the following framebuffer depths: (15,) 16 and 24. TrueColor visuals are supported for these depths.

## SUPPORTED HARDWARE
The nouveau driver supports PCI, PCI-Express and AGP video cards based on the following NVIDIA chips:

RIVA TNT

NV4

RIVA TNT2

NV5

GeForce 256, QUADRO

NV10

GeForce2, QUADRO2

NV11 & NV15

GeForce3, QUADRO DCC

NV20

nForce, nForce2

NV1A, NV1F

GeForce4, QUADRO4

NV17, NV18, NV25, NV28

GeForce FX, QUADRO FX

NV30, NV31, NV34, NV35, NV36, NV37, NV38

GeForce 6XXX

NV40, NV41, NV43, NV44, NV45, C51, MCP61

GeForce 7XXX

G70, G71, G72, G73, MCP67, MCP68, MCP73

GeForce 8XXX, 9XXX, 2XX, 3XX

G80, G84, G86, G92, G94, G96, G98, G200, GT215, GT216, GT218, MCP77, MCP79, MCP89

GeForce 4XX, 5XX

GF100, GF104, GF106, GF108, GF110, GF114, GF116, GF117, GF119

GeForce 6XX, 7XX

GK104, GK106, GK107, GK110, GK208

GeForce GTX 750

GM107, GM108

GeForce GTX 9XX

GM200, GM204, GM206

GeForce GTX 10XX

GP102, GP104, GP106, GP107, GP108

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details. This section only covers configuration details specific to this driver.

The driver auto-detects the chipset type and the amount of video memory present for all chips.

The following driver Options are supported:

Option "HWCursor" "boolean"

Enable or disable the HW cursor. Default: on.

Option "AccelMethod" "string"

Specify the acceleration method. One of "none", or "exa". Default: exa.

Option "NoAccel" "boolean"

Disable or enable acceleration. Default: acceleration is enabled.

Option "ShadowFB" "boolean"

Enable or disable use of the shadow framebuffer layer. Default: off.

Option "WrappedFB" "boolean"

Enable or disable wfb, only affects nv50+. Useful for some legacy configurations where high rendering latency is perceived. Default: wfb is disabled.

Option "GLXVBlank" "boolean"

Synchronize GLX clients to VBlank. Useful where tearing is a problem, harmful if the GPU isn't fast enough to keep up with the monitor refresh rate. Default: on.

Option "ZaphodHeads" "string"

Specify the randr output(s) to use with zaphod mode for a particular driver instance. If you use this option you most use this option for all instances of the driver.

For example: Option "ZaphodHeads" "LVDS,VGA-0" will assign xrandr outputs LVDS and VGA-0 to this instance of the driver.

Option "PageFlip" "boolean"

Enable DRI2 page flipping. Default: on.

Option "SwapLimit" "integer"

Set maximum allowed number of pending OpenGL double-buffer swaps for a drawable before a client is blocked.

A value of 1 corresponds to double-buffering. A value of 2 corresponds to triple-buffering. Higher values may allow higher framerate, but also increase lag for interactive applications, e.g., games. Nouveau currently reliably supports a maximum value of 2 on XOrg 1.12+. A maximum setting of 2 on older x-servers is allowed, but it will break conformance with the OpenML OML_sync_control specification and will cause failure of software that relies on correct presentation timing behaviour as defined in that specification.

Default: 1.

Option "DRI" "integer"

Define the maximum level of DRI to enable. Valid values are 2 or 3. exa acceleration will honor the maximum level if it is supported. Default: 2.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)

## AUTHORS
Authors include: David McKay, Jarno Paananen, Chas Inman, Dave Schmenk, Mark Vojkovich

## COPYRIGHT
NOTICE TO USER: The source code is copyrighted under U.S. and international laws. Users and possessors of this source code are hereby granted a nonexclusive, royalty-free copyright license to use this code in individual and commercial software.

Any use of this source code must include, in the user documentation and internal comments to the code, notices to the end user as follows:

Copyright 1993-2003 NVIDIA, Corporation. All rights reserved.

NVIDIA, CORPORATION MAKES NO REPRESENTATION ABOUT THE SUITABILITY OF THIS SOURCE CODE FOR ANY PURPOSE. IT IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND. NVIDIA, CORPORATION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOURCE CODE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL NVIDIA, CORPORATION BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOURCE CODE.

U.S. Government End Users. This source code is a "commercial item," as that term is defined at 48 C.F.R. 2.101 (OCT 1995), consisting of "commercial computer software" and "commercial computer software documentation," as such terms are used in 48 C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government only as a commercial end item. Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all U.S. Government End Users acquire the source code with only those rights set forth herein.


radeon

package: xorg-drv-radeon

title: radeon(4)

summary: ATI/AMD RADEON video driver

text:
# radeon(4)

## NAME
radeon - ATI/AMD RADEON video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "radeon"
  ...
EndSection
```

## DESCRIPTION
radeon is an Xorg driver for ATI/AMD RADEON-based video cards with the following features:

•

Full support for 8-, 15-, 16- and 24-bit pixel depths, and for 30-bit depth on Linux 3.16 and later;

•

RandR 1.2 and RandR 1.3 support;

•

Full EXA 2D acceleration;

•

Textured XVideo acceleration including anti-tearing support (Bicubic filtering only available on R/RV3xx, R/RV/RS4xx, R/RV5xx, and RS6xx/RS740);

•

3D acceleration;

## SUPPORTED HARDWARE
The radeon driver supports PCI, AGP, and PCIe video cards based on the following ATI/AMD chips (note: list is non-exhaustive):

R100

Radeon 7200

RV100

Radeon 7000(VE), M6, RN50/ES1000

RS100

Radeon IGP320(M)

RV200

Radeon 7500, M7, FireGL 7800

RS200

Radeon IGP330(M)/IGP340(M)

RS250

Radeon Mobility 7000 IGP

R200

Radeon 8500, 9100, FireGL 8800/8700

RV250

Radeon 9000PRO/9000, M9

RV280

Radeon 9200PRO/9200/9200SE/9250, M9+

RS300

Radeon 9100 IGP

RS350

Radeon 9200 IGP

RS400/RS480

Radeon XPRESS 200(M)/1100 IGP

R300

Radeon 9700PRO/9700/9500PRO/9500/9600TX, FireGL X1/Z1

R350

Radeon 9800PRO/9800SE/9800, FireGL X2

R360

Radeon 9800XT

RV350

Radeon 9600PRO/9600SE/9600/9550, M10/M11, FireGL T2

RV360

Radeon 9600XT

RV370

Radeon X300, M22

RV380

Radeon X600, M24

RV410

Radeon X700, M26 PCIe

R420

Radeon X800 AGP

R423/R430

Radeon X800, M28 PCIe

R480/R481

Radeon X850 PCIe/AGP

RV505/RV515/RV516/RV550

Radeon X1300/X1400/X1500/X1550/X2300

R520

Radeon X1800

RV530/RV560

Radeon X1600/X1650/X1700

RV570/R580

Radeon X1900/X1950

RS600/RS690/RS740

Radeon X1200/X1250/X2100

R600

Radeon HD 2900

RV610/RV630

Radeon HD 2400/2600/2700/4200/4225/4250

RV620/RV635

Radeon HD 3410/3430/3450/3470/3650/3670

RV670

Radeon HD 3690/3850/3870

RS780/RS880

Radeon HD 3100/3200/3300/4100/4200/4250/4290

RV710/RV730

Radeon HD 4330/4350/4550/4650/4670/5145/5165/530v/545v/560v/565v

RV740/RV770/RV790

Radeon HD 4770/4730/4830/4850/4860/4870/4890

CEDAR

Radeon HD 5430/5450/6330/6350/6370

REDWOOD

Radeon HD 5550/5570/5650/5670/5730/5750/5770/6530/6550/6570

JUNIPER

Radeon HD 5750/5770/5830/5850/5870/6750/6770/6830/6850/6870

CYPRESS

Radeon HD 5830/5850/5870

HEMLOCK

Radeon HD 5970

PALM

Radeon HD 6310/6250

SUMO/SUMO2

Radeon HD 6370/6380/6410/6480/6520/6530/6550/6620

BARTS

Radeon HD 6790/6850/6870/6950/6970/6990

TURKS

Radeon HD 6570/6630/6650/6670/6730/6750/6770

CAICOS

Radeon HD 6430/6450/6470/6490

CAYMAN

Radeon HD 6950/6970/6990

ARUBA

Radeon HD 7000 series

TAHITI

Radeon HD 7900 series

PITCAIRN

Radeon HD 7800 series

VERDE

Radeon HD 7700 series

OLAND

Radeon HD 8000 series

HAINAN

Radeon HD 8000 series

BONAIRE

Radeon HD 7790 series

KAVERI

KAVERI APUs

KABINI

KABINI APUs

HAWAII

Radeon R9 series

MULLINS

MULLINS APUs

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details. This section only covers configuration details specific to this driver.

The following driver Options are supported:

Option "SWcursor" "boolean"

Selects software cursor. The default is off.

Option "Accel" "boolean"

Enables or disables all hardware acceleration.

The default is on.

Option "ZaphodHeads" "string"

Specify the RandR output(s) to use with zaphod mode for a particular driver instance. If you use this option you must use this option for all instances of the driver.

For example: Option "ZaphodHeads" "LVDS,VGA-0" will assign xrandr outputs LVDS and VGA-0 to this instance of the driver.

Option "ColorTiling" "boolean"

The framebuffer can be addressed either in linear or tiled mode. Tiled mode can provide significant performance benefits with 3D applications. Tiling will be disabled if the drm module is too old or if the current display configuration does not support it. On R600+ this enables 1D tiling mode.

The default value is on for R/RV3XX, R/RV4XX, R/RV5XX, RS6XX, RS740, R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands and off for R/RV/RS1XX, R/RV/RS2XX, RS3XX, and RS690/RS780/RS880 when fast fb feature is enabled.

Option "ColorTiling2D" "boolean"

The framebuffer can be addressed either in linear, 1D, or 2D tiled modes. 2D tiled mode can provide significant performance benefits over 1D tiling with 3D applications. Tiling will be disabled if the drm module is too old or if the current display configuration does not support it. KMS ColorTiling2D is only supported on R600 and newer chips and requires Mesa 9.0 or newer for R6xx-ARUBA, Mesa 9.2 or newer for Southern Islands, and Mesa 10.1 or newer for Sea Islands.

The default value is on for R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands.

Option "DRI" "integer"

Define the maximum level of DRI to enable. Valid values are 2 for DRI2 or 3 for DRI3. The default is 3 for DRI3 if the Xorg version is >= 1.18.3 and glamor is enabled, otherwise 2 for DRI2. Note: DRI3 may not work correctly in all cases with EXA, enable at your own risk.

Option "EnablePageFlip" "boolean"

Enable DRI2 page flipping. The default is on. Pageflipping is supported on all radeon hardware.

Option "TearFree" "boolean"

Set the default value of the per-output 'TearFree' property, which controls tearing prevention using the hardware page flipping mechanism. TearFree is on for any CRTC associated with one or more outputs with TearFree on. Two separate scanout buffers need to be allocated for each CRTC with TearFree on. If this option is set, the default value of the property is 'on' or 'off' accordingly. If this option isn't set, the default value of the property is auto, which means that TearFree is on for rotated outputs, outputs with RandR transforms applied and for RandR 1.4 secondary outputs, otherwise off.

Option "AccelMethod" "string"

Chooses between available acceleration architectures. Valid values are EXA (for pre-TAHITI GPUs) and glamor (for R300 or higher). The default is glamor with R600 or newer (with Xorg >= 1.18.3, otherwise with TAHITI or newer), otherwise EXA.

The following driver Options are supported for glamor :

Option "ShadowPrimary" "boolean"

This option enables a so-called "shadow primary" buffer for fast CPU access to pixel data, and separate scanout buffers for each display controller (CRTC). This may improve performance for some 2D workloads, potentially at the expense of other (e.g. 3D, video) workloads. Note in particular that enabling this option currently disables page flipping. The default is off.

The following driver Options are supported for EXA :

Option "EXAVSync" "boolean"

This option attempts to avoid tearing by stalling the engine until the display controller has passed the destination region. It reduces tearing at the cost of performance and has been known to cause instability on some chips. The default is off.

Option "EXAPixmaps" "boolean"

Under KMS, to avoid thrashing pixmaps in/out of VRAM on low memory cards, we use a heuristic based on VRAM amount to determine whether to allow EXA to use VRAM for non-essential pixmaps. This option allows us to override the heuristic. The default is on with > 32MB VRAM, off with < 32MB or when fast fb feature is enabled for RS690/RS780/RS880.

Option "SwapbuffersWait" "boolean"

This option controls the behavior of glXSwapBuffers and glXCopySubBufferMESA calls by GL applications. If enabled, the calls will avoid tearing by making sure the display scanline is outside of the area to be copied before the copy occurs. If disabled, no scanline synchronization is performed, meaning tearing will likely occur. Note that when enabled, this option can adversely affect the framerate of applications that render frames at less than refresh rate.

The default value is on.

## TEXTURED VIDEO ATTRIBUTES
The driver supports the following X11 Xv attributes for Textured Video. You can use the "xvattr" tool to query/set those attributes at runtime.

XV_VSYNC

XV_VSYNC is used to control whether textured adapter synchronizes the screen update to the monitor vertical refresh to eliminate tearing. It has two values: 'off'(0) and 'on'(1). The default is 'on'(1).

XV_CRTC

XV_CRTC is used to control which display controller (crtc) the textured adapter synchronizes the screen update with when XV_VSYNC is enabled. The default, 'auto'(-1), will sync to the display controller that more of the video is on; when this is ambiguous, the display controller associated with the RandR primary output is preferred. This attribute is useful for things like clone mode where the user can best decide which display should be synced. The default is 'auto'(-1).

XV_BICUBIC

XV_BICUBIC is used to control whether textured adapter should apply a bicubic filter to smooth the output. It has three values: 'off'(0), 'on'(1) and 'auto'(2). 'off' means never apply the filter, 'on' means always apply the filter and 'auto' means apply the filter only if the X and Y sizes are scaled to more than double to avoid blurred output. Bicubic filtering is not currently compatible with other Xv attributes like hue, contrast, and brightness, and must be disabled to use those attributes. The default is 'off'(0).

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)

1.

Wiki page:

https://www.x.org/wiki/radeon

2.

Overview about radeon development code:

https://cgit.freedesktop.org/xorg/driver/xf86-video-ati/

3.

Mailing list:

https://lists.freedesktop.org/mailman/listinfo/amd-gfx

4.

IRC channel:

\#radeon on irc.freenode.net

5.

Query the bugtracker for radeon bugs:

https://bugs.freedesktop.org/query.cgi?product=xorg&component=Driver/Radeon

6.

Submit bugs & patches:

https://bugs.freedesktop.org/enter_bug.cgi?product=xorg&component=Driver/Radeon

## AUTHORS

```
Authors include:
Rickard E. (Rik) Faith   faith@precisioninsight.com
Kevin E. Martin          kem@freedesktop.org
Alan Hourihane           alanh@fairlite.demon.co.uk
Marc Aurele La France    tsi@xfree86.org
Benjamin Herrenschmidt   benh@kernel.crashing.org
Michel Dänzer            michel@daenzer.net
Alex Deucher             alexdeucher@gmail.com
Bogdan D.                bogdand@users.sourceforge.net
Eric Anholt              eric@anholt.net
```


synaptics

package: xorg-drv-synaptics

title: synaptics(4)

summary: touchpad input driver

text:
# synaptics(4)

## NAME
synaptics - touchpad input driver

## SYNOPSIS

```
Section "InputDevice"
  Identifier "devname"
  Driver "synaptics"
  Option "Device"   "devpath"
  Option "Path"     "path"
  ...
EndSection
```

## DESCRIPTION
synaptics is an Xorg input driver for touchpads. Even though touchpads can be handled by the normal evdev or mouse drivers, this driver allows more advanced features of the touchpad to become available. Some benefits would be:

- Movement with adjustable, non-linear acceleration and speed.

- Button events through short touching of the touchpad.

- Double-Button events through double short touching of the touchpad.

- Dragging through short touching and holding down the finger on the touchpad (tap-and-drag gesture).

- Middle and right button events on the upper and lower corner of the touchpad.

- Vertical scrolling (button four and five events) through moving the finger on the right side of the touchpad.

- The up/down button sends button four/five events.

- Horizontal scrolling (button six and seven events) through moving the finger on the lower side of the touchpad.

- The multi-buttons send button four/five events for vertical scrolling and button six/seven events for horizontal scrolling.

- Adjustable finger detection.

- Multifinger taps: two finger for right button and three finger for middle button events. (Needs hardware support. Not all models implement this feature.)

- Pressure-dependent motion speed.

Note that depending on the touchpad firmware, some of these features might be available even without using the synaptics driver. Note also that some functions are not available on all touchpad models, because they need support from the touchpad hardware/firmware. (Multifinger taps for example.)

The name "synaptics" is historical and the driver still provides the synaptics protocol parsing code. Under Linux however, the hardware-specifics are handled by the kernel and this driver will work for any touchpad that has a working kernel driver. If your device is recognized as "PS/2 Mouse" or similar, the kernel driver does not support your device and this driver will only provide limited functionality.

## CONFIGURATION OPTIONS
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.

The following driver Options are supported:

Option "Device" "string"

This option specifies the device file in your "/dev" directory which will be used to access the physical device. Normally you should use something like "/dev/input/eventX", where X is some integer.

Option "Protocol" "string"

Specifies which kernel driver will be used by this driver. This is the list of supported drivers and their default use scenarios. auto-dev

automatic, default (recommend)

event

Linux 2.6 kernel events

psaux

raw device access (Linux 2.4)

psm

FreeBSD psm driver

Option "LeftEdge" "integer"

X coordinate for left edge. Property: "Synaptics Edges"

Option "RightEdge" "integer"

X coordinate for right edge. Property: "Synaptics Edges"

Option "TopEdge" "integer"

Y coordinate for top edge. Property: "Synaptics Edges"

Option "BottomEdge" "integer"

Y coordinate for bottom edge. Property: "Synaptics Edges"

Option "FingerLow" "integer"

When finger pressure drops below this value, the driver counts it as a release. Property: "Synaptics Finger"

Option "FingerHigh" "integer"

When finger pressure goes above this value, the driver counts it as a touch. Property: "Synaptics Finger"

Option "MaxTapTime" "integer"

Maximum time (in milliseconds) for detecting a tap. Property: "Synaptics Tap Durations"

Option "MaxTapMove" "integer"

Maximum movement of the finger for detecting a tap. Property: "Synaptics Tap Move"

Option "MaxDoubleTapTime" "integer"

Maximum time (in milliseconds) for detecting a double tap. Property: "Synaptics Tap Durations"

Option "ClickTime" "integer"

The duration of the mouse click generated by tapping. Property: "Synaptics Tap Durations"

Option "ClickPad" "boolean"

Whether the device is a click pad. See ClickPad support for more details. Property: "Synaptics ClickPad"

Option "VertEdgeScroll" "boolean"

Enable vertical scrolling when dragging along the right edge. Property: "Synaptics Edge Scrolling"

Option "HorizEdgeScroll" "boolean"

Enable horizontal scrolling when dragging along the bottom edge. Property: "Synaptics Edge Scrolling"

Option "CornerCoasting" "boolean"

Enable edge scrolling to continue while the finger stays in an edge corner. Property: "Synaptics Edge Scrolling"

Option "VertTwoFingerScroll" "boolean"

Enable vertical scrolling when dragging with two fingers anywhere on the touchpad. Property: "Synaptics Two-Finger Scrolling"

Option "HorizTwoFingerScroll" "boolean"

Enable horizontal scrolling when dragging with two fingers anywhere on the touchpad. Property: "Synaptics Two-Finger Scrolling"

Option "VertScrollDelta" "integer"

Move distance of the finger for a scroll event. Property: "Synaptics Scrolling Distance"

Option "HorizScrollDelta" "integer"

Move distance of the finger for a scroll event. Property: "Synaptics Scrolling Distance"

Option "MinSpeed" "float"

Minimum speed factor. Property: "Synaptics Move Speed"

Option "MaxSpeed" "float"

Maximum speed factor. Property: "Synaptics Move Speed"

Option "AccelFactor" "float"

Acceleration factor for normal pointer movements. Property: "Synaptics Move Speed"

Option "PressureMotionMinZ" "integer"

Finger pressure at which minimum pressure motion factor is applied. Property: "Synaptics Pressure Motion"

Option "PressureMotionMaxZ" "integer"

Finger pressure at which maximum pressure motion factor is applied. Property: "Synaptics Pressure Motion"

Option "PressureMotionMinFactor" "integer"

Lowest setting for pressure motion factor. Property: "Synaptics Pressure Motion Factor"

Option "PressureMotionMaxFactor" "integer"

Greatest setting for pressure motion factor. Property: "Synaptics Pressure Motion Factor"

Option "HorizHysteresis" "integer"

The minimum horizontal HW distance required to generate motion events. Can be specified as a percentage. Increase if noise motion is a problem for you. Zero is disabled. Default: 0.5 percent of the diagonal or (in case of evdev) the appropriate "fuzz" as advertised by the device.

Option "VertHysteresis" "integer"

The minimum vertical HW distance required to generate motion events. See HorizHysteresis.

Option "UpDownScrolling" "boolean"

If on, the up/down buttons generate button 4/5 events. If off, the up button generates a double click and the down button generates a button 2 event. This option is only available for touchpads with physical scroll buttons. Property: "Synaptics Button Scrolling"

Option "LeftRightScrolling" "boolean"

If on, the left/right buttons generate button 6/7 events. If off, the left/right buttons both generate button 2 events. This option is only available for touchpads with physical scroll buttons. Property: "Synaptics Button Scrolling"

Option "UpDownScrollRepeat" "boolean"

If on, and the up/down buttons are used for scrolling (UpDownScrolling), these buttons will send auto-repeating 4/5 events, with the delay between repeats determined by ScrollButtonRepeat. This option is only available for touchpads with physical scroll buttons. Property: "Synaptics Button Scrolling Repeat"

Option "LeftRightScrollRepeat" "boolean"

If on, and the left/right buttons are used for scrolling (LeftRightScrolling), these buttons will send auto-repeating 6/7 events, with the delay between repeats determined by ScrollButtonRepeat. This option is only available for touchpads with physical scroll buttons. Property: "Synaptics Button Scrolling Repeat"

Option "ScrollButtonRepeat" "integer"

The number of milliseconds between repeats of button events 4-7 from the up/down/left/right scroll buttons. This option is only available for touchpads with physical scroll buttons. Property: "Synaptics Button Scrolling Time"

Option "EmulateMidButtonTime" "integer"

Maximum time (in milliseconds) for middle button emulation. Property: "Synaptics Middle Button Timeout"

Option "EmulateTwoFingerMinZ" "integer"

For touchpads not capable of detecting multiple fingers but are capable of detecting finger pressure and width, this sets the Z pressure threshold. When both Z pressure and W width thresholds are crossed, a two finger press will be emulated. This defaults to a value that disables emulation on touchpads with real two-finger detection and defaults to a value that enables emulation on remaining touchpads that support pressure and width support. Property: "Synaptics Two-Finger Pressure"

Option "EmulateTwoFingerMinW" "integer"

For touchpads not capable of detecting multiple fingers but are capable of detecting finger width and pressure, this sets the W width threshold. When both W width and Z pressure thresholds are crossed, a two finger press will be emulated. This feature works best with (PalmDetect) off. Property: "Synaptics Two-Finger Width"

Option "TouchpadOff" "integer"

Switch off the touchpad. Valid values are: 0

Touchpad is enabled

1

Touchpad is switched off (physical clicks still work)

2

Only tapping and scrolling is switched off

When the touchpad is switched off, button events caused by a physical button press are still interpreted. On a ClickPad, this includes software-emulated middle and right buttons as defined by the SoftButtonAreas setting.

Property: "Synaptics Off"

Option "LockedDrags" "boolean"

If off, a tap-and-drag gesture ends when you release the finger. If on, the gesture is active until you tap a second time, or until LockedDragTimeout expires. Property: "Synaptics Locked Drags"

Option "LockedDragTimeout" "integer"

This parameter specifies how long it takes (in milliseconds) for the LockedDrags mode to be automatically turned off after the finger is released from the touchpad. Property: "Synaptics Locked Drags Timeout"

Option "RTCornerButton" "integer"

Which mouse button is reported on a right top corner tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "RBCornerButton" "integer"

Which mouse button is reported on a right bottom corner tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "LTCornerButton" "integer"

Which mouse button is reported on a left top corner tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "LBCornerButton" "integer"

Which mouse button is reported on a left bottom corner tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "TapButton1" "integer"

Which mouse button is reported on a non-corner one-finger tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "TapButton2" "integer"

Which mouse button is reported on a non-corner two-finger tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "TapButton3" "integer"

Which mouse button is reported on a non-corner three-finger tap. Set to 0 to disable. Property: "Synaptics Tap Action"

Option "ClickFinger1" "integer"

Which mouse button is reported when left-clicking with one finger. Set to 0 to disable. Property: "Synaptics Click Action"

Option "ClickFinger2" "integer"

Which mouse button is reported when left-clicking with two fingers. Set to 0 to disable. Property: "Synaptics Click Action"

Option "ClickFinger3" "integer"

Which mouse button is reported when left-clicking with three fingers. Set to 0 to disable. Property: "Synaptics Click Action"

Option "CircularScrolling" "boolean"

If on, circular scrolling is used. Property: "Synaptics Circular Scrolling"

Option "CircScrollDelta" "float"

Move angle (radians) of finger to generate a scroll event. Property: "Synaptics Circular Scrolling Distance"

Option "CircScrollTrigger" "integer"

Trigger region on the touchpad to start circular scrolling 0

All Edges

1

Top Edge

2

Top Right Corner

3

Right Edge

4

Bottom Right Corner

5

Bottom Edge

6

Bottom Left Corner

7

Left Edge

8

Top Left Corner

Property: "Synaptics Circular Scrolling Trigger"

Option "CircularPad" "boolean"

Instead of being a rectangle, the edge is the ellipse enclosed by the Left/Right/Top/BottomEdge parameters. For circular touchpads. Property: "Synaptics Circular Pad"

Option "PalmDetect" "boolean"

If palm detection should be enabled. Note that this also requires hardware/firmware support from the touchpad. Property: "Synaptics Palm Detection"

Option "PalmMinWidth" "integer"

Minimum finger width at which touch is considered a palm. Property: "Synaptics Palm Dimensions"

Option "PalmMinZ" "integer"

Minimum finger pressure at which touch is considered a palm. Property: "Synaptics Palm Dimensions"

Option "CoastingSpeed" "float"

Your finger needs to produce this many scrolls per second in order to start coasting. The default is 20 which should prevent you from starting coasting unintentionally. 0 disables coasting. Property: "Synaptics Coasting Speed"

Option "CoastingFriction" "float"

Number of scrolls/second² to decrease the coasting speed. Default is 50. Property: "Synaptics Coasting Speed"

Option "SingleTapTimeout" "integer"

Timeout after a tap to recognize it as a single tap. Property: "Synaptics Tap Durations"

Option "GrabEventDevice" "boolean"

If GrabEventDevice is true, the driver will grab the event device for exclusive use when using the linux 2.6 event protocol. When using other protocols, this option has no effect. Grabbing the event device means that no other user space or kernel space program sees the touchpad events. This is desirable if the X config file includes /dev/input/mice as an input device, but is undesirable if you want to monitor the device from user space. When changing this parameter with the synclient program, the change will not take effect until the synaptics driver is disabled and reenabled. This can be achieved by switching to a text console and then switching back to X.

Option "TapAndDragGesture" "boolean"

Switch on/off the tap-and-drag gesture. This gesture is an alternative way of dragging. It is performed by tapping (touching and releasing the finger), then touching again and moving the finger on the touchpad. The gesture is enabled by default and can be disabled by setting the TapAndDragGesture option to false. Property: "Synaptics Gestures"

Option "VertResolution" "integer"

Resolution of X coordinates in units/millimeter. The value is used together with HorizResolution to compensate unequal vertical and horizontal sensitivity. Setting VertResolution and HorizResolution equal values means no compensation. Default value is read from the touchpad or set to 1 if value could not be read. Property: "Synaptics Pad Resolution"

Option "HorizResolution" "integer"

Resolution of Y coordinates in units/millimeter. The value is used together with VertResolution to compensate unequal vertical and horizontal sensitivity. Setting VertResolution and HorizResolution equal values means no compensation. Default value is read from the touchpad or set to 1 if value could not be read. Property: "Synaptics Pad Resolution"

Option "AreaLeftEdge" "integer"

Ignore movements, scrolling and tapping which start left of this edge. The option is disabled by default and can be enabled by setting the AreaLeftEdge option to any integer value other than zero. If supported by the server (version 1.9 and later), the edge may be specified in percent of the total width of the touchpad. Property: "Synaptics Area"

Option "AreaRightEdge" "integer"

Ignore movements, scrolling and tapping which start right of this edge. The option is disabled by default and can be enabled by setting the AreaRightEdge option to any integer value other than zero. If supported by the server (version 1.9 and later), the edge may be specified in percent of the total width of the touchpad. Property: "Synaptics Area"

Option "AreaTopEdge" "integer"

Ignore movements, scrolling and tapping which start above this edge. The option is disabled by default and can be enabled by setting the AreaTopEdge option to any integer value other than zero. If supported by the server (version 1.9 and later), the edge may be specified in percent of the total height of the touchpad. Property: "Synaptics Area"

Option "AreaBottomEdge" "integer"

Ignore movements, scrolling and tapping which start below this edge. The option is disabled by default and can be enabled by setting the AreaBottomEdge option to any integer value other than zero. If supported by the server (version 1.9 and later), the edge may be specified in percent of the total height of the touchpad. Property: "Synaptics Area"

Option "SoftButtonAreas" "RBL RBR RBT RBB MBL MBR MBT MBB"

This option is only available on ClickPad devices. Enable soft button click area support on ClickPad devices. The first four parameters are the left, right, top, bottom edge of the right button, respectively, the second four parameters are the left, right, top, bottom edge of the middle button, respectively. Any of the values may be given as percentage of the touchpad width or height, whichever applies. If any edge is set to 0 (not 0%), the button is assumed to extend to infinity in the given direction. Setting all values to 0 (not 0%) disables soft button areas. Button areas may not overlap, however it is permitted for two buttons to share an edge value. Property: "Synaptics Soft Button Areas"

Option "HasSecondarySoftButtons" "boolean"

This option is only available on ClickPad devices. Enable the secondary software button area support. The exact area must be set in option "SecondarySoftButtonAreas". See ClickPad support for more details.

Option "SecondarySoftButtonAreas" "RBL RBR RBT RBB MBL MBR MBT MBB"

This option is only available on ClickPad devices and only if Option "HasSecondarySoftButtons" is enabled. Define the secondary soft button click areas on ClickPad devices (usually on top of the device). For the allowed values for this option, see Option "SoftButtonAreas". Primary and secondary soft button areas must not overlap each other. If they do, the behavior of the driver is undefined. Property: "Synaptics Secondary Soft Button Areas". This property is only initialized if Option "HasSecondarySoftButtons" is enabled and this option is set in the xorg.conf(5).

## CONFIGURATION DETAILS

### Area handling
The LeftEdge, RightEdge, TopEdge and BottomEdge parameters are used to define the edge and corner areas of the touchpad. The parameters split the touchpad area in 9 pieces, like this:

LeftEdge

RightEdge

Physical top edge

1

2

3

TopEdge

4

5

6

BottomEdge

7

8

9

Physical bottom edge

Physical left edge

Physical right edge

Coordinates to the left of LeftEdge are part of the left edge (areas 1, 4 and 7), coordinates to the left of LeftEdge and above TopEdge (area 1) are part of the upper left corner, etc.

A good way to find appropriate edge parameters is to use evtest(1) on the device to see the x/y coordinates corresponding to different positions on the touchpad.

The perceived physical edges may be adjusted with the AreaLeftEdge, AreaRightEdge, AreaTopEdge, and AreaBottomEdge options. If these values are set to something other than the physical edges, input that starts in the space between the area edge and the respective physical edge is ignored. Note that this reduces the available space on the touchpad to start motions in.

### Tapping
A tap event happens when the finger is touched and released in a time interval shorter than MaxTapTime, and the touch and release coordinates are less than MaxTapMove units apart. A "touch" event happens when the Z value goes above FingerHigh, and an "untouch" event happens when the Z value goes below FingerLow.

The MaxDoubleTapTime parameter has the same function as the MaxTapTime parameter, but for the second, third, etc tap in a tap sequence. If you can't perform double clicks fast enough (for example, xmms depends on fast double clicks), try reducing this parameter. If you can't get word selection to work in xterm (ie button down, button up, button down, move mouse), try increasing this parameter.

The ClickTime parameter controls the delay between the button down and button up X events generated in response to a tap event. A too long value can cause undesirable autorepeat in scroll bars and a too small value means that visual feedback from the gui application you are interacting with is harder to see.

### Acceleration
The MinSpeed, MaxSpeed and AccelFactor parameters control the pointer motion speed. The speed value defines the scaling between touchpad coordinates and screen coordinates. When moving the finger very slowly, the MinSpeed value is used, when moving very fast the MaxSpeed value is used. When moving the finger at moderate speed, you get a pointer motion speed somewhere between MinSpeed and MaxSpeed. If you don't want any acceleration, set MinSpeed and MaxSpeed to the same value.

The MinSpeed, MaxSpeed and AccelFactor parameters don't have any effect on scrolling speed. Scrolling speed is determined solely from the VertScrollDelta and HorizScrollDelta parameters. To invert the direction of vertical or horizontal scrolling, set VertScrollDelta or HorizScrollDelta to a negative value.

Acceleration is mostly handled outside the driver, thus the driver will translate MinSpeed into constant deceleration and adapt MaxSpeed at startup time. This ensures you can user the other acceleration profiles, albeit without pressure motion. However the numbers at runtime will likely be different from any options you may have set.

### Pressure motion
When pressure motion is activated, the cursor motion speed depends on the pressure exerted on the touchpad (the more pressure exerted on the touchpad, the faster the pointer). More precisely the speed is first calculated according to MinSpeed, MaxSpeed and AccelFactor, and then is multiplied by a sensitivity factor.

The sensitivity factor can be adjusted using the PressureMotion parameters. If the pressure is below PressureMotionMinZ, PressureMotionMinFactor is used, and if the pressure is greater than PressureMotionMaxZ, PressureMotionMaxFactor is used. For a pressure value between PressureMotionMinZ and PressureMotionMaxZ, the factor is increased linearly.

### Middle button emulation
Since most synaptics touchpad models don't have a button that corresponds to the middle button on a mouse, the driver can emulate middle mouse button events. If you press both the left and right mouse buttons at almost the same time (no more than EmulateMidButtonTime milliseconds apart) the driver generates a middle mouse button event.

### Circular scrolling
Circular scrolling acts like a scrolling wheel on the touchpad. Scrolling is engaged when a drag starts in the given CircScrollTrigger region, which can be all edges, a particular side, or a particular corner. Once scrolling is engaged, moving your finger in clockwise circles around the center of the touchpad will generate scroll down events and counter clockwise motion will generate scroll up events. Lifting your finger will disengage circular scrolling. Use tight circles near the center of the pad for fast scrolling and large circles for better control. When used together with vertical scrolling, hitting the upper or lower right corner will seamlessly switch over from vertical to circular scrolling.

### Coasting
Coasting is enabled by setting the CoastingSpeed parameter to a non-zero value. Coasting comes in two flavors: conventional (finger off) coasting, and corner (finger on) coasting.

Conventional coasting is enabled when coasting is enabled, and CornerCoasting is set to false. When conventional coasting is enabled, horizontal/vertical scrolling can continue after the finger is released from the lower/right edge of the touchpad. The driver computes the scrolling speed corresponding to the finger speed immediately before the finger leaves the touchpad. If this scrolling speed is larger than the CoastingSpeed parameter (measured in scroll events per second), the scrolling will continue with the same speed in the same direction until the finger touches the touchpad again.

Corner coasting is enabled when coasting is enabled, and CornerCoasting is set to true. When corner coasting is enabled, edge scrolling can continue as long as the finger stays in a corner. Coasting begins when the finger enters the corner, and continues until the finger leaves the corner. CornerCoasting takes precedence over the seamless switch from edge scrolling to circular scrolling. That is, if CornerCoasting is active, scrolling will stop, and circular scrolling will not start, when the finger leaves the corner.

### Noise cancellation
The synaptics has a built-in noise cancellation based on hysteresis. This means that incoming coordinates actually shift a box of predefined dimensions such that it covers the incoming coordinate, and only the boxes own center is used as input. Obviously, the smaller the box the better, but the likelyhood of noise motion coming through also increases.

### ClickPad support
A click pad device has button(s) integrated into the touchpad surface. The user must press downward on the touchpad in order to generated a button press. ClickPad support is enabled if the option ClickPad is set or the property is set at runtime. On some platforms, this option will be set automatically if the kernel detects a matching device. On Linux, the device must have the INPUT_PROP_BUTTONPAD property set.

ClickPads do not support middle mouse button emulation. If enabling ClickPad support at runime, the user must also set the middle mouse button timeout to 0. If auto-detected, middle mouse button emulation is disabled by the driver.

ClickPads provide software emulated buttons through Option "SoftButtonAreas". These buttons enable areas on the touchpad to perform as right or middle mouse button. When the user performs a click within a defined soft button area, a right or middle click is performed.

Some laptops, most notably the Lenovo T440, T540 and x240 series, provide a pointing stick without physical buttons. On those laptops, the top of the touchpad acts as software-emulated button area. This area can be enabled with Option "HasSecondarySoftButtons" and configured with Option "SecondarySoftButtonAreas". On some platforms, this option will be set automatically if the kernel detects a matching device. On Linux, the device must have the INPUT_PROP_TOPBUTTONPAD property set.

## DEVICE PROPERTIES
Synaptics 1.0 and higher support input device properties if the driver is running on X server 1.6 or higher. The synclient tool shipped with synaptics version 1.1 uses input device properties by default. Properties supported:

Synaptics Edges

32 bit, 4 values, left, right, top, bottom.

Synaptics Finger

32 bit, 3 values, low, high, press.

Synaptics Tap Time

32 bit.

Synaptics Tap Move

32 bit.

Synaptics Tap Durations

32 bit, 3 values, single touch timeout, max tapping time for double taps, duration of a single click.

Synaptics ClickPad

8 bit (Bool).

Synaptics Middle Button Timeout

32 bit.

Synaptics Two-Finger Pressure

32 bit.

Synaptics Two-Finger Width

32 bit.

Synaptics Scrolling Distance

32 bit, 2 values, vert, horiz.

Synaptics Edge Scrolling

8 bit (BOOL), 3 values, vertical, horizontal, corner.

Synaptics Two-Finger Scrolling

8 bit (BOOL), 2 values, vertical, horizontal.

Synaptics Move Speed

FLOAT, 4 values, min, max, accel, <deprecated>

Synaptics Button Scrolling

8 bit (BOOL), 2 values, updown, leftright.

Synaptics Button Scrolling Repeat

8 bit (BOOL), 2 values, updown, leftright.

Synaptics Button Scrolling Time

32 bit.

Synaptics Off

8 bit, valid values (0, 1, 2).

Synaptics Locked Drags

8 bit (BOOL).

Synaptics Locked Drags Timeout

32 bit.

Synaptics Tap Action

8 bit, up to MAX_TAP values (see synaptics.h), 0 disables an element. order: RT, RB, LT, LB, F1, F2, F3.

Synaptics Click Action

8 bit, up to MAX_CLICK values (see synaptics.h), 0 disables an element. order: Finger 1, 2, 3.

Synaptics Circular Scrolling

8 bit (BOOL).

Synaptics Circular Scrolling Distance

FLOAT.

Synaptics Circular Scrolling Trigger

8 bit, valid values 0..8 (inclusive) order: any edge, top, top + right, right, right + bottom, bottom, bottom + left, left, left + top.

Synaptics Circular Pad

8 bit (BOOL).

Synaptics Palm Detection

8 bit (BOOL).

Synaptics Palm Dimensions

32 bit, 2 values, width, z.

Synaptics Coasting Speed

FLOAT, 2 values, speed, friction.

Synaptics Pressure Motion

32 bit, 2 values, min, max.

Synaptics Pressure Motion Factor

FLOAT, 2 values, min, max.

Synaptics Grab Event Device

8 bit (BOOL).

Synaptics Gestures

8 bit (BOOL), 1 value, tap-and-drag.

Synaptics Area

The AreaLeftEdge, AreaRightEdge, AreaTopEdge and AreaBottomEdge parameters are used to define the edges of the active area of the touchpad. All movements, scrolling and tapping which take place outside of this area will be ignored. This property is disabled by default. 32 bit, 4 values, left, right, top, bottom. 0 disables an element.

Synaptics Soft Button Areas

This property is only available on ClickPad devices. The Right and middle soft button areas are used to support right and middle click actions on a ClickPad device. Providing 0 for all values of a given button disables the button area. 32 bit, 8 values, RBL, RBR, RBT, RBB, MBL, MBR, MBT, MBB.

Synaptics Capabilities

This read-only property expresses the physical capability of the touchpad, most notably whether the touchpad hardware supports multi-finger tapping and scrolling. 8 bit (BOOL), 7 values (read-only), has left button, has middle button, has right button, two-finger detection, three-finger detection, pressure detection, and finger/palm width detection.

Synaptics Pad Resolution

32 bit unsigned, 2 values (read-only), vertical, horizontal in units/millimeter.

## NOTES
Configuration through InputClass sections is recommended in X servers 1.8 and later. See xorg.conf.d(5) for more details. An example xorg.conf.d snippet is provided in ${sourcecode}/conf/70-synaptics.conf

Configuration through hal fdi files is recommended in X servers 1.5, 1.6 and 1.7. An example hal policy file is provided in ${sourcecode}/conf/11-x11-synaptics.fdi

If either of Protocol "auto-dev" (default) or Protocol "event" is used, the driver initializes defaults based on the capabilities reported by the kernel driver. Acceleration, edges and resolution are based on the dimensions reported by the kernel. If the kernel reports multi-finger detection, two-finger vertical scrolling is enabled, horizontal two-finger scrolling is disabled and edge scrolling is disabled. If no multi-finger capabilities are reported, edge scrolling is enabled for both horizontal and vertical scrolling. Tapping is disabled by default for touchpads with one or more physical buttons. To enable it you need to map tap actions to buttons. See the "TapButton1", "TapButton2" and "TapButton3" options.

Button mapping for physical buttons is handled in the server. If the device is switched to left-handed (an in-server mapping of physical buttons 1, 2, 3 to the logical buttons 3, 2, 1, respectively), both physical and TapButtons are affected. To counteract this, the TapButtons need to be set up in reverse order (TapButton1=3, TapButton2=1).

## REMOVED OPTIONS
The following options are no longer part of the driver configuration:

Option "Repeater" "string"

Option "HistorySize" "integer"

Option "SpecialScrollAreaRight" "boolean"

Option "GuestMouseOff" "boolean"

Option "SHMConfig" "boolean"

Option "FingerPress" "integer"

Option "TrackstickSpeed" "float"

Option "EdgeMotionMinZ" "integer"

Option "EdgeMotionMaxZ" "integer"

Option "EdgeMotionMinSpeed" "integer"

Option "EdgeMotionMaxSpeed" "integer"

Option "EdgeMotionUseAlways" "boolean"

## AUTHORS
Peter Osterlund <petero2@telia.com> and many others.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7), synclient(1), syndaemon(1)


vboxvideo

package: xorg-drv-vboxvideo

title: vboxvideo(4)

summary: VirtualBox video driver

text:
# vboxvideo(4)

## NAME
vboxvideo - VirtualBox video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "vboxvideo"
  ...
EndSection
```

## DESCRIPTION
vboxvideo is an Xorg driver for the VirtualBox virtual video card.

## SUPPORTED HARDWARE
The vboxvideo driver supports the VirtualBox virtual video card.

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)

## AUTHORS
Authors include: Paulo Ce´sar Pereira de Andrade, Michael Thayer.


vesa

package: xorg-drv-vesa

title: vesa(4)

summary: Generic VESA video driver

text:
# vesa(4)

## NAME
vesa - Generic VESA video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "vesa"
  ...
EndSection
```

## DESCRIPTION
vesa is an Xorg driver for generic VESA video cards. It can drive most VESA-compatible video cards, but only makes use of the basic standard VESA core that is common to these cards. The driver supports depths 8, 15 16 and 24.

## SUPPORTED HARDWARE
The vesa driver supports most VESA-compatible video cards. There are some known exceptions, and those should be listed here.

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details. This section only covers configuration details specific to this driver.

The driver auto-detects the presence of VESA-compatible hardware. The ChipSet name may optionally be specified in the config file "Device" section, and will override the auto-detection:

"vesa"

The following driver Options are supported:

Option "ShadowFB" "boolean"

Enable or disable use of the shadow framebuffer layer. Default: on. This option is recommended for performance reasons.

Option "ModeSetClearScreen" "boolean"

Clear the screen on mode set. Some BIOSes seem to be broken in the sense that the newly set video mode is bogus if they are asked to clear the screen during mode setting. If you experience problems try to turn this option off. Default: on.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7)

## AUTHORS
Authors include: Paulo Ce´sar Pereira de Andrade.


vmmouse

package: xorg-drv-vmmouse

title: vmmouse(4)

summary: VMware Mouse input driver

text:
# vmmouse(4)

## NAME
vmmouse - VMware Mouse input driver

## SYNOPSIS

```
Section "InputDevice"
  Identifier "idevname"
  Driver "vmmouse"
  ...
EndSection
```

## DESCRIPTION
vmmouse is an XFree86 input driver for mice. The driver supports most available mouse types and interfaces. USB mice are only supported on some OSs, and the level of support for PS/2 mice depends on the OS.

The vmmouse driver functions as a pointer input device, and may be used as the X server's core pointer. Multiple mice are supported by multiple instances of this driver.

## 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.

The driver will automatically detect if the vmmouse device is present and if it is not, it will load the regular mouse driver and attempt to fall back to it. There are no vmmouse specific options, but if you set mouse(4) options, they will be passed on.

See the mouse(4) man page for details on these options.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7), mouse(4)

## AUTHORS
Copyright (c) 1999-2007 VMware, Inc.


vmware

package: xorg-drv-vmware

title: vmware(4)

summary: VMware SVGA video driver

text:
# vmware(4)

## NAME
vmware - VMware SVGA video driver

## SYNOPSIS

```
Section "Device"
  Identifier "devname"
  Driver "vmware"
  ...
EndSection
```

## DESCRIPTION
vmware is an Xorg driver for VMware virtual video cards.

## MODESETTING, XINERAMA AND RANDR12
If the driver can connect to the "vmwgfx" kernel module on linux, it will attempt to use kernel modesetting and will then also use RandR12 for multiple output operation instead of Xinerama. The X server log or the "xrandr" application can be used to determine whether RandR12 or Xinerama is actually used.

## 3D ACCELERATION
If the driver can connect to the "vmwgfx" kernel module on linux, and the Virtual Machine is set up to use 3D acceleration, the driver will try to use Gallium3D XA to accelerate 3D operations. It will also by default enable DRI, the Direct Rendering Infrastructure, primarily for accelerated OpenGL. If 3D acceleration is available, the driver will in addition provide an additional XVideo adaptor for textured video. Gallium3D XA, "libxatracker.so" and the accelerated OpenGL driver, "vmwgfx_dri.so" is provided by the mesa distribution.

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details. This section only covers configuration details specific to this driver.

The driver auto-detects the version of any virtual VMware SVGA adapter.

The following driver Options are supported:

Option "HWCursor" "boolean"

Enable or disable the HW cursor. Default: off.

Option "Xinerama" "boolean"

Disable or enable Xinerama support. Default: xinerama is enabled if the hardware supports it.

Option "StaticXinerama" "string"

Provide a static xinerama geometry that will be active at server startup and will not be overridden at runtime. The format is "Width1xHeight1+Xoffset1+Yoffset1;Width2xHeight2+Xoffset2+Yoffset2" and so on. Negative offsets are not supported. If the driver is using RandR12, this option should be used to place and enable outputs at driver startup time or else when VMware tools is not used for that purpose. Also please see option "GuiLayout".

Option "GuiLayout" "string"

A synonym to option "StaticXinerama", since the latter name is somewhat misleading when RandR12 is favoured before Xinerarma.

Option "AddDefaultMode" "boolean"

Provide a default mode with a resolution identical to the resolution of the guest before the X server was started. The X server will thus try to start without changing resolution. Default: on.

Option "RenderAccel" "boolean"

Try to accelerate render operations if the operations are reading from previously accelerated contents (3D or video). This option is needed for 3D support. Default: on if 3D acceleration is supported. Otherwise off.

Option "DRI" "boolean"

Enable the Direct Rendering Infrastructure. Default: on if 3D acceleration is supported and "RenderAccel" is enabled. Otherwise off.

Option "DirectPresents" "boolean"

Speed up OpenGL swapbuffers by skipping a copy operation. This provides some OpenGL swapbuffer speedups, but may cause performance degradation and rendering errors when 3D contents is read back for mixing with software rendered contents. Default: off.

Option "HwPresents" "boolean"

This is a developer convenience option and should not be used by distros or normal users. When enabled, it copies software rendered contents to a 3D surface before presenting it, so that the visible screen is always present on a 3D surface. Default: off.

Option "RenderCheck" "boolean"

This is a developer convenience option and should not be used by distros or normal users. When enabled, it tries to use 3D acceleration for all XRender operations where 3D acceleration is supported, resulting in a considerable slowdown due to the increased number of readbacks of accelerated contents from host to guest. This option is used to verify that the accelerated Xrender paths works correctly with the "rendercheck" application. Default: off.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7), xrandr(1)

## AUTHORS
Copyright (c) 1999-2007 VMware, Inc.


void

package: xorg-drv-void

title: void(4)

summary: null input driver

text:
# void(4)

## NAME
void - null input driver

## SYNOPSIS

```
Section "InputDevice"
  Identifier "idevname"
  Driver "void"
  ...
EndSection
```

## DESCRIPTION
void is an dummy/null Xorg input driver. It doesn't connect to any physical device, and it never delivers any events. It functions as both a pointer and keyboard device, and may be used as X server's core pointer and/or core keyboard. It's purpose is to allow X servers pre version 1.4 to operate without a core pointer and/or core keyboard.

## CONFIGURATION DETAILS
Please refer to xorg.conf(5) for general configuration details and for options that can be used with all input drivers. This driver doesn't have any configuration options in addition to those.

## SEE ALSO
Xorg(1), xorg.conf(5), Xserver(1), X(7).


wacom

package: xorg-drv-wacom

title: wacom(4)

summary: Wacom input driver

text:
# wacom(4)

## NAME
wacom - Wacom input driver

## SYNOPSIS

```
Section "InputDevice"
  Identifier "idevname"
  Driver "wacom"
  Option "Device"   "devpath"
  ...
EndSection
```

## DESCRIPTION
wacom is an X input driver for Wacom devices.

The wacom driver functions as a pointer input device.

## SUPPORTED HARDWARE
This driver supports the Wacom IV and Wacom V protocols. Serial tablets only need this driver. USB tablet support is available on some Linux platforms and requires the wacom kernel driver being loaded before this driver starts.

Please check http://linuxwacom.sourceforge.net for latest updates of Wacom X and kernel drivers.

## DRIVER-INTERNAL DEVICE HOTPLUGGING
When input device hotplugging in the X server is enabled and no InputDevice section exists for a compatible tablet device and an InputClass section (see xorg.conf.d(5x)) assigns this driver for the device, the wacom driver creates multiple X devices for each a physical device, one X device for each available tool. The list of tools is hardware-dependent. See Option Type as outlined in the CONFIGURATION DETAILS section.

These tool-specific devices are referred to as parent device and dependent device. The parent device is the one presented by the system and the one that causes the X server to load the wacom driver. This parent device then causes the automatic addition of several dependent devices. If the parent device is unplugged or otherwise removed, the dependent devices will be automatically removed as well.

Dependent devices may be assigned tool-specific options through additional InputClass sections. We recommend that a MatchDriver wacom line is used in these sections in addition to the user-specific pattern.

Match directives are applied by the X server before the driver is selected. The type name of the parent device is appended by the driver. It is not possible to use a MatchProduct directive to match against this appended type name.

## CONFIGURATION DETAILS
Please refer to xorg.conf(5x) or xorg.conf.d(5x) 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 Wacom devices can cohabit. Each device supports the following entries:

Option "Type" "stylus"|"eraser"|"cursor"|"pad"|"touch"

sets the type of tool the device represents. This option is mandatory. The core options, such as "SendCoreEvents" or "AlwaysCore", are unnecessary in Gimp if you don't need to move system cursor outside of Gimp drawing area. "pad" is for Intuos 3 or Cintiq 21UX tablet ExpressKeys/menu strips, and Graphire 4 or Bamboo tablet buttons, wheel, and/or ring. It is required for Intuos3, CintiqV5, Graphire 4, and Bamboo if you want to use keystroke features. "pad" is reported as a second tool in the driver. "touch" is for the tablet with touch support. Right now only a few Tablet PCs have this feature.

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 "Suppress" "number"

sets the position increment under which not to transmit coordinates. This entry must be specified only in the first Wacom subsection if you have multiple devices for one tablet. If you don't specify this entry, the default value, which is 2, will be used. To disable suppression, the entry should be specified as 0. When suppress is defined, an event will be sent only when at least one of the following conditions is met:

the change between the current X coordinate and the previous one is greater than suppress;

the change between the current Y coordinate and the previous one is greater than suppress;

the change between the current pressure and the previous one is greater than suppress;

the change between the current degree of rotation and the previous one of the transducer is greater than suppress;

the change between the current absolute wheel value and the previous one is equal to or greater than suppress;

the change between the current tilt value and the previous one is equal to or greater than suppress (if tilt is supported);

relative wheel value has changed;

button value has changed;

proximity has changed.

Option "Mode" "Relative"|"Absolute"

sets the mode of the device. The default value for stylus, pad and eraser is Absolute; cursor is Relative; touch defaults to Relative for tablets with touch pads and Absolute for touch screens.

Option "TopX" "number"

X coordinate of the top corner of the active zone. Default to 0.

Option "TopY" "number"

Y coordinate of the top corner of the active zone. Default to 0.

Option "BottomX" "number"

X coordinate of the bottom corner of the active zone. Default to width of the tablet.

Option "BottomY" "number"

Y coordinate of the bottom corner of the active zone. Default to height of the tablet.

Option "ButtonsOnly" "on"|"off"

disables the device's motion events. Default to off.

Option "ButtonM" "AC"

reports an action AC when button M is pressed, where M is one of the device supported button numbers, it can be 1 to 32. Wacom uses a driver-internal button mapping, where any physical button appears to the X server as the button specified by the ButtonM mapping. Hence, if two physical buttons have the same ButtonM mapping, the server will think they are the same physical button. The default action reported to the X server is mouse button M click. Because X uses buttons 4, 5, 6, and 7 as the four scrolling directions, physical buttons 4 and higher are mapped to 8 and higher by default. Only simple button presses can be configured here; for more complex actions, use xsetwacom(1). To ignore the button click, i.e., to not report any button click event to the X server, use "0" or "button 0".

Option "TPCButton" "on"|"off"

enables the stylus buttons as Tablet PC buttons. If enabled, the stylus reports button events only when its tip is pressed. If any button is down, pressing the tip reports a button event for the button. Otherwise if no button is down, the tip reports as usual. Default to "on" for Tablet PCs; "off" for all other models. Only available on the stylus tool.

Option "Touch" "on"|"off"

enables touch events for touch devices, i.e., system cursor moves when user touches the tablet. Default to "on" for devices that support touch; "off" for all other models.

Option "Rotate" "CW"|"CCW"|"HALF"|"NONE"

rotates the tablet orientation counterclockwise (CCW) or clockwise (CW) or 180 degrees (HALF). If you have specific tablet mappings, i.e. TopX/Y or BottomX/Y were set, the mapping will be applied before rotation. Rotation must be applied to the parent device (usually the stylus), rotation settings on in-driver hotplugged devices (see DRIVER-INTERNAL DEVICE HOTPLUGGING ) will be ignored. The default is "NONE".

Option "PressCurve" "x1,y1,x2,y2"

sets pressure curve by control points x1, y1, x2, and y2. Their values are in range from 0..100. The pressure curve is interpreted as Bezier curve with 4 control points, the first and the last control point being fixed on the coordinates 0/0 and 100/100, respectively. The middle control points are adjustible by this setting and thus define the shape of the curve. The input for linear curve (default) is "0,0,100,100"; slightly depressed curve (firmer) might be "5,0,100,95"; slightly raised curve (softer) might be "0,5,95,100". The pressure curve is only applicable to devices of type stylus or eraser, other devices do not honor this setting.

Option "Pressure2K" "bool"

reduces the pressure range to the range of 0 to 2048 for backwards compatibility with applications that have this range hardcoded. See section BUGS. This option should not be used unless the user runs one or more applications that rely on a hardcoded pressure range.

Option "DebugLevel" "number"

sets the level of debugging info for tool-specific messages. There are 12 levels, specified by the integers between 1 and 12. All debug messages with a level less than or equal to the "number" will be logged into the Xorg log file. This option is only available if the driver was built with debugging support.

Option "CommonDBG" "number"

sets the level of debugging info for common (i.e. not tool-specific) code paths on the tablet. There are 12 levels, specified by the integers between 1 and 12. All debug messages with a level less than or equal to the "number" will be logged into the Xorg log file. This option is only available if the driver was built with debugging support.

Option "GrabDevice" "bool"

sets whether the underlying event device will be grabbed by the driver to prevent the data from leaking to /dev/input/mice. When enabled, while the X server is running, no other programs will be able to read the event stream. Default: "false".

Option "CursorProx" "number"

sets the max distance from tablet to stop reporting movement for the cursor. Default for Intuos series is 10, for Graphire series (including Volitos) is 42. Only available for the cursor/puck device.

Option "RawSample" "number"

Set the sample window size (a sliding average sampling window) for incoming input tool raw data points. Default: 4, range of 1 to 20.

Option "Serial" "number"

sets the serial number associated with the physical device. This allows to have multiple devices of the same type (i.e. multiple pens). This option is only available on wacom V devices (Intuos series and Cintiq 21U). To see which serial number belongs to a device, you need to run the utility program, xsetwacom, which comes with linuxwacom package.

Option "ToolSerials" "number[,type[,label]][;...]"

sets the list of serial numbered devices that need to be hotplugged for a physical device. The 'type' option may be any of "pen", "airbrush", "artpen", or "cursor". This option is only available on wacom V devices (Intuos series and Cintiq 21U). To see which serial number belongs to a device, you need to run the utility program, xsetwacom, that comes with this driver.

Option "Threshold" "number"

sets the pressure threshold used to generate a button 1 events of stylus. The threshold applies to the normalised pressure range of [0..2048]. The default is 27.

Option "Gesture" "bool"

Enable or disable multi-finger in-driver gesture support on the device. Default: off unless the tablet supports multi-touch. Note that disabling this option may allow the desktop environment to detect multi-finger gestures instead.

Option "ZoomDistance" "number"

If Option "Gesture" is enabled, this option specifies the minimum movement distance before a zoom gesture is recognized.

Option "ScrollDistance" "number"

If Option "Gesture" is enabled, this option specifies the minimum movement distance before a scroll gesture is recognized.

Option "TapTime" "number"

If Option "Gesture" is enabled, this option determines the maximum time of a touch event to be recognized as tap. A press and release event shorter than TapTime generates button press and release events. Presses longer than TapTime do not generate button events, only motion events.

Option "PressureRecalibration" "bool"

Allows to disable pressure recalibration. Default: true. If the initial pressure of a device is != 0 the driver recalibrates the pressure range. This is to account for worn out devices. The downside is that when the user hits the tablet very hard the initial pressure reading may be unequal to zero even for a perfectly good pen. If the consecutive pressure readings are not higher than the initial pressure by a threshold no button event will be generated. This option allows to disable the recalibration.

Option "PanScrollThreshold" "number"

Specifies the distance the pen must move (in tablet units) before a scroll event is generated when using the "pan" action. Smaller values will require less distance and be more sensitive. Larger values will require more distance and be less sensitive. Default: 1300 or 2600 depending on tablet resolution (corresponds to 13 mm of distance).

## TOUCH GESTURES

### Single finger (1FG)
Left click: tap, actual click happens after TapTime period elapses.

Left click drag: tap to select, quickly (within TapTime period) touch selection again. Then drag. Available on touchpads, e.g. BambooPT, not touchscreens.

### Two finger (2FG)
Right click: one finger down + tap second finger

Vertical scroll: two fingers side by side (in any orientation) moving vertically with constant separation initiates a vertical scroll. By driver default a gesture up results in a scroll down event (the document moves up) and a gesture down results in a scroll up event (moving the document down).

Horizontal scroll: two fingers side by side held at a constant distance moving horizontally initiates a horizontal scroll. A gesture to the left results in a scroll right event (the document moves left) and a gesture right results in a scroll left event (moving the document right).

Zoom in: two separated fingers side by side, bring together i.e. pinch.

Zoom out: two fingers side by side, spread. Not all applications support zoom.

## BUGS

### Pressure range increase leads to unexpected behavior
In version 0.34, the driver's pressure range increased from 2048 steps to 65536 steps. The pressure axis range is advertised through the X Input Protocol but some applications have the previous pressure range hardcoded and cannot handle pressure values above 2048. This is an application bug but for backwards-compatibility with such applications, this driver provides the Pressure2K option to reduce the range to 2048 steps. Note that this setting applies to the device. Once applied, all applications will see the reduced pressure range. It is not possible to provide this setting on a per-application basis.

## SEE ALSO
Xorg(1), xorg.conf(5), xorg.conf.d(5), X(7)

More information is available at http://linuxwacom.sourceforge.net

## AUTHORS
Peter Hutterer <peter.hutterer@who-t.net>, Ping Cheng <pingc@wacom.com>, Frederic Lepied <lepied@xfree86.org>, John E. Joganic <jej@j-arkadia.com>, Magnus Vigerlöf <Magnus.Vigerlof@ipbo.se>


exa

package: xorg-server

title: exa(4)

text:
# exa(4)

## NAME
exa - new 2D acceleration architecture for X.Org

## DESCRIPTION
EXA provides a simple API for video drivers to implement for 2D acceleration. It is a module loaded by drivers, and is not intended to be loaded on its own. See your driver's manual page for how to enable EXA.

The EXA architecture is designed to make accelerating the Render extension simple and efficient, and results in various performance tradeoffs compared to XAA. Some xorg.conf options are available for debugging performance issues or driver rendering problems. They are not intended for general use.

Option "EXANoComposite" "boolean"

Disables acceleration of the Composite operation, which is at the heart of the Render extension. Not related to the Composite extension. Default: No.

Option "EXANoUploadToScreen" "boolean"

Disables acceleration of uploading pixmap data to the framebuffer. Default: No.

Option "EXANoDownloadFromScreen" "boolean"

Disables acceleration of downloading of pixmap data from the framebuffer. NOTE: Not usable with drivers which rely on DownloadFromScreen succeeding. Default: No.

Option "MigrationHeuristic" "anystr"

Chooses an alternate pixmap migration heuristic, for debugging purposes. The default is intended to be the best performing one for general use, though others may help with specific use cases. Available options include "always", "greedy", and "smart". Default: always.

## SEE ALSO
Xorg(1), xorg.conf(5).

## AUTHORS
Authors include: Keith Packard, Eric Anholt, Zack Rusin, and Michel Dänzer


fbdevhw

title: fbdevhw(4)

text:
# fbdevhw(4)

## NAME
fbdevhw - os-specific submodule for framebuffer device access

## DESCRIPTION
fbdevhw provides functions for talking to a framebuffer device. It is os-specific. It is a submodule used by other video drivers. A fbdevhw module is currently available for linux framebuffer devices.

fbdev(4) is a non-accelerated driver which runs on top of the fbdevhw module. fbdevhw can be used by other drivers too, this is usually activated with `Option "UseFBDev"' in the device section.

## SEE ALSO
Xorg(1), xorg.conf(5), xorgconfig(1), Xserver(1), X(7), fbdev(4)

## AUTHORS
Authors include: Gerd Knorr, based on the XF68_FBDev Server code (Martin Schaller, Geert Uytterhoeven).