Updated manpage to reflect current state

Large parts of the manpage were obsolete and confused users. Current state should reflect all available driver options. Some details are still missing.

1 files changed, 73 insertions, 194 deletions

diff --git a/man/evdev.man b/man/evdev.man
index 2a11945..72d780b 100644
--- a/man/evdev.man
+++ b/man/evdev.man
@@ -22,9 +22,7 @@ The
 .B evdev
 driver can serve as both a pointer and a keyboard input device, and may be
 used as both the core keyboard and the core pointer.  Multiple input devices
-are supported by multiple instances of this driver, with one Load
-directive for evdev in the Module section of your __xconfigfile__ for each
-input device that will use this driver.
+are supported by multiple instances of this driver.
 .PP
 .SH SUPPORTED HARDWARE
 In general, any input device that the kernel has a driver for can be accessed
@@ -39,186 +37,35 @@ section only covers configuration details specific to this driver.
 .PP
 .SH BASIC CONFIGURATIONS
 Most users of this driver will probably be quite happy with the following for
-all QWERTY keyboards:
+all keyboards and mice:
 .PP
 .nf
 .B "Section \*qInputDevice\*q"
 .BI "  Identifier \*q" keyboard \*q
 .B  "  Driver \*qevdev\*q"
-.BI  "  Option \*qevBits\*q  \*q" "+1" \*q
-.BI  "  Option \*qkeyBits\*q \*q" "~1\-255 ~352\-511" \*q
-.BI  "  Option \*qPass\*q    \*q" "3" \*q
+.BI  "  Option \*qDevice\*q  \*q" "/dev/input/by-path/..." \*q
 \ \ ...
 .B EndSection
 .fi
 .PP
-And the following for all mice:
-.PP
-.nf
-.B "Section \*qInputDevice\*q"
-.BI "  Identifier \*q" mouse \*q
-.B  "  Driver \*qevdev\*q"
-.BI  "  Option \*qevBits\*q  \*q" "+1\-2" \*q
-.BI  "  Option \*qkeyBits\*q \*q" "~272\-287" \*q
-.BI  "  Option \*qrelBits\*q \*q" "~0\-2 ~6 ~8" \*q
-.BI  "  Option \*qPass\*q    \*q" "3" \*q
-\ \ ...
-.B EndSection
-.fi
-.PP
-To understand what those Bits options do, or for more complex
-configurations, please see
-.BR "ADVANCED OPTIONS"
-below.
-.PP
 .SH ADVANCED OPTIONS
 .SS DEVICE SPECIFICATION
-For this section you'll want to have knowledge of
-.B glob (7)
-and our evil
-.B "BIT MATCHING SPECIFICATION"
-stuff.
-.PP
-The following driver 
-.B Options
-control what devices are accepted:
-
 .TP 7
-.BI "Option \*qDevice\*q \*q" string \*q
-Specifies the device note through which the device can be accessed.
-At this time ONLY
-.RI /dev/input/event n ,
-where
-.I n
-is an integer, are matched against this this field.
-.fi
-This option uses globbing.
-.fi
-Please note that use of this option is strongly discouraged.
-
+.BI "Option \*qPath\*q \*q" string \*q
 .TP 7
