Document '-r' switch and switch README to proper markdown.
authorAlexander Koenig <alex@lisas.de>
Sat, 7 May 2016 08:33:27 +0000 (10:33 +0200)
committerAlexander Koenig <alex@lisas.de>
Sat, 7 May 2016 08:33:27 +0000 (10:33 +0200)
README
aseqjoy.1.in

diff --git a/README b/README
index 87f7b9f..d9a6480 100644 (file)
--- a/README
+++ b/README
@@ -1,36 +1,42 @@
-aseqjoy is a simple Joystick to ALSA MIDI Sequencer Converter
--------------------------------------------------------------
+aseqjoy - a simple joystick to ALSA MIDI sequencer converter
+============================================================
 
-Copyright 2003 by Alexander König - alex@lisas.de
-License: GPL V2 - see the file COPYING
+Copyright 2003-2016 by Alexander König - alex@lisas.de
+
+License: GNU General Public License Version 2 or (at your option) any later 
+version - for details please refer to the file [COPYING](./COPYING) included 
+with the aseqjoy source code.
 
 What it does: Each axis of the joystick device is mapped to a specific MIDI 
 controller. Moving the joystick along an axis will cause aseqjoy to emit
 MIDI controller messages via ALSA's sequencer API. The value of the controller
 message represents the joystick's position along the axis (eg 'left' -> 0, 
-'middle' -> 63, 'right' -> 127).
+'middle' -> 63, 'right' -> 127). Note that you can run aseqjoy with the '-r'
+commandline switch to use fine MIDI control change messages instead (with 14
+bit resolution).
 
 aseqjoy uses the ALSA sequencer API to emit the MIDI events. Therefor it
 creates and output port named after joystick used. You can then use for example
-aconnect (from alsa-utils) or Robert Ham's alsa-patch-bay to connect an aseqjoy
-instance to an input port of your choice. 
+aconnect (from alsa-utils), QjackCtl or Robert Ham's alsa-patch-bay to connect
+an aseqjoy instance to an input port of your choice. 
 
-Requirements:
--------------
+Requirements
+------------
 
-- Linux System with correctly configured Joystick support.
-- A working ALSA 0.9 installation.
+* Current Linux system with joystick input drivers and ALSA sound system 
+  properly configured.
 
-Links:
-------
+Links
+-----
 
-aseqjoy homepage: http://terminatorX.cx/aseqjoy.html
-ALSA homepage: http://www.alsa-project.org
-Joystick utils: http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/
-ALSA-patch-bay: http://pkl.net/~node/alsa-patch-bay.html
+* [aseqjoy homepage](https://terminatorx.org/addons/)
+* [ALSA homepage](http://www.alsa-project.org)
+* [Joystick utils](http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/)
+* [QjackCtl](http://qjackctl.sourceforge.net/)
+* [ALSA-patch-bay](http://pkl.net/~node/alsa-patch-bay.html)
 
-Howto:
-------
+Howto
+-----
 
 In some cases the joystick may not utilize the full range of available 
 controller values - in this case you should use "jscal" from the joystick
@@ -40,15 +46,15 @@ devices - so even after calibrating the device you might not always be able
 to reach "0" or "127" controller values - depending on the joystick you
 use.
 
-Start aseqjoy - if you have a working Joystick (Nr. 0 - use the -d switch to
+Start aseqjoy - if you have a working joystick (Nr. 0 - use the -d switch to
 select other joysticks) aseqjoy will detect that and map each axis of that 
 joystick to a controller from 10 on upwards:
 
-Axis -> Controller
-   0 -> 10
-   1 -> 11
-   2 -> 12
-   
+* Axis -> Controller 
+* 0 -> 10
+* 1 -> 11
+* 2 -> 12
+
 From now on aseqjoy emits events over the "Joystick0" output port. To make use
 of these events in another application use for example the alsa-patch-bay
 to connect that output port to another application's input sequencer port
index 4bc6b38..58e47e2 100644 (file)
@@ -1,4 +1,4 @@
-.TH aseqjoy "1" "March 2003" "aseqjoy @VERSION@" "User Commands"
+.TH aseqjoy "1" "May 2016" "aseqjoy @VERSION@" "User Commands"
 .SH NAME
 aseqjoy \- Joystick to ALSA MIDI Sequencer Converter
 .SH SYNOPSIS
@@ -9,12 +9,15 @@ Aseqjoy maps each axis of a joystick device to a specific MIDI
 controller. Moving the joystick along an axis will cause aseqjoy to emit
 MIDI controller messages via ALSA's sequencer API. The value of the controller
 message represents the joystick's position along the axis (eg \'left\' \-> 0, 
-\'middle\' \-> 63, \'right\' \-> 127).
+\'middle\' \-> 63, \'right\' \-> 127). Note that you can run aseqjoy with the 
+\fB\'-r\'\fR commandline switch to use fine MIDI control change messages instead 
+(with 14 bit resolution).
+
 
 Aseqjoy uses the ALSA sequencer API to emit the MIDI events. Therefor it
 creates and output port named after joystick used. You can then use for example
-\fBaconnect\fR or the \fBalsa-patch-bay\fR to connect an aseqjoy instance to an 
-input port of your choice.
+\fBaconnect\fR, \fBQjackCtrl\fR or the \fBalsa-patch-bay\fR to connect an aseqjoy 
+instance to an input port of your choice.
 
 \fBNote:\fR Some joysticks may have to be calibrated (with \fBjscal\fR) before 
 they can be used efficently. 
@@ -37,6 +40,10 @@ Select the MIDI controller ID for axis 0. As a default value aseqjoy will use
 .TP
 \fB\-1 [controller]\fR, \fB\-2 [controller]\fR, \fB\-3 [controller]\fR,
 Just like \fB\-0\fR this will set the controller IDs for axes 1, 2, 3.
+.TP
+\fB\-r\fR
+Use fine MIDI control change messsages instead (14 bit insstead of 7 bit 
+resolution).
 .SH OPERATION
 After aseqjoy has started successfully all motion detected by the selected 
 joystick device will cause MIDI controller messages to be emitted via the 
@@ -46,8 +53,12 @@ default values (10, 11, 12 ...) or the ones given as commandline options.
 Pressing a joystick button will cause aseqjoy to switch the MIDI channel. On
 startup channel '1' is selected. Pressing joystick button 2 will cause channel
 2 to be selected. Other buttons work accordingly.
+.SH LICENSE
+aseqjoy comes under the terms of the GNU General Public License Version 2 or 
+(at your option) any later version - for details please refer to the file 
+COPYING included with the aseqjoy source code.
 .SH AUTHOR
-Man page and software by Alexander König <alex@lisas.de>.
+Man page and software by Alexander Koenig <alex@lisas.de>.
 .SH "SEE ALSO"
 .LP 
 jscal(1), aconnect(1)