Document '-r' switch and switch README to proper markdown.
[aseqjoy.git] / aseqjoy.1.in
1 .TH aseqjoy "1" "May 2016" "aseqjoy @VERSION@" "User Commands"
2 .SH NAME
3 aseqjoy \- Joystick to ALSA MIDI Sequencer Converter
4 .SH SYNOPSIS
5 .B aseqjoy
6 [\fIoptions\fR]
7 .SH DESCRIPTION
8 Aseqjoy maps each axis of a joystick device to a specific MIDI 
9 controller. Moving the joystick along an axis will cause aseqjoy to emit
10 MIDI controller messages via ALSA's sequencer API. The value of the controller
11 message represents the joystick's position along the axis (eg \'left\' \-> 0, 
12 \'middle\' \-> 63, \'right\' \-> 127). Note that you can run aseqjoy with the 
13 \fB\'-r\'\fR commandline switch to use fine MIDI control change messages instead 
14 (with 14 bit resolution).
15
16
17 Aseqjoy uses the ALSA sequencer API to emit the MIDI events. Therefor it
18 creates and output port named after joystick used. You can then use for example
19 \fBaconnect\fR, \fBQjackCtrl\fR or the \fBalsa-patch-bay\fR to connect an aseqjoy 
20 instance to an input port of your choice.
21
22 \fBNote:\fR Some joysticks may have to be calibrated (with \fBjscal\fR) before 
23 they can be used efficently. 
24 .SH OPTIONS
25 .TP
26 \fB\-h\fR
27 Display help info
28 .TP
29 \fB\-d [joystick]\fR
30 Select the joystick to use for aseqjoy, where \fB[joystick]\fR is an integer value
31 from from 0 to 3 effectivley selecting devices js0 to js3.
32 .TP
33 \fB\-v\fR
34 Verbose mode - aseqjoy will output information about the MIDI events
35 sent.
36 .TP
37 \fB\-0 [controller]\fR
38 Select the MIDI controller ID for axis 0. As a default value aseqjoy will use
39 10 + the axis ID, so for axis 0 that would be 10 + 0 = 10.
40 .TP
41 \fB\-1 [controller]\fR, \fB\-2 [controller]\fR, \fB\-3 [controller]\fR,
42 Just like \fB\-0\fR this will set the controller IDs for axes 1, 2, 3.
43 .TP
44 \fB\-r\fR
45 Use fine MIDI control change messsages instead (14 bit insstead of 7 bit 
46 resolution).
47 .SH OPERATION
48 After aseqjoy has started successfully all motion detected by the selected 
49 joystick device will cause MIDI controller messages to be emitted via the 
50 corresponding ALSA sequencer output port. The controller IDs are either the
51 default values (10, 11, 12 ...) or the ones given as commandline options.
52
53 Pressing a joystick button will cause aseqjoy to switch the MIDI channel. On
54 startup channel '1' is selected. Pressing joystick button 2 will cause channel
55 2 to be selected. Other buttons work accordingly.
56 .SH LICENSE
57 aseqjoy comes under the terms of the GNU General Public License Version 2 or 
58 (at your option) any later version - for details please refer to the file 
59 COPYING included with the aseqjoy source code.
60 .SH AUTHOR
61 Man page and software by Alexander Koenig <alex@lisas.de>.
62 .SH "SEE ALSO"
63 .LP 
64 jscal(1), aconnect(1)