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

Added doc for --ui-new, --ui-toggle and --alt-config

Browse source
This commit is contained in:
Ingo Ruhnke 2010-12-18 13:43:11 +01:00
parent f8ba8e00d2
commit 2530974b7c
3 changed files with 86 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
TODO
View file

@ -122,13 +122,9 @@ Stuff to do before 0.6.0 release:
=================================
[man page]
* add documentation to shifted axis
* write man page entry for: --evdev-absmap ABS_X2+=RT,-ABS_X2+=LT to allow mapping of
half-axes (syntax is inconsistent with axis inverting)
* write documentation for --ui-new and --alt-config
[polish]
* allow both ';' and '#' as comment character, compatibilty with

35
doc/xboxdrv.1
View file

@ -608,11 +608,44 @@ also use shift keys in place of the XBOXAXIS:
This allows you to send ABS_X events normally and ABS_RX
events when the LB button is held down.
.TP
\*(T<\fB\-\-alt\-config\fR\*(T> \fIFILE\fR
A shortcut for writing \*(T<\fB\-\-ui\-new\fR\*(T> \*(T<\fB\-\-config\fR\*(T> \fIFILE\fR.
.TP
\*(T<\fB\-\-ui\-clear\fR\*(T>
Removes all uinput mappings and will leave the driver in
a blank state and only map those things you added
yourself. If you only want to get rid of individual
buttons you can use the 'void' event:
buttons you can use the 'void' event.
.TP
\*(T<\fB\-\-ui\-new\fR\*(T>
Allows the creation of an alternative uinput
configuration to which one can toggle at runtime by
pressing the ui-toggle button (defaults to guide).
.nf
\*(T<$ xboxdrv \e
\-\-mouse \e
\-\-ui\-new
\-\-ui\-axismap X1=ABS_X,Y1=ABS_Y \e
\-\-ui\-buttonmap A=JS_0,B=JS_1
\*(T>.fi
The above configuration would install mouse emulation as
first configuration and a simple joystick emulation as
second configuration. Allowing toggling between mouse
emulation and joystick handling by pressing the guide
button.
Not that \*(T<\fB\-\-ui\-new\fR\*(T> is currently limited
to only configurations done
with \*(T<\fB\-\-ui\-buttonmap\fR\*(T>
and \*(T<\fB\-\-ui\-axismap\fR\*(T>, autofire, throttle
emulation, deadzones and all other things can currently
not be switched at runtime.
.TP
\*(T<\fB\-\-ui\-toggle\fR\*(T> \fIXBOXBTN\fR
Sets the button that will be used to toggle between
different uinput configurations.
.TP
\*(T<\fB\-m, \-\-mouse\fR\*(T>
Lets the controller act as a mouse. It is indendical to:

53
doc/xboxdrv.xml
View file

@ -761,6 +761,15 @@ NAME = STRING ;]]></programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--alt-config</option> <replaceable class="parameter">FILE</replaceable></term>
<listitem>
<para>
A shortcut for writing <option>--ui-new</option> <option>--config</option> <replaceable class="parameter">FILE</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--ui-clear</option></term>
<listitem>
@ -768,7 +777,49 @@ NAME = STRING ;]]></programlisting>
Removes all uinput mappings and will leave the driver in
a blank state and only map those things you added
yourself. If you only want to get rid of individual
buttons you can use the 'void' event:
buttons you can use the 'void' event.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--ui-new</option></term>
<listitem>
<para>
Allows the creation of an alternative uinput
configuration to which one can toggle at runtime by
pressing the ui-toggle button (defaults to guide).
</para>
<programlisting><![CDATA[$ xboxdrv \
--mouse \
--ui-new
--ui-axismap X1=ABS_X,Y1=ABS_Y \
--ui-buttonmap A=JS_0,B=JS_1
]]></programlisting>
<para>
The above configuration would install mouse emulation as
first configuration and a simple joystick emulation as
second configuration. Allowing toggling between mouse
emulation and joystick handling by pressing the guide
button.
</para>
<para>
Not that <option>--ui-new</option> is currently limited
to only configurations done
with <option>--ui-buttonmap</option>
and <option>--ui-axismap</option>, autofire, throttle
emulation, deadzones and all other things can currently
not be switched at runtime.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--ui-toggle</option> <replaceable class="parameter">XBOXBTN</replaceable></term>
<listitem>
<para>
Sets the button that will be used to toggle between
different uinput configurations.
</para>
</listitem>
</varlistentry>