Blame amidi/amidi.1

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