Adding a manpage - Alex
authorterminatorX <>
Wed, 26 Mar 2003 19:31:02 +0000 (19:31 +0000)
committerterminatorX <>
Wed, 26 Mar 2003 19:31:02 +0000 (19:31 +0000)
Makefile.am
README
aseqjoy.1.in [new file with mode: 0644]
configure.in

index f36cd51..6510b15 100644 (file)
@@ -6,3 +6,5 @@ CXXFLAGS=@CFLAGS@ @GTK_CFLAGS@ -D_REENTRANT
 bin_PROGRAMS = aseqjoy
 
 aseqjoy_SOURCES = aseqjoy.c
+
+man_MANS = aseqjoy.1
diff --git a/README b/README
index 9e6a981..9397b19 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,11 @@
-aseqjoy is a simple Joystick -> MIDI controller converter. 
+aseqjoy is a simple Joystick to ALSA MIDI Sequencer Converter
+-------------------------------------------------------------
+
+Copyright 2003 by Alexander König - alex@lisas.de
+License: GPL V2 - see the file COPYING
 
 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
+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).
@@ -12,19 +16,33 @@ the alsa-patch-bay to connect an aseqjoy instance to an input port of your
 choice. 
 
 Requirements:
+-------------
+
 - Linux System with correctly configured Joystick support.
 - A working ALSA 0.9 installation.
 
 Links:
+------
+
 aseqjoy homepage: http://terminatorX.cx/aseqjoy
 ALSA homepage: http://www.alsa-project.org
-Input Utils: http://.cz
-ALSA-patch-bay: http://
+Joystick utils: http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/
+ALSA-patch-bay: http://pkl.net/~node/alsa-patch-bay.html
 
 Howto:
-
-Start aseqjoy - if you have a working Joystick (Nr. 0) aseqjoy will detect
-that and each axis to a controller from 10 on upwards:
+------
+
+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
+pacakge (most distributions feature this package) to calibrate your joystick 
+before running aseqjoy. Note: Analog PC joysticks are no high-precision 
+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
+select other joysticks) aseqjoy will detect that and each axis to a controller
+from 10 on upwards:
 
 Axis -> Controller
    0 -> 10
diff --git a/aseqjoy.1.in b/aseqjoy.1.in
new file mode 100644 (file)
index 0000000..0b49cd5
--- /dev/null
@@ -0,0 +1,53 @@
+.TH aseqjoy "1" "March 2003" "aseqjoy @VERSION@" "User Commands"
+.SH NAME
+aseqjoy \- Joystick to ALSA MIDI Sequencer Converter
+.SH SYNOPSIS
+.B aseqjoy
+[\fIoptions\fR]
+.SH DESCRIPTION
+Aseqjoy maps each axis of the 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).
+
+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
+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. 
+.SH OPTIONS
+.TP
+\fB\-h\fR
+Display help info
+.TP
+\fB\-d [joystick]\fR
+Select the joystick to use for aseqjoy, where \fB[joystick]\fR is an integer value
+from from 0 to 3 effectivley selecting devices js0 to js3.
+.TP
+\fB\-v\fR
+Verbose mode - aseqjoy will output information about the MIDI events
+sent.
+.TP
+\fB\-0 [controller]\fR
+Select the MIDI controller ID for axis 0. As a default value aseqjoy will use
+10 + the axis ID, so for axis 0 that would be 10 + 0 = 10.
+.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.
+.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 
+corresponding ALSA sequencer output port. The controller IDs are either the
+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 AUTHOR
+Man page and software by Alexander König <alex@lisas.de>.
+.SH "SEE ALSO"
+.LP 
+jscal(1)
index 6cb7f3b..5db409a 100644 (file)
@@ -27,4 +27,4 @@ else
     AC_MSG_ERROR([** Coulnd'f find ALSA library libasound. **])
 fi
 
-AC_OUTPUT(Makefile)
+AC_OUTPUT(Makefile aseqjoy.1)