Browse Source

Add man page for kmxtool

master
Damien Goutte-Gattat 9 years ago
parent
commit
ac8a20ab9c
  1. 2
      configure.ac
  2. 2
      man/Makefile.am
  3. 88
      man/kmxtool.1.in

2
configure.ac

@ -48,7 +48,7 @@ AC_SUBST([DEFAULT_MIDI_PORT], [$midi_default_port])
dnl Output files
AC_CONFIG_FILES([Makefile lib/Makefile src/Makefile
man/Makefile man/asysex.1])
man/Makefile man/asysex.1 man/kmxtool.1])
AC_OUTPUT
dnl Summary

2
man/Makefile.am

@ -1 +1 @@
dist_man_MANS = asysex.1
dist_man_MANS = asysex.1 kmxtool.1

88
man/kmxtool.1.in

@ -0,0 +1,88 @@
.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 [ \-d | --dump-data
.IR id ]
.RB [ \-l | --load-data
.IR id ]
.RB [ \-t | --data-type
.IR type ]
.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.
If not specified, default is \(lq@DEFAULT_MIDI_PORT@\(rq.
.TP
.BR -s ", " --status
Print the current status of the synthesizer. This is
the default mode of operation.
.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.
.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 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 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 .
Loading…
Cancel
Save