Adding a manpage - Alex
[aseqjoy.git] / aseqjoy.1.in
1 .TH aseqjoy "1" "March 2003" "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 the 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).
13
14 Aseqjoy uses the ALSA sequencer API to emit the MIDI events. Therefor it
15 creates and output port named after joystick used. You can then use for example
16 the \fBalsa-patch-bay\fR to connect an aseqjoy instance to an input port of your
17 choice.
18
19 \fBNote:\fR Some joysticks may have to be calibrated (with \fBjscal\fR) before 
20 they can be used efficently. 
21 .SH OPTIONS
22 .TP
23 \fB\-h\fR
24 Display help info
25 .TP
26 \fB\-d [joystick]\fR
27 Select the joystick to use for aseqjoy, where \fB[joystick]\fR is an integer value
28 from from 0 to 3 effectivley selecting devices js0 to js3.
29 .TP
30 \fB\-v\fR
31 Verbose mode - aseqjoy will output information about the MIDI events
32 sent.
33 .TP
34 \fB\-0 [controller]\fR
35 Select the MIDI controller ID for axis 0. As a default value aseqjoy will use
36 10 + the axis ID, so for axis 0 that would be 10 + 0 = 10.
37 .TP
38 \fB\-1 [controller]\fR, \fB\-2 [controller]\fR, \fB\-3 [controller]\fR,
39 Just like \fB\-0\fR this will set the controller IDs for axes 1, 2, 3.
40 .SH OPERATION
41 After aseqjoy has started successfully all motion detected by the selected 
42 joystick device will cause MIDI controller messages to be emitted via the 
43 corresponding ALSA sequencer output port. The controller IDs are either the
44 default values (10, 11, 12 ...) or the ones given as commandline options.
45
46 Pressing a joystick button will cause aseqjoy to switch the MIDI channel. On
47 startup channel '1' is selected. Pressing joystick button 2 will cause channel
48 2 to be selected. Other buttons work accordingly.
49 .SH AUTHOR
50 Man page and software by Alexander K├Ânig <alex@lisas.de>.
51 .SH "SEE ALSO"
52 .LP 
53 jscal(1)