amidi/amidi.1

   1 .TH AMIDI 1 "26 Jun 2006"
   2
   3 .SH NAME
   4 amidi \- read from and write to ALSA RawMIDI ports
   5
   6 .SH SYNOPSIS
   7 \fBamidi\fP [\fI\-p port\fP] [\fI\-s file\fP | \fI\-S data\fP]
   8 [\fI\-r file\fP] [\fI\-d\fP] [\fI\-t seconds\fP] [\fI\-a\fP]
   9
  10 .SH DESCRIPTION
  11 .B amidi
  12 is a command-line utility which allows one to receive and send
  13 SysEx (system exclusive) data from/to external MIDI devices.
  14 It can also send any other MIDI commands.
  15
  16 .B amidi
  17 handles only files containing raw MIDI commands, without timing
  18 information.
  19 .B amidi
  20 does not support Standard MIDI (.mid) files, but
  21 .B aplaymidi(1)
  22 and
  23 .B arecordmidi(1)
  24 do.
  25
  26 .SH OPTIONS
  27
  28 Use the
  29 .I \-h,
  30 .I \-V,
  31 .I \-l,
  32 or
  33 .I \-L
  34 options to display information;
  35 or use at least one of the
  36 .I \-s,
  37 .I \-r,
  38 .I \-S,
  39 or
  40 .I \-d
  41 options to specify what data to send or receive.
  42
  43 .TP
  44 .I \-h, \-\-help
  45 Help: prints a list of options.
  46
  47 .TP
  48 .I \-V, \-\-version
  49 Prints the current version.
  50
  51 .TP
  52 .I \-l, \-\-list\-devices
  53 Prints a list of all hardware MIDI ports.
  54
  55 .TP
  56 .I \-L, \-\-list\-rawmidis
  57 Prints all RawMIDI definitions.
  58 (used when debugging configuration files)
  59
  60 .TP
  61 .I \-p, \-\-port=name
  62 Sets the name of the ALSA RawMIDI port to use.
  63 If this is not specified,
  64 .B amidi
  65 uses the default port defined in the configuration file
  66 (the default for this is port 0 on card 0, which may not exist).
  67
  68 .TP
  69 .I \-s, \-\-send=filename
  70 Sends the contents of the specified file to the MIDI port.
  71 The file must contain raw MIDI commands (e.g. a .syx file);
  72 for Standard MIDI (.mid) files, use
  73 .B aplaymidi(1).
  74
  75 .TP
  76 .I \-r, \-\-receive=filename
  77 Writes data received from the MIDI port into the specified file.
  78 The file will contain raw MIDI commands (such as in a .syx file);
  79 to record a Standard MIDI (.mid) file, use
  80 .B arecordmidi(1).
  81
  82 .B amidi
  83 will filter out any Active Sensing bytes (FEh), unless the
  84 .I \-a
  85 option has been given.
  86
  87 .TP
  88 .I \-S, \-\-send\-hex="..."
  89 Sends the bytes specified as hexadecimal numbers to the MIDI port.
  90
  91 .TP
  92 .I \-d, \-\-dump
  93 Prints data received from the MIDI port as hexadecimal bytes.
  94 Active Sensing bytes (FEh) will not be shown, unless the
  95 .I \-a
  96 option has been given.
  97
  98 This option is useful for debugging.
  99
 100 .TP
 101 .I \-t, \-\-timeout=seconds
 102 Stops receiving data when no data has been received for the specified
 103 amount of time.
 104
 105 If this option has not been given, you must press Ctrl+C (or kill
 106 .B amidi\fR)
 107 to stop receiving data.
 108
 109 .TP
 110 .I \-a, \-\-active\-sensing
 111 Does not ignore Active Sensing bytes (FEh) when saving or printing
 112 received MIDI commands.
 113
 114 .SH EXAMPLES
 115
 116 .TP
 117 .B amidi \-p hw:0 \-s my_settings.syx
 118 will send the MIDI commands in
 119 .I my_settings.syx
 120 to port
 121 .I hw:0.
 122
 123 .TP
 124 .B amidi \-S 'F0 43 10 4C 00 00 7E 00 F7'
 125 sends an XG Reset to the default port.
 126
 127 .TP
 128 .B amidi \-p hw:1,2 \-S F0411042110C000000000074F7 \-r dump.syx \-t 1
 129 sends a \(lqParameter Dump Request\(rq to a GS device, saves the received
 130 parameter data to the file
 131 .I dump.syx,
 132 and stops after the device has finished sending data
 133 (when no data has been received for one second).
 134
 135 .TP
 136 .B amidi \-p virtual \-d
 137 creates a virtual RawMIDI port and prints all data sent to this port.
 138
 139 .SH FILES
 140 .I /usr/share/alsa/alsa.conf
 141 default rawmidi definitions
 142 .br
 143 .I /etc/asound.conf
 144 system\-wide rawmidi definitions
 145 .br
 146 .I ~/.asoundrc
 147 user specific rawmidi definitions
 148
 149 .SH SEE ALSO
 150 aplaymidi(1)
 151 .br
 152 arecordmidi(1)
 153
 154 .SH AUTHOR
 155 Clemens Ladisch <clemens@ladisch.de>