tarina

git clone https://git.tarina.org/tarina
Log | Files | Refs | README | LICENSE

amidi.1 (3897B)


      1 .TH AMIDI 1 "30 Aug 2016"
      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 and Clock bytes (FEh, F8h), unless the
     84 .I \-a
     85 or
     86 .I \-c
     87 options have been given.
     88 
     89 .TP
     90 .I \-S, \-\-send\-hex="..."
     91 Sends the bytes specified as hexadecimal numbers to the MIDI port.
     92 
     93 .TP
     94 .I \-d, \-\-dump
     95 Prints data received from the MIDI port as hexadecimal bytes.
     96 Active Sensing and Clock bytes (FEh, F8h) will not be shown, unless the
     97 .I \-a
     98 or
     99 .I \-c
    100 options have been given.
    101 
    102 This option is useful for debugging.
    103 
    104 .TP
    105 .I \-t, \-\-timeout=seconds
    106 Stops receiving data when no data has been received for the specified
    107 amount of time.
    108 
    109 If this option has not been given, you must press Ctrl+C (or kill
    110 .B amidi\fR)
    111 to stop receiving data.
    112 
    113 .TP
    114 .I \-a, \-\-active\-sensing
    115 Does not ignore Active Sensing bytes (FEh) when saving or printing
    116 received MIDI commands.
    117 
    118 .TP
    119 .I \-c, \-\-clock
    120 Does not ignore Clock bytes (F8h) when saving or printing received
    121 MIDI commands.
    122 
    123 .TP
    124 .I \-i, \-\-sysex-interval=mseconds
    125 Adds a delay in between each SysEx message sent to a device. It is
    126 useful when sending firmware updates via SysEx messages to a remote
    127 device.
    128 
    129 .SH EXAMPLES
    130 
    131 .TP
    132 .B amidi \-p hw:0 \-s my_settings.syx
    133 will send the MIDI commands in
    134 .I my_settings.syx
    135 to port
    136 .I hw:0.
    137 
    138 .TP
    139 .B amidi \-p hw:1,0,0 -s firmware.syx \-i 100
    140 will send the MIDI commands in
    141 .I firmware.syx
    142 to port
    143 .I hw:1,0,0
    144 with 100 milliseconds delay in between each SysEx message.
    145 
    146 .TP
    147 .B amidi \-S 'F0 43 10 4C 00 00 7E 00 F7'
    148 sends an XG Reset to the default port.
    149 
    150 .TP
    151 .B amidi \-p hw:1,2 \-S F0411042110C000000000074F7 \-r dump.syx \-t 1
    152 sends a \(lqParameter Dump Request\(rq to a GS device, saves the received
    153 parameter data to the file
    154 .I dump.syx,
    155 and stops after the device has finished sending data
    156 (when no data has been received for one second).
    157 
    158 .TP
    159 .B amidi \-p virtual \-d
    160 creates a virtual RawMIDI port and prints all data sent to this port.
    161 
    162 .SH FILES
    163 .I /usr/share/alsa/alsa.conf
    164 default rawmidi definitions
    165 .br
    166 .I /etc/asound.conf
    167 system\-wide rawmidi definitions
    168 .br
    169 .I ~/.asoundrc
    170 user specific rawmidi definitions
    171 
    172 .SH SEE ALSO
    173 aplaymidi(1)
    174 .br
    175 arecordmidi(1)
    176 
    177 .SH AUTHOR
    178 Clemens Ladisch <clemens@ladisch.de>