Added documentation for --dbus and --ff-device

This commit is contained in:
Ingo Ruhnke 2012-01-24 11:53:13 +01:00
parent e3f3e23cbf
commit 8db6e9b87b
2 changed files with 56 additions and 0 deletions

View file

@ -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

View file

@ -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>