-.BI "Option \*qName\*q \*q" string \*q
-Specifies the device name for the device you wish to use.
-.fi
-The device name is generally the only consistent identifier for devices 
-that are commonly unplugged and plugged back into different ports.
-.fi
-A list of currently plugged in devices and associated device names can be 
-obtained by typing \*qcat /proc/bus/input/devices\*q, the \*qName\*q field 
-is the value you want for this option.
-.fi
-This option uses globbing.
-
-.TP 7
-.BI "Option \*qPhys\*q \*q" string \*q
-Specifies the device phys string for the device you wish to use.
-.fi
-The phys string is generally consistent to the USB port a device is plugged 
-into.
-.fi
-A list of currently plugged in devices and associated device names can be 
-obtained by typing \*qcat /proc/bus/input/devices\*q, the \*qPhys\*q field 
-is the value you want for this option.
-.fi
-This option uses globbing.
-
-.TP 7
-.BI "Option \*q" map "Bits\*q \*q" "bit specifier" \*q
-Specifies device capability bits which must be set, possibly set, or unset.
-.fi
-.IR map "Bits: Where " map
-is one of
-.BR ev ", " key ", " rel ", " abs ,
-.BR msc ", " led ", " snd ", or " ff .
-.fi
-The bit specifier format is a string consisting of
-.RI + n ", \-" n ", and ~" n
-space-separated specifiers, where
-.I n
-is a positive integer or integer range.  (The latter given in the format of 2\-6.)
-.fi
-+ specifies bits which must be set.
-.fi
-\- specifies bits which must not be set.
-.fi
-~ is a little more complex, it specifies that at least one of the bits given
-with ~ for the field in question must be set, but it doesn't matter how many
-or which of the bits. (It is actually the most useful of the 3 specifiers.)
-.fi
-As an example, \*q+0 +3 \-1\-2 ~5\-10\*q requires bits 0 and 3 be set,
-bits 1 and 2 to not be set, and at least one bit in the range of 5 to
-10 be set.
-.fi
-An annoyingly formatted set of bitmasks for your devices can be obtained
-by typing \*qcat /proc/bus/input/devices\*q, and
-.B /usr/include/linux/input.h
-should contain the defines which declare what bits are what for each field.
-
-.TP 7
-.BI "Option \*qbustype\*q \*q" n \*q
-Specifies the bus ID for the device you wish to use.
-.fi
-This is either 0 (the default, matches anything), or the
-.BI Bus= n
-field in
-.B /proc/bus/input/devices
-for your device.
-.fi
-This value depends on what type of bus your device is connected to.
-
-.TP 7
-.BI "Option \*qvendor\*q \*q" n \*q
-Specifies the vendor ID for the device you wish to use.
-.fi
-This is either 0 (the default, matches anything), or the
-.BI Vendor= n
-field in
-.B /proc/bus/input/devices
-for your device.
-.fi
-This value should remain constant barring perhaps firmware updates to the
-device itself.
-
-.TP 7
-.BI "Option \*qversion\*q \*q" n \*q
-Specifies the version for the device you wish to use.
-.fi
-This is either 0 (the default, matches anything), or the
-.BI Version= n
-field in
-.B /proc/bus/input/devices
-for your device.
-.fi
-This value should remain constant barring perhaps firmware updates to the
-device itself.
-
-.TP 7
-.BI "Option \*qproduct\*q \*q" n \*q
-Specifies the product ID for the device you wish to use.
-.fi
-This is either 0 (the default, matches anything), or the
-.BI Product= n
-field in
-.B /proc/bus/input/devices
-for your device.
+.BI "Option \*qDevice\*q \*q" string \*q
+Specifies the device node through which the device can be accessed.
+You might want to use the more persistent symlinks provided in /dev/input/by-id
+or /dev/input/by-path.
 .fi
-This value should remain constant barring perhaps firmware updates to the
-device itself.
-
+This parameter is mandatory.
 .TP 7
-.BI "Option \*qPass\*q \*q" n \*q
-Specifies the order in which evdev will scan for devices.
-.fi
-This is in the range of 0 to 3, and is used for the case
-where more then one evdev input section matches the same device.
+.BI "Option \*qMode\*q \*q" mode \*q
+This selects the default mode for the device.
 .fi
-An input section with a lower pass number will always beat out
-one with a higher pass number.  Order when both sections are
-the same number is undefined.
+Valid values are \*qabsolute\*q and \*qrelative\*q.
 .fi
-The default is 0.
-
-
+This can be set at run time per actual device with the xinput utility.
 .PP
 .SS RELATIVE AXIS CONFIGURATION
 The relative axis portion of this driver handle all reported relative axes.
@@ -238,20 +85,25 @@ The following driver
 .B Options
 control the relative axis portion of the driver:
 .TP 7
