Kino README_jogshuttle


This file describes the support Kino have for using "Jog Shuttles" for
input. Jog/Shuttles are devices made especially for working with streams of
data, such as Video or Audio.

What devices are supported
--------------------------

Kino has explcit support for several USB Jog/Shuttle devices:
Contour ShuttlePro (various versions)
Contour ShuttleXPress
JLCooper MCS3
Griffin PowerMate
X-Keys Editor

The "Sony PCDA-J1/A USB Jog Shuttle" controller has also been
known to work at some point.

In theory, Kino should work with any (usb) Jog/Shuttle devices that supports
the USB HID v1.10 Pointer profile. If you use Kino succesfully with a device
other than the above, please let the kino developers know what
device and what your experience was by mailing the Kino developer list on
Kino-dev@lists.sourceforge.net


How to use the Jog/Shuttle devices
----------------------------------

If you have a working USB system (e.g. an USB mouse is connected and works),
you should be able to simply plug in the Jog/Shuttle device. This should
append something like the following to your systems log (/var/log/messages
most often):

Dec 10 19:40:59 localhost input: Contour Design Jog and Shuttle  as /class/input/input17
Dec 10 19:40:59 localhost input: USB HID v1.00 Device [Contour Design Jog and Shuttle ] on usb-0000:02:00.0-2.3

The exact text and number of messages may wary. At this point, some systems
needs to load the "evdev" driver. You can do this, as root, by issuing the
command
#modprobe evdev

Your system can be set up to do this automatically - it is outside the scope
of this document to explain how to do this.

Now you can start Kino, go to File|Preferences|Jog/Shuttle. You need to tick
on "Enable Jog/Shuttle input" Restart Kino for the changes to take effect.
You must have read access to the device file (typically one of
/dev/input/eventN).

At this point you should have Jog/Shuttle support in Kino. You can use the
preferences dialog to change the mappings between the buttons and actions in
Kino.


Udev (formerly Hotplug) support
-------------------------------

If your systems supports udev, Kino supplies a udev rules file that configures
your system to give all users read permission to the jog/shuttle evdev device
file and to notify a running kino process when you have inserted a supported
Jog/Shuttle.

You can do this, by configuring kino like this:
./configure --sysconfdir=/etc
or
./configure --with-udev-rules-dir=/etc/udev/rules.d

After you have installed kino, you need to tell your system to reload the
rules. This varies by distribution and may require restarting of the udev
service or running some special utility. A reboot suffices as a last resort.


Troubleshooting
---------------
If you have trouble getting your Jog/Shuttle to work, please send a bug
report to kino-dev@lists.sourceforge.net . Make sure to include information
about what device your are trying to get to work, your distribution, kernel
version (the output of uname -a), and relevant log information.
