From 8db6e9b87ba8dffae1c77029d5290d8815f4e3bc Mon Sep 17 00:00:00 2001
From: Ingo Ruhnke <grumbel@gmail.com>
Date: Tue, 24 Jan 2012 11:53:13 +0100
Subject: [PATCH] Added documentation for --dbus and --ff-device
---
doc/xboxdrv.1 | 22 ++++++++++++++++++++++
doc/xboxdrv.xml | 34 ++++++++++++++++++++++++++++++++++
2 files changed, 56 insertions(+)
diff --git a/doc/xboxdrv.1 b/doc/xboxdrv.1
index 28814b0..d801ea7 100644
--- a/doc/xboxdrv.1
+++ b/doc/xboxdrv.1
@@ -249,6 +249,19 @@ if \*(T<\fB\-\-daemon\fR\*(T> is given.
\*(T<\fB\-\-pid\-file\fR\*(T> \fIFILE\fR
Write the xboxdrv daemon process id to FILE.
.TP
+\*(T<\fB\-\-dbus\fR\*(T> \fIBUS\fR
+Set which bus type xboxdrv should connect to. Allowed
+values for BUS are session,
+system,
+disabled and
+auto. The default is
+auto, which will detect the
+appropriate bus type depending on if xboxdrv is run as
+root (system or as user
+(session). Running with
+disabled will disable D-Bus support
+completely.
+.TP
\*(T<\fB\-\-on\-connect\fR\*(T> \fIEXE\fR
Launches \fIEXE\fR
when a controller gets connected. As arguments
@@ -601,6 +614,15 @@ When using xboxdrv in daemon mode with multiple
controller slots you have to enable force feedback for
each slot separately.
.TP
+\*(T<\fB\-\-ff\-device\fR\*(T> \fIDEVICEID\fR
+Select to which virtual device the force-feedback
+callbacks will be connected to, it defaults to
+joystick. Other allowed values are
+mouse,
+keyboard and any integer number.
+See \*(T<\fB\-\-ui\-buttonmap\fR\*(T> for further
+information on how device-ids work.
+.TP
\*(T<\fB\-R\fR\*(T>, \*(T<\fB\-\-test\-rumble\fR\*(T>
Pressing LT will move the left rumble motor and pressing
RT will move the right one. Rumble motor strength
diff --git a/doc/xboxdrv.xml b/doc/xboxdrv.xml
index c8bab38..20ac34a 100644
--- a/doc/xboxdrv.xml
+++ b/doc/xboxdrv.xml
@@ -436,6 +436,25 @@ start=KEY_ESC
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--dbus</option> <replaceable class="parameter">BUS</replaceable></term>
+ <listitem>
+ <para>
+ Set which bus type xboxdrv should connect to. Allowed
+ values for BUS are <constant>session</constant>,
+ <constant>system</constant>,
+ <constant>disabled</constant> and
+ <constant>auto</constant>. The default is
+ <constant>auto</constant>, which will detect the
+ appropriate bus type depending on if xboxdrv is run as
+ root (<constant>system</constant> or as user
+ (<constant>session</constant>). Running with
+ <constant>disabled</constant> will disable D-Bus support
+ completely.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><option>--on-connect</option> <replaceable class="parameter">EXE</replaceable></term>
<listitem>
@@ -892,6 +911,21 @@ start=KEY_ESC
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--ff-device</option> <replaceable>DEVICEID</replaceable></term>
+ <listitem>
+ <para>
+ Select to which virtual device the force-feedback
+ callbacks will be connected to, it defaults to
+ <constant>joystick</constant>. Other allowed values are
+ <constant>mouse</constant>,
+ <constant>keyboard</constant> and any integer number.
+ See <option>--ui-buttonmap</option> for further
+ information on how device-ids work.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><option>-R</option>, <option>--test-rumble</option></term>
<listitem>