Blame amidi/amidi.1

Packit 229ac0
.TH AMIDI 1 "30 Aug 2016"
Packit 229ac0
Packit 229ac0
.SH NAME
Packit 229ac0
amidi \- read from and write to ALSA RawMIDI ports
Packit 229ac0
Packit 229ac0
.SH SYNOPSIS
Packit 229ac0
\fBamidi\fP [\fI\-p port\fP] [\fI\-s file\fP | \fI\-S data\fP]
Packit 229ac0
[\fI\-r file\fP] [\fI\-d\fP] [\fI\-t seconds\fP] [\fI\-a\fP]
Packit 229ac0
Packit 229ac0
.SH DESCRIPTION
Packit 229ac0
.B amidi
Packit 229ac0
is a command-line utility which allows one to receive and send
Packit 229ac0
SysEx (system exclusive) data from/to external MIDI devices.
Packit 229ac0
It can also send any other MIDI commands.
Packit 229ac0
Packit 229ac0
.B amidi
Packit 229ac0
handles only files containing raw MIDI commands, without timing
Packit 229ac0
information.
Packit 229ac0
.B amidi
Packit 229ac0
does not support Standard MIDI (.mid) files, but
Packit 229ac0
.B aplaymidi(1)
Packit 229ac0
and
Packit 229ac0
.B arecordmidi(1)
Packit 229ac0
do.
Packit 229ac0
Packit 229ac0
.SH OPTIONS
Packit 229ac0
Packit 229ac0
Use the
Packit 229ac0
.I \-h,
Packit 229ac0
.I \-V,
Packit 229ac0
.I \-l,
Packit 229ac0
or
Packit 229ac0
.I \-L
Packit 229ac0
options to display information;
Packit 229ac0
or use at least one of the
Packit 229ac0
.I \-s,
Packit 229ac0
.I \-r,
Packit 229ac0
.I \-S,
Packit 229ac0
or
Packit 229ac0
.I \-d
Packit 229ac0
options to specify what data to send or receive.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-h, \-\-help
Packit 229ac0
Help: prints a list of options.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-V, \-\-version
Packit 229ac0
Prints the current version.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-l, \-\-list\-devices
Packit 229ac0
Prints a list of all hardware MIDI ports.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-L, \-\-list\-rawmidis
Packit 229ac0
Prints all RawMIDI definitions.
Packit 229ac0
(used when debugging configuration files)
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-p, \-\-port=name
Packit 229ac0
Sets the name of the ALSA RawMIDI port to use.
Packit 229ac0
If this is not specified,
Packit 229ac0
.B amidi
Packit 229ac0
uses the default port defined in the configuration file
Packit 229ac0
(the default for this is port 0 on card 0, which may not exist).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-s, \-\-send=filename
Packit 229ac0
Sends the contents of the specified file to the MIDI port.
Packit 229ac0
The file must contain raw MIDI commands (e.g. a .syx file);
Packit 229ac0
for Standard MIDI (.mid) files, use
Packit 229ac0
.B aplaymidi(1).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-r, \-\-receive=filename
Packit 229ac0
Writes data received from the MIDI port into the specified file.
Packit 229ac0
The file will contain raw MIDI commands (such as in a .syx file);
Packit 229ac0
to record a Standard MIDI (.mid) file, use
Packit 229ac0
.B arecordmidi(1).
Packit 229ac0
Packit 229ac0
.B amidi
Packit 229ac0
will filter out any Active Sensing and Clock bytes (FEh, F8h), unless the
Packit 229ac0
.I \-a
Packit 229ac0
or
Packit 229ac0
.I \-c
Packit 229ac0
options have been given.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-S, \-\-send\-hex="..."
Packit 229ac0
Sends the bytes specified as hexadecimal numbers to the MIDI port.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-d, \-\-dump
Packit 229ac0
Prints data received from the MIDI port as hexadecimal bytes.
Packit 229ac0
Active Sensing and Clock bytes (FEh, F8h) will not be shown, unless the
Packit 229ac0
.I \-a
Packit 229ac0
or
Packit 229ac0
.I \-c
Packit 229ac0
options have been given.
Packit 229ac0
Packit 229ac0
This option is useful for debugging.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-t, \-\-timeout=seconds
Packit 229ac0
Stops receiving data when no data has been received for the specified
Packit 229ac0
amount of time.
Packit 229ac0
Packit 229ac0
If this option has not been given, you must press Ctrl+C (or kill
Packit 229ac0
.B amidi\fR)
Packit 229ac0
to stop receiving data.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-a, \-\-active\-sensing
Packit 229ac0
Does not ignore Active Sensing bytes (FEh) when saving or printing
Packit 229ac0
received MIDI commands.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-c, \-\-clock
Packit 229ac0
Does not ignore Clock bytes (F8h) when saving or printing received
Packit 229ac0
MIDI commands.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.I \-i, \-\-sysex-interval=mseconds
Packit 229ac0
Adds a delay in between each SysEx message sent to a device. It is
Packit 229ac0
useful when sending firmware updates via SysEx messages to a remote
Packit 229ac0
device.
Packit 229ac0
Packit 229ac0
.SH EXAMPLES
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.B amidi \-p hw:0 \-s my_settings.syx
Packit 229ac0
will send the MIDI commands in
Packit 229ac0
.I my_settings.syx
Packit 229ac0
to port
Packit 229ac0
.I hw:0.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.B amidi \-p hw:1,0,0 -s firmware.syx \-i 100
Packit 229ac0
will send the MIDI commands in
Packit 229ac0
.I firmware.syx
Packit 229ac0
to port
Packit 229ac0
.I hw:1,0,0
Packit 229ac0
with 100 milliseconds delay in between each SysEx message.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.B amidi \-S 'F0 43 10 4C 00 00 7E 00 F7'
Packit 229ac0
sends an XG Reset to the default port.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.B amidi \-p hw:1,2 \-S F0411042110C000000000074F7 \-r dump.syx \-t 1
Packit 229ac0
sends a \(lqParameter Dump Request\(rq to a GS device, saves the received
Packit 229ac0
parameter data to the file
Packit 229ac0
.I dump.syx,
Packit 229ac0
and stops after the device has finished sending data
Packit 229ac0
(when no data has been received for one second).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
.B amidi \-p virtual \-d
Packit 229ac0
creates a virtual RawMIDI port and prints all data sent to this port.
Packit 229ac0
Packit 229ac0
.SH FILES
Packit 229ac0
.I /usr/share/alsa/alsa.conf
Packit 229ac0
default rawmidi definitions
Packit 229ac0
.br
Packit 229ac0
.I /etc/asound.conf
Packit 229ac0
system\-wide rawmidi definitions
Packit 229ac0
.br
Packit 229ac0
.I ~/.asoundrc
Packit 229ac0
user specific rawmidi definitions
Packit 229ac0
Packit 229ac0
.SH SEE ALSO
Packit 229ac0
aplaymidi(1)
Packit 229ac0
.br
Packit 229ac0
arecordmidi(1)
Packit 229ac0
Packit 229ac0
.SH AUTHOR
Packit 229ac0
Clemens Ladisch <clemens@ladisch.de>