Update to include all the new device matching options.

2 files changed, 151 insertions, 10 deletions

diff --git a/ChangeLog b/ChangeLog
index 2ba0116..5e6d177 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-03-16  Zephaniah E. Hull  <warp@aehallh.com>
+
+	* man/evdev.man:
+	Update to include all the new device matching options.
+
 2006-02-27  Zephaniah E. Hull  <warp@aehallh.com>
 
 	* src/evdev_key.c: (EvdevKeyOff):
diff --git a/man/evdev.man b/man/evdev.man
index 910dba8..603c863 100644
--- a/man/evdev.man
+++ b/man/evdev.man
@@ -37,17 +37,62 @@ Please refer to __xconfigfile__(__filemansuffix__) 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.
 .PP
-.SH GENERAL OPTIONS
+.SH BASIC CONFIGURATIONS
+Most users of this driver will probably be quite happy with the following for
+all QWERTY keyboards:
+.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
+\ \ ...
+.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, note that globbing is used in all cases:
+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.  This
-will generally be of the form \*q/dev/input/eventX\*q, where X is some
-integer.  The mapping from device node to hardware is system-dependent.
+Specifies the device note through which the device can be accessed.
+At this time ONLY /dev/input/event<N>, where <N> is an integer, are
+matched against this this field.
+.fi
+This option uses globbing.
 .fi
-Please note that use of this option is discouraged.
+Please note that use of this option is strongly discouraged.
+
 .TP 7
 .BI "Option \*qName\*q \*q" string \*q
 Specifies the device name for the device you wish to use.
@@ -58,6 +103,9 @@ that are commonly unplugged and plugged back into different ports.
 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.
@@ -68,8 +116,96 @@ into.
 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
+<map>Bits: Where map is one of ev, key, rel, abs, msc, led, snd, or
+ff.
+.fi
+The bit specifier format is a string consisting of +<n>, -<n>, and ~<n>
+space sepirated specifiers, where <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 '+0 +3 -1-2 ~5-10', 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" integer \*q
+Specifies the bus ID for the device you wish to use.
+.fi
+This is either 0 (the default, matches anything), or the 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" integer \*q
+Specifies the vendor ID for the device you wish to use.
+.fi
+This is either 0 (the default, matches anything), or the 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" integer \*q
+Specifies the version for the device you wish to use.
+.fi
+This is either 0 (the default, matches anything), or the 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" integer \*q
+Specifies the product ID for the device you wish to use.
+.fi
+This is either 0 (the default, matches anything), or the Product=<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 \*qPass\*q \*q" integer \*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 inputsection matches the same device.
+.fi
+An inputsection 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.
+.fi
+The default is 0.
+
+
 .PP
-.SH RELATIVE AXIS CONFIGURATION
+.SS RELATIVE AXIS CONFIGURATION
 The relative axis portion of this driver handle all reported relative axies.
 .fi
 The axies are named X, Y, Z, RX, RY, RZ, HWHEEL, DIAL, WHEEL, MISC, 10, 11,
@@ -99,7 +235,7 @@ 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.
 .PP
-.SH ABSOLUTE AXIS CONFIGURATION
+.SS ABSOLUTE AXIS CONFIGURATION
 The relative axis portion of this driver handle all reported relative axies.
 .fi
 The axies are named X, Y, Z, RX, RY, RZ, THROTTLE, RUDDER, WHEEL, GAS, BREAK,
@@ -139,12 +275,12 @@ Valid values are \*qabsolute\*q and \*qrelative\*q.
 .fi
 This can be set at run time per actual device with the xinput utility.
 .PP
-.SH BUTTON CONFIGURATION
+.SS BUTTON CONFIGURATION
 At the moment, the button portion of this driver only handles buttons
 reported as mouse buttons, that is from BTN_MOUSE to BTN_JOYSTICK - 1.
 .fi
 At this time there are no configuration options for buttens.
-.SH KEYBOARD CONFIGURATION
+.SS KEYBOARD CONFIGURATION
 The keyboard portion of this driver handles all keys reported and requires 
 XKB support.
 .fi