You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
3.1 KiB
112 lines
3.1 KiB
.TH ASYSEX 31/01/2013 "kmxtool"
|
|
|
|
.SH NAME
|
|
kmxtool - KORG microX Utility
|
|
|
|
.SH SYNOPSIS
|
|
.SY kmxtool
|
|
.RB [ \-h | --help ]
|
|
.RB [ \-v | --version ]
|
|
.RB [ \-p | --port
|
|
.IR port ]
|
|
.RB [ \-s | --status ]
|
|
.RB [ \-L | --list-programs ]
|
|
.RB [ \-d | --dump-data
|
|
.IR id ]
|
|
.RB [ \-l | --load-data
|
|
.IR id ]
|
|
.YS
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
.B kmxtool
|
|
interacts with a connected KORG microX synthesizer. It can
|
|
query the current status of the synth, dump a memory slot
|
|
(program, combination, multi...) to standard output, and
|
|
load a program (or combination, multi...) from standard
|
|
input to a memory slot.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR -h ", " --help
|
|
Display the help message.
|
|
.TP
|
|
.BR -v ", " --version
|
|
Display the version message.
|
|
.TP
|
|
.BR -p ", " --port " " \fIport\fR
|
|
Connect to the specified MIDI \fIport\fR (any port name
|
|
that can be recognized by any of the available MIDI
|
|
backends, e.g. \fI/dev/midi00\fR for the OSS backend or
|
|
\fIhw:1,0,0\fR for the ALSA backend).
|
|
|
|
If not specified, a \fIDevice Inquiry\fR message is sent
|
|
to all available MIDI ports to detect a microX synthesizer.
|
|
|
|
.TP
|
|
.BR -s ", " --status
|
|
Print the current status of the synthesizer. This is
|
|
the default mode of operation.
|
|
.TP
|
|
.BR -L ", " --list-programs
|
|
Print a list of all programs in all banks.
|
|
.TP
|
|
.BR -d ", " --dump-data " " \fIid\fR
|
|
Dump the specified memory slot to standard output.
|
|
.TP
|
|
.BR -l ", " --load-data " " \fIid\fR
|
|
Load data read from standard input to the specified
|
|
memory slot.
|
|
|
|
.SH MEMORY SLOT NAMES
|
|
.PP
|
|
A memory slot \fIid\fR consists of one letter indicating the
|
|
type of memory (\(aqP\(aq for programs, \(aqC\(aq for
|
|
combinations, \(aqM\(aq for multis, \(aqD\(aq for drumkits,
|
|
\(aqA\(aq for arpeggio patterns, and \(aqE\(aq for external
|
|
controllers sets), one letter indicating the bank (only for
|
|
programs and combinations), and up to three decimal digits
|
|
indicating the slot number (counting from one, not zero).
|
|
|
|
.PP
|
|
Replacing the slot number by an asterisk (\(aq*\(aq) instructs
|
|
.B kmxtool
|
|
to dump all slots in the given bank (for programs and
|
|
combinations) or all slots of the given type (for multis,
|
|
drumkits, arpeggio patterns and external controllers sets).
|
|
For programs and combinations, replacing the bank letter by
|
|
an asterisk instructs
|
|
.B kmxtool
|
|
to dump all programs or combinations in all banks.
|
|
|
|
.SH INPUT FORMAT
|
|
.PP
|
|
.B kmxtool
|
|
expects hexadecimal input. All characters others than [0-9],
|
|
[a-f] and [A-F] are ignored. The \(aq#\(aq character
|
|
introduces a comment which lasts until the next end-of-line,
|
|
and in which all characters are ignored, including
|
|
hexadecimal characters. Two hexadecimal characters (even
|
|
separated by other characters or a comment) are read as a
|
|
single byte.
|
|
.PP
|
|
.B kmxtool
|
|
can read hexadecimal input in the hexdump \(lqcanonical hex+ASCII\(rq
|
|
format, and prints the dumped data in that format.
|
|
|
|
.SH REPORTING BUGS
|
|
.PP
|
|
Report bugs to
|
|
.MT dgouttegattat@incenp.org
|
|
Damien Goutte-Gattat
|
|
.ME .
|
|
|
|
.SH COPYRIGHT
|
|
.ad l
|
|
.PP
|
|
Copyright \(co 2012,2013,2016 Damien Goutte-Gattat
|
|
.PP
|
|
This program is released under the GNU General Public License.
|
|
See the COPYING file in the source distribution or
|
|
.UR http://www.gnu.org/licenses/gpl.html
|
|
.UE .
|