From ae88f9f38229f9475b92c286c5fe058b965e7261 Mon Sep 17 00:00:00 2001
From: Ingo Ruhnke <grumbel@gmx.de>
Date: Sat, 29 Jan 2011 05:37:19 +0100
Subject: [PATCH] Documented --name and --device-name
---
TODO | 13 ++++---------
doc/xboxdrv.1 | 15 +++++++++++++--
doc/xboxdrv.xml | 21 +++++++++++++++++++--
3 files changed, 36 insertions(+), 13 deletions(-)
diff --git a/TODO b/TODO
index b29d742..4a24ef8 100644
--- a/TODO
+++ b/TODO
@@ -44,21 +44,12 @@ 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
-* document --device-name TYPE.SLOT=NAME, --name
-
* add --device-usbid TYPE.SLOT=VENDOR:PRODUCT:VERSION
* fix device name of mimic_xpad
-
-* allow multiple controllers in non-daemon mode
-
* improve output in daemon mode, when --quiet is not given print the
number of allocated controller slots
@@ -101,6 +92,10 @@ Stuff to do before 0.7.1 release:
Stuff to do before 0.7.2 release:
=================================
+* allow multiple controllers in non-daemon mode
+
+* make more use of percentance values (in deadzone filter for example)
+
* add extra arguments to --on-connect and --on-disconnect (controller name, usb path, etc.)
* boost::lexical_cast<> error messages are useless, make some better ones
diff --git a/doc/xboxdrv.1 b/doc/xboxdrv.1
index a08ad98..ac24436 100644
--- a/doc/xboxdrv.1
+++ b/doc/xboxdrv.1
@@ -958,8 +958,19 @@ joystick device. This option disables that automatism
and all events will go to the same virtual device.
Manual assignment to a specific device is still possible.
.TP
-\*(T<\fB\-\-name DEVNAME\fR\*(T>
-Changes the descriptive name the device will have.
+\*(T<\fB\-\-name NAME\fR\*(T>
+Changes the descriptive name the device will have. This
+options acts the same as
+--device-name \fICURRENTSLOT\fR.auto=\fINAME\fR
+.TP
+\*(T<\fB\-\-device\-name TYPE.SLOT=NAME\fR\*(T>
+Changes the descriptive name the device will
+have. \fITYPE\fR is one of mouse,
+keyboard, joystick, auto
+or a number. \fISLOT\fR is a slot
+number or auto.
+The auto name acts as wild card and
+matches everything.
.TP
\*(T<\fB\-\-ui\-clear\fR\*(T>
Removes all uinput mappings and will leave the driver in
diff --git a/doc/xboxdrv.xml b/doc/xboxdrv.xml
index 5118c16..25c47a5 100644
--- a/doc/xboxdrv.xml
+++ b/doc/xboxdrv.xml
@@ -1457,10 +1457,27 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
</varlistentry>
<varlistentry>
- <term><option>--name DEVNAME</option></term>
+ <term><option>--name NAME</option></term>
<listitem>
<para>
- Changes the descriptive name the device will have.
+ Changes the descriptive name the device will have. This
+ options acts the same as
+ --device-name <replaceable>CURRENTSLOT</replaceable>.auto=<replaceable>NAME</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--device-name TYPE.SLOT=NAME</option></term>
+ <listitem>
+ <para>
+ Changes the descriptive name the device will
+ have. <replaceable>TYPE</replaceable> is one of <constant>mouse</constant>,
+ <constant>keyboard</constant>, <constant>joystick</constant>, <constant>auto</constant>
+ or a number. <replaceable>SLOT</replaceable> is a slot
+ number or <constant>auto</constant>.
+ The <constant>auto</constant> name acts as wild card and
+ matches everything.
</para>
</listitem>
</varlistentry>