-.BI "Option \*q" axis "RelativeAxisMap\*q \*q" n \*q
-This remaps the axis specified to the specified valuator.
-.TP 7
-.BI "Option \*q" axis "RelativeAxisButtons\*q \*q" "n n" \*q
-This remaps the axis specified to the specified buttons.
-.fi
-Note that the physical buttons are always remapped around \*qfake\*q buttons
-created by this option, so that if you have physical buttons 1 2 3 4 5,
-and map the Wheel axis to buttons 4 5, you get buttons 1 2 3
-.B 4 5
-6 7, with buttons 6 and 7 being physical buttons 4 and 5.
+.BI "Option \*qRel" "%s" "MapTo\*q \*q" string \*q
+This remaps the axis specified by
+.I "%s"
+to
+.IR string .
+See Section
+.B "AXIS MAPPING"
+for valid values.
+.TP 7
+.BI "Option \*qRel" "%s" "Options\*q \*q" "string" \*q
+This sets some options for the relative axis specified by
+.IR %s .
+Valid value
+is \*qinvert\*q.
+.fi
+<documentation needed>
 .PP
 .SS ABSOLUTE AXIS CONFIGURATION
-The relative axis portion of this driver handle all reported relative axes.
+The absolute axis portion of this driver handles all reported absolute axes.
 .fi
 The axes are named X, Y, Z, RX, RY, RZ, THROTTLE, RUDDER, WHEEL, GAS, BRAKE,
 <11\-15>, HAT0X, HAT0Y, HAT1X, HAT1Y, HAT2X, HAT2Y, HAT3X, HAT3Y, PRESSURE,
@@ -267,28 +119,55 @@ to x and y coordinates, respectively.
 .fi
 The following driver 
 .B Options
-control the relative axis portion of the driver:
+control the absolute axis portion of the driver:
 .TP 7
-.BI "Option \*q" axis "AbsoluteAxisMap\*q \*q" n \*q
-This remaps the axis specified to the specified valuator.
+.BI "Option \*qAbs" "%s" "MapTo\*q \*q" string \*q
+This remaps the axis specified by
+.I "%s"
+to
+.IR string .
+See Section
+.B "AXIS MAPPING"
+for valid values.
 .TP 7
-.BI "Option \*qAbsoluteScreen\*q \*q" n \*q
-This binds the device to a specific screen, scaling it to
-the coordinate space of that screen.
-.fi
-The number can either be \-1, or a valid screen number.
+.BI "Option \*qAbs" "%s" "Options\*q \*q" string \*q
+This sets some options for the absolute axis specified by
+.IR "%s" .
 .fi
-If \-1 or if in relative mode no scaling or screen fixing is done.
+Valid values are \*qinvert\*q, \*quse_touch\*q, \*qmode_auto\*q,
+\*qmode_rel\*q.
 .fi
-This is of most use for digitizers, where the screen and the input
-device are the same surface.
+<documentation needed>
 .TP 7
-.BI "Option \*qMode\*q \*q" mode \*q
-This selects the default mode for the device.
+.BI "Option \*qAbsoluteTouch\*q \*q" string \*q
+<documentation needed>
 .fi
-Valid values are \*qabsolute\*q and \*qrelative\*q.
-.fi
-This can be set at run time per actual device with the xinput utility.
+Default: DIGI_Touch
+.PP
+.SS AXIS MAPPING
+The following axis mappings are recognized:
+.TP 7
+.BI "\*qRelAxis " <axis> \*q
+Map the axis to the specified 
+.I <axis>
+in relative mode. This can be either a number or a name.
+.TP 7
+.BI "\*qAbsAxis " "<axis> <min> <max>" \*q
+Maps the axis to the specified
+.I <axis>
+in absolute mode. This can be either a number or a name.
+.TP 7
+.BI "\*qButton " "<button>" \*q
+Maps the button to the button specified with
+.IR <button> .
+This can be either a button number or a name.
+.TP 7
+.BI "\*qButtons " "<button+> <button->" \*q
+Maps the positive axis to the button specified with
+.I <button+>
+and the negative axis to the button specified with 
+.IR <button-> .
+These can be either button numbers or names.
 .PP
 .SS BUTTON CONFIGURATION
 At the moment, the button portion of this driver only handles buttons