From e67d5b1a1fff1937623cff91a4be92b8c8756717 Mon Sep 17 00:00:00 2001
From: Ingo Ruhnke <grumbel@gmx.de>
Date: Sat, 29 Jan 2011 04:43:15 +0100
Subject: [PATCH] Documented some --match rules
---
TODO | 8 ++++--
doc/xboxdrv.1 | 31 ++++++++++++++++++++---
doc/xboxdrv.xml | 67 ++++++++++++++++++++++++++++++++++++++++++++++++-
3 files changed, 99 insertions(+), 7 deletions(-)
diff --git a/TODO b/TODO
index ab9e9ae..10df7dc 100644
--- a/TODO
+++ b/TODO
@@ -42,6 +42,10 @@ $ dput my-ppa ../xboxdrv_0.7.1-1~lucid1_source.changes
Stuff to do before 0.7.1 release:
=================================
+* how exactly does daemon interact with wireless pads?! allow --wid --id for daemon
+
+* make --led LED part of ControllerSlotOptions to use with multiple controller
+
* make more use of percentance values (in deadzone filter for example)
* add option to increase libusb debug level
@@ -54,8 +58,6 @@ Stuff to do before 0.7.1 release:
* allow multiple controllers in non-daemon mode
-* document match rules
-
* improve output in daemon mode, when --quiet is not given print the
number of allocated controller slots
@@ -162,6 +164,8 @@ Stuff to do before 0.7.3 release:
Stuff to do before 0.7.x release:
=================================
+* add Wiimote and PS3 bluetooth support
+
* -R, --rumble-test is broken for FirestormDualController (has no analog triggers)
* add ABS support to macros events (need to deal with min/max)
diff --git a/doc/xboxdrv.1 b/doc/xboxdrv.1
index 32bc0f8..a08ad98 100644
--- a/doc/xboxdrv.1
+++ b/doc/xboxdrv.1
@@ -556,10 +556,33 @@ Switches to the next controller slot.
\*(T<\fB\-\-match\fR\*(T> \fIRULE,...\fR
Limits a controller slot to devices that match any one
of the given rules. Possible match rules are:
-
-.nf
-\*(T<usbid={VENDOR}:{PRODUCT}\*(T>
-.fi
+.RS
+.TP
+usbid=\fIVENDOR\fR:\fIPRODUCT\fR
+Match controllers that have the
+given USB vendor and product ids.
+.TP
+vendor=\fIVENDOR\fR
+Match controllers that have the
+given USB idVendor.
+.TP
+product=\fIPRODUCT\fR
+Match controllers that have the
+given USB idProduct.
+.TP
+property=\fIPROPERTY\fR:\fIVALUE\fR
+Match against an arbitary udev property, with
+name \fIPROPERTY\fR and
+value \fIVALUE\fR.
+.TP
+usbpath=\fIBUS\fR:\fIDEV\fR
+Match against the USB path given
+by \fIBUS\fR
+and \fIDEV\fR.
+.TP
+usbserial=\fISERIAL\fR
+Match against the USB iSerial number.
+.RE
.TP
\*(T<\fB\-\-match\-group\fR\*(T> \fIRULE,...\fR
Limits a controller slot to devices that match all of
diff --git a/doc/xboxdrv.xml b/doc/xboxdrv.xml
index 5955fed..5118c16 100644
--- a/doc/xboxdrv.xml
+++ b/doc/xboxdrv.xml
@@ -853,7 +853,72 @@ start=KEY_ESC
Limits a controller slot to devices that match any one
of the given rules. Possible match rules are:
</para>
- <programlisting>usbid={VENDOR}:{PRODUCT}</programlisting>
+ <variablelist>
+
+ <varlistentry>
+ <term>usbid=<replaceable>VENDOR</replaceable>:<replaceable>PRODUCT</replaceable></term>
+ <listitem>
+ <para>
+ Match controllers that have the
+ given USB vendor and product ids.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>vendor=<replaceable>VENDOR</replaceable></term>
+ <listitem>
+ <para>
+ Match controllers that have the
+ given USB idVendor.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>product=<replaceable>PRODUCT</replaceable></term>
+ <listitem>
+ <para>
+ Match controllers that have the
+ given USB idProduct.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>property=<replaceable>PROPERTY</replaceable>:<replaceable>VALUE</replaceable></term>
+ <listitem>
+ <para>
+ Match against an arbitary udev property, with
+ name <replaceable>PROPERTY</replaceable> and
+ value <replaceable>VALUE</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usbpath=<replaceable>BUS</replaceable>:<replaceable>DEV</replaceable></term>
+ <listitem>
+ <para>
+ Match against the USB path given
+ by <replaceable>BUS</replaceable>
+ and <replaceable>DEV</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>usbserial=<replaceable>SERIAL</replaceable></term>
+ <listitem>
+ <para>
+ Match against the USB iSerial number.
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ </variablelist>
+
</listitem>
</varlistentry>