Techwizz/xboxdrv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed some issues with non-validating markup

Browse source
This commit is contained in:
Ingo Ruhnke 2010-05-20 22:23:13 +02:00
parent 50af1e4c53
commit 97fcd95eff
1 changed files with 65 additions and 51 deletions

116
doc/xboxdrv.xml
View file

@ -5,7 +5,7 @@
<refentryinfo>
<date>2010-05-05</date>
</refentryinfo>
<refmeta>
<refentrytitle>
<application>xboxdrv</application>
@ -59,21 +59,21 @@
<varlistentry>
<term><option>-v</option>, <option>--verbose</option></term>
<listitem>
Print verbose messages.
<para>Print verbose messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-led</option></term>
<listitem>
List possible values for the led.
<para>List possible values for the led.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-devices</option></term>
<listitem>
List supported devices.
<para>List supported devices.</para>
</listitem>
</varlistentry>
@ -183,9 +183,11 @@
<varlistentry>
<term><option>-i</option>, <option>--id</option> <replaceable class="parameter">N</replaceable></term>
<listitem>
Use controller with id N (default: 0),
use <option>--list-controller</option> to obtain a list of
available controller.
<para>
Use controller with id N (default: 0),
use <option>--list-controller</option> to obtain a list
of available controller.
</para>
</listitem>
</varlistentry>
@ -223,11 +225,11 @@
Ignore autodetection and enforce the controller type. Possible values for <replaceable class="parameter">TYPE</replaceable>:
</para>
<itemizedlist>
<listitem>xbox</listitem>
<listitem>xbox-mat</listitem>
<listitem>xbox360</listitem>
<listitem>xbox360-wireless</listitem>
<listitem>xbox360-guitar</listitem>
<listitem><para>xbox</para></listitem>
<listitem><para>xbox-mat</para></listitem>
<listitem><para>xbox360</para></listitem>
<listitem><para>xbox360-wireless</para></listitem>
<listitem><para>xbox360-guitar</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@ -244,6 +246,7 @@
Set LED status. Possible values for <replaceable class="parameter">NUM</replaceable> are:
</para>
<table>
<title>LED Status Codes</title>
<tgroup cols="2">
<colspec align="right" colwidth="1*" />
<colspec align="left" colwidth="1*" />
@ -342,7 +345,7 @@
<varlistentry>
<term><option>--dpad-as-button</option></term>
<listitem>
The DPad sends button instead of axis events.
<para>The DPad sends button instead of axis events.</para>
</listitem>
</varlistentry>
@ -374,6 +377,7 @@
<para>Possible button names are (aliases are in parenthesis):</para>
<table frame="all">
<title>Button Names</title>
<tgroup cols="2">
<thead>
<row>
@ -634,6 +638,11 @@
that <option>--mouse</option> comes before you
customization options on the command line.
</para>
<para>
Note that if you have your mouse buttons switched you must
adjust the above to match your mouse configuration or the
button events will come out wrong.
</para>
</listitem>
</varlistentry>
@ -843,35 +852,44 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
<para>
Plug in your Xbox360 gamepad and then unload the xpad driver via:
</para>
<programlisting>% rmmod xpad</programlisting>
If you want to permanently unload it add the following line to
<filename>/etc/modprobe.d/blacklist.conf</filename>:
<para>
If you want to permanently unload it add the following line to
<filename>/etc/modprobe.d/blacklist.conf</filename>:
</para>
<programlisting>blacklist xpad</programlisting>
Next you have to load the uinput kernel module which allows userspace
programms to create input devices and the joydev module which gives
you the <filename>/dev/input/jsX</filename> device:
<para>
Next you have to load the uinput kernel module which allows userspace
programms to create input devices and the joydev module which gives
you the <filename>/dev/input/jsX</filename> device:
</para>
<programlisting><![CDATA[% modprobe uinput
% modprobe joydev]]></programlisting>
<para>
You also have to make sure that you have access rights to
/dev/input/uinput, either add yourself to the appropriate group,
adjust the permissions or run xboxdrv as root.
</para>
<para>
Once ensured that xpad is out of the way and everything is in place
start the userspace driver with:
</para>
<programlisting>% ./xboxdrv</programlisting>
<programlisting>% xboxdrv</programlisting>
<para>
Or in case you don't have the neccesary rights (being in group root
should often be enough) start the driver as root via:
</para>
<programlisting>% sudo ./xboxdrv</programlisting>
<programlisting>% sudo xboxdrv</programlisting>
<para>
This will create /dev/input/js0 and allow you to access the gamepad
@ -880,7 +898,7 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
of the xboxdrv driver and append the -i argument like this:
</para>
<programlisting>% ./xboxdrv -i 1</programlisting>
<programlisting>% xboxdrv -i 1</programlisting>
<para>
If you have multiple wireless controller you need to start multiple
@ -888,7 +906,7 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
this:
</para>
<programlisting>% ./xboxdrv --wid 1</programlisting>
<programlisting>% xboxdrv --wid 1</programlisting>
<para>
You have to sync the wireless controller as usual.
@ -897,12 +915,12 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
<para>This will then use the second detected controller, see to see which id
your controller has:</para>
<programlisting>% ./xboxdrv --list-controller</programlisting>
<programlisting>% xboxdrv --list-controller</programlisting>
<para>When everything works as expected it is recomment that you run xboxdrv
with the silent option:</para>
<programlisting>% ./xboxdrv --silent</programlisting>
<programlisting>% xboxdrv --silent</programlisting>
<para>This will suppress the logging of events to the console and will
gurantee that no uneccesarry CPU cycles are wasted.</para>
@ -910,13 +928,13 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
<para>If you want to abuse the led or rumble of the gamepad for notification
in scripts you can do see via:</para>
<programlisting>% ./xboxdrv --led 10 --rumble 30,30 --quit</programlisting>
<programlisting>% xboxdrv --led 10 --rumble 30,30 --quit</programlisting>
<para>This will cause a mild rumble and the led to rotate, you can stop it
again via, which also happens to be the command you can use to stop
your Xbox360 controller from blinking:</para>
<programlisting>% ./xboxdrv ---led 0 --rumble 0,0 --quit</programlisting>
<programlisting>% xboxdrv ---led 0 --rumble 0,0 --quit</programlisting>
<para>For rumble to work make sure you have connected the
controller to a USB port that has enough power, an unpowered USB
@ -1019,14 +1037,6 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
<refsect1>
<title>EXAMPLES</title>
<refsect2>
<para>
Note that if you have your mouse buttons switched you must
adjust the above to match your mouse configuration or the
button events will come out wrong.
</para>
</refsect2>
<refsect2>
<title>Keyboard Emulation</title>
@ -1034,7 +1044,7 @@ pos = (1.0f - (1.0f - pos) ** t) ** (1 / t);]]></programlisting>
keyboard, like Flash games or games that don't support a joystick, you
have to adjust the keybindings to fit the game:</para>
<programlisting><![CDATA[% ./xboxdrv \
<programlisting><![CDATA[% xboxdrv \
--ui-clear \
--dpad-as-button \
--ui-buttonmap a=XK_a,b=XK_b,x=XK_x,y=XK_y \
@ -1096,7 +1106,7 @@ joysticktype = ch]]></programlisting>
you have to do tweaking yourself.
</para>
<programlisting><![CDATA[% ./xboxdrv \
<programlisting><![CDATA[% xboxdrv \
--ui-axismap x2=REL_X:10,y2=REL_Y:-10,x1=KEY_LEFT:KEY_RIGHT,y1=KEY_UP:KEY_DOWN \
--ui-buttonmap a=BTN_RIGHT,b=BTN_LEFT,x=BTN_EXTRA \
--ui-buttonmap rb=KEY_5,lb=KEY_6,lt=BTN_LEFT,rt=BTN_RIGHT \
@ -1112,7 +1122,7 @@ joysticktype = ch]]></programlisting>
configuration, you have to do tweaking yourself.
</para>
<programlisting><![CDATA[% ./xboxdrv \
<programlisting><![CDATA[% xboxdrv \
--ui-axismap x2=REL_X:10,y2=REL_Y:-10,x1=KEY_A:KEY_D,y1=KEY_W:KEY_S \
--ui-buttonmap a=KEY_LEFTSHIFT,b=BTN_C,x=BTN_EXTRA,y=KEY_C \
--ui-buttonmap lb=BTN_RIGHT,rb=KEY_SPACE \
@ -1142,16 +1152,20 @@ joysticktype = ch]]></programlisting>
% SDL_JOYSTICK_DEVICE="/dev/input/js0"
% export SDL_JOYSTICK_DEVICE]]></programlisting>
This will let the DPad act as Hat in SDL based application. For many
games the driver will work without this, but especially in Dosbox this
variable is very important.
<para>
This will let the DPad act as Hat in SDL based application. For
many games the driver will work without this, but especially in
Dosbox this variable is very important.
</para>
If you use options in xboxdrv that change the number of axis you have
to adjust the variable accordingly, see:
<para>
If you use options in xboxdrv that change the number of axis you
have to adjust the variable accordingly, see:
</para>
<itemizedlist>
<listitem>
<ulink url="ftp://ptah.lnf.kth.se/pub/misc/sdl-env-vars">ftp://ptah.lnf.kth.se/pub/misc/sdl-env-vars</ulink>
<para><ulink url="ftp://ptah.lnf.kth.se/pub/misc/sdl-env-vars">ftp://ptah.lnf.kth.se/pub/misc/sdl-env-vars</ulink></para>
</listitem>
</itemizedlist>
@ -1191,9 +1205,9 @@ joysticktype = ch]]></programlisting>
<programlisting><![CDATA[% lsusb -v]]></programlisting>
<para>Once done you can try to add them to the array:</para>
<para>Once done you can try to add them to this array in <filename>xpad_device.cpp</filename>:</para>
<programlisting><![CDATA[XPadDevice xpad_devices[] = { ... }]]></programlisting> in <filename>xpad_device.cpp</filename>.
<programlisting><![CDATA[XPadDevice xpad_devices[] = { ... }]]></programlisting>
<para>
If you have success with that, send a patch
@ -1237,7 +1251,7 @@ joysticktype = ch]]></programlisting>
working correctly you can pass the -v option:
</para>
<programlisting><![CDATA[% ./xboxdrv -v]]></programlisting>
<programlisting><![CDATA[% xboxdrv -v]]></programlisting>
<para>
This will cause the driver to output all the events that it received
@ -1257,7 +1271,7 @@ joysticktype = ch]]></programlisting>
itself works with:
</para>
<programlisting><![CDATA[% ./xboxdrv --no-uinput -v]]></programlisting>
<programlisting><![CDATA[% xboxdrv --no-uinput -v]]></programlisting>
</refsect2>
@ -1439,8 +1453,8 @@ EndSection]]></programlisting>
</para>
<itemizedlist>
<listitem><ulink url="http://github.com/github/linux-2.6/blob/f3b8436ad9a8ad36b3c9fa1fe030c7f38e5d3d0b/Documentation/input/ff.txt">http://github.com/github/linux-2.6/blob/f3b8436ad9a8ad36b3c9fa1fe030c7f38e5d3d0b/Documentation/input/ff.txt</ulink></listitem>
<listitem><filename>/usr/include/linux/input.h</filename></listitem>
<listitem><para><ulink url="http://github.com/github/linux-2.6/blob/f3b8436ad9a8ad36b3c9fa1fe030c7f38e5d3d0b/Documentation/input/ff.txt">http://github.com/github/linux-2.6/blob/f3b8436ad9a8ad36b3c9fa1fe030c7f38e5d3d0b/Documentation/input/ff.txt</ulink></para></listitem>
<listitem><para><filename>/usr/include/linux/input.h</filename></para></listitem>
</itemizedlist>
<para>
@ -1449,8 +1463,8 @@ EndSection]]></programlisting>
</para>
<itemizedlist>
<listitem><ulink url="http://www.immersion.com/developer/downloads/ImmFundamentals/HTML/"></ulink></listitem>
<listitem><ulink url="http://msdn.microsoft.com/en-us/library/bb219655(VS.85).aspx"></ulink></listitem>
<listitem><para><ulink url="http://www.immersion.com/developer/downloads/ImmFundamentals/HTML/"></ulink></para></listitem>
<listitem><para><ulink url="http://msdn.microsoft.com/en-us/library/bb219655(VS.85).aspx"></ulink></para></listitem>
</itemizedlist>
<para><command>fftest</command> is an application you can use to test the force feedback