Browse Source

Update documentation

Update online help and man page to reflect the recent changes in
command line syntax.
develop
Damien Goutte-Gattat 8 years ago
parent
commit
ff69d5911b
  1. 31
      man/kmxtool.1.in
  2. 7
      src/kmxtool.c

31
man/kmxtool.1.in

@ -14,8 +14,6 @@ kmxtool - KORG microX Utility
.IR id ]
.RB [ \-l | --load-data
.IR id ]
.RB [ \-t | --data-type
.IR type ]
.YS
.SH DESCRIPTION
@ -37,7 +35,8 @@ Display the version message.
.TP
.BR -p ", " --port " " \fIport\fR
Connect to the specified MIDI \fIport\fR.
If not specified, default is \(lq@DEFAULT_MIDI_PORT@\(rq.
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
@ -49,11 +48,27 @@ Dump the specified memory slot to standard output.
.BR -l ", " --load-data " " \fIid\fR
Load data read from standard input to the specified
memory slot.
.TP
.BR -t ", " --data-type " " \fItype\fR
Specify the type of memory slot to dump data from or to
load data into. \fItype\fR must be one of
.IR program ", " combination ", " multi ", " drumkit ", " arpeggio ", " extset .
.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

7
src/kmxtool.c

@ -57,14 +57,17 @@ Send/receive data to/from a connected microX synthesizer.\n");
");
puts("\
-p, --port PORT Specify MIDI port to use.\n\
-p, --port PORT Specify MIDI port to use. If\n\
unspecified, all available MIDI\n\
ports will be scanned to detect\n\
a microX synthesizer.\n\
");
puts("\
-s, --status Print device status (default).\n\
-L, --list-programs List all programs in all banks.\n\
-d, --dump-data ID Dump the specified slot.\n\
-l, --load-data ID Load program read from standard\n\
-l, --load-data ID Load data read from standard\n\
input into the specified slot.\n\
");

Loading…
Cancel
Save