~ubuntu-branches/ubuntu/saucy/joystick/saucy

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Kitt
  • Date: 2011-04-04 16:56:39 UTC
  • mto: (3.1.7 sid)
  • mto: This revision was merged to the branch mainline in revision 14.
  • Revision ID: james.westby@ubuntu.com-20110404165639-k7yh9rf1yd1dhobd
Tags: upstream-1.4~rc1
Import upstream version 1.4~rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
                          linuxconsole tools
 
2
                            Release 1.4rc1
 
3
 
 
4
 
 
5
This package contains the following utilities and associated
 
6
documentation:
 
7
* evtest - input layer event monitor
 
8
* inputattach - connects legacy serial devices to the input layer
 
9
* joystick utilities - calibrate and test joysticks and joypads
 
10
 
 
11
The evtest and inputattach manpages provide more details on their
 
12
operation.
 
13
 
 
14
 
 
15
Joystick utilities
 
16
------------------
 
17
 
 
18
The following utilities are provided to calibrate and test joysticks:
 
19
* ffcfstress, ffmvforce, fftest - test force-feedback devices
 
20
* ffset - set force-feedback device parameters
 
21
* jscal - calibrate joystick devices, reconfigure the axes and buttons
 
22
* jscal-store, jscal-restore - store and retrieve joystick device
 
23
  settings as configured using jscal
 
24
* jstest - test joystick devices
 
25
 
 
26
The typical scenario when configuring a new device is as follows:
 
27
1. Check the basic functions using jstest (number of buttons, axes,
 
28
   etc.).
 
29
2. Calibrate the joystick using jscal (this can be useful even if the
 
30
   device functions correctly, if only to configure the dead-zone at
 
31
   the centre).
 
32
3. Repeat steps 1 and 2 until the joystick is configured to the user's
 
33
   satisfaction.
 
34
4. Store the device's setup using jscal-store.
 
35
 
 
36
 
 
37
Installation
 
38
------------
 
39
 
 
40
To install the utilities and their manpages, run
 
41
        make install
 
42
from the distribution's top directory. This will install everything
 
43
into /usr/local. Should you wish to install the tools elsewhere, you
 
44
can use the PREFIX variable:
 
45
        PREFIX=/usr make install
 
46
The Makefiles also recognise the DESTDIR variable which can be used to
 
47
install into a temporary directory (this is useful mainly for
 
48
distribution packagers).
 
49
 
 
50
 
 
51
Auto-loading inputattach and jscal-restore
 
52
------------------------------------------
 
53
 
 
54
udev can be used to start inputattach and jscal-restore when the
 
55
appropriate device is connected to the system (or detected when the
 
56
system is booting up).
 
57
 
 
58
The following rule restores the stored calibration and axis/button
 
59
mappings whenever a joystick device is connected:
 
60
        KERNEL=="js*", ACTION=="add", RUN+="/usr/bin/jscal-restore %E{DEVNAME}"
 
61
(change the path as appropriate). This rule needs /usr to be
 
62
available, which can cause issues on systems where udev is run from
 
63
the initramfs or where /usr is a separate partition. To work around
 
64
this, the Debian package uses a script provided by Debian's udev
 
65
package to wait for jscal-restore to become available. Should you wish
 
66
to reproduce this, you need to create a udev agent
 
67
(/lib/udev/jscal-restore) containing the following:
 
68
 
 
69
#!/bin/sh -e
 
70
# udev agent for jscal-restore
 
71
 
 
72
wait_for_file() {
 
73
        local file=$1
 
74
        local count=120
 
75
        while [ $count != 0 ]; do
 
76
                [ -e "$file" ] && return 0
 
77
                sleep 1
 
78
                count=$(($count - 1))
 
79
        done
 
80
        exit 1
 
81
}
 
82
 
 
83
(
 
84
        wait_for_file /usr/bin/jscal-restore
 
85
        exec /usr/bin/jscal-restore $1
 
86
) &
 
87
 
 
88
and change the udev rule to
 
89
        KERNEL=="js*", ACTION=="add", RUN+="/lib/udev/jscal-restore %E{DEVNAME}"
 
90
 
 
91
The following rule forces flaky Acrux gamepads to stay awake:
 
92
        KERNEL=="js*", ACTION=="add", ATTRS{name}=="ACRUX USB GAMEPAD 8116", RUN+="/bin/sleep 5000 < %p"
 
93
(This should only be necessary on kernels older than 2.6.39-rc1.)
 
94
 
 
95
The following rule configures a Mouse Systems mouse on the first
 
96
serial port:
 
97
        KERNEL=="ttyS0", ACTION=="add", RUN+="/usr/bin/inputattach --daemon -msc %p"
 
98
If you need to wait for /usr you can adapt the recipe above.
 
99
 
 
100
The following rules configures a Wacom W8001 devices on a Fujitsu
 
101
T2010[2]:
 
102
        SUBSYSTEM=="tty", KERNEL=="ttyS[0-9]*", ATTRS{id}=="FUJ02e5", ACTION=="add", RUN+="/usr/bin/inputattach --daemon --baud 19200 --w8001 /dev/%k"
 
103
 
 
104
 
 
105
Contributors
 
106
------------
 
107
 
 
108
The following people have contributed to this release:
 
109
* Johann Walles: jscal jitter tolerance.
 
110
* Dr. László Kaján: button and axis remapping.
 
111
* Sebastian Siewior: EVIOCGBIT correction.
 
112
* Krzysztof A. Sobiecki: improvements to the button and axis remapping
 
113
  functions.
 
114
* Claudio Nieder: Sahara Touch-iT213 support.
 
115
* Florian Fainelli: evtest fixes.
 
116
* Alexander Clouter: W8001 support.
 
117
* Roberto Neri: much discussion, and fixes and improvements to
 
118
  jscal-store/jscal-restore and the udev rules given above.
 
119
* Jean Delvare: inputattach improvements, TAOS support.
 
120
 
 
121
 
 
122
License
 
123
-------
 
124
 
 
125
The linuxconsole tools are
 
126
        Copyright © 1996-2005 Vojtech Pavlik
 
127
        Copyright © 2001 Romain Dolbeau
 
128
        Copyright © 2001 Oliver Hamann
 
129
        Copyright © 2001-2002 Johann Deneux
 
130
        Copyright © 2001 Arndt Schoenewald
 
131
        Copyright © 2008-2011 Stephen Kitt
 
132
 
 
133
 
 
134
This program is free software; you can redistribute it and/or modify
 
135
it under the terms of the GNU General Public License as published by
 
136
the Free Software Foundation; either version 2 of the License, or (at
 
137
your option) any later version.
 
138
 
 
139
This program is distributed in the hope that it will be useful, but
 
140
WITHOUT ANY WARRANTY; without even the implied warranty of
 
141
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 
142
General Public License for more details.
 
143
 
 
144
You should have received a copy of the GNU General Public License
 
145
along with this program; if not, write to the Free Software
 
146
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301,
 
147
USA.
 
148
 
 
149
 
 
150
The GNU General Public License version 2 is provided in the COPYING
 
151
file.