alsa-utils/seq/aplaymidi/aplaymidi.1
Clemens Ladisch 8f7b63be04 aplaymidi: clarify multi-port documentation
The man page did not document what happens when multiple ports are
specified; this could be misinterpreted as the events being duplicated
so that they are played on all ports simultaneously.  As suggested by
Peter Billam, clarify that these ports are only used for multi-port MIDI
files.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
2011-11-02 20:03:42 +01:00

63 lines
1.4 KiB
Groff

.TH APLAYMIDI 1 "2 Nov 2011"
.SH NAME
aplaymidi \- play Standard MIDI Files
.SH SYNOPSIS
.B aplaymidi
\-p client:port[,...] [\-d delay] midifile ...
.SH DESCRIPTION
.B aplaymidi
is a command-line utility that plays the specified MIDI file(s) to one
or more ALSA sequencer ports.
.SH OPTIONS
.TP
.I \-h, \-\-help
Prints a list of options.
.TP
.I \-V, \-\-version
Prints the current version.
.TP
.I \-l, \-\-list
Prints a list of possible output ports.
.TP
.I \-p, \-\-port=client:port,...
Sets the sequencer port(s) to which the events in the MIDI file(s) are
sent.
A client can be specified by its number, its name, or a prefix of its
name. A port is specified by its number; for port 0 of a client, the
":0" part of the port specification can be omitted.
Multiple ports can be specified to allow playback of MIDI file(s) that
contain events for multiple devices (ports), as specified by "Port
Number" meta events.
For compatibility with
.B pmidi(1),
the port specification is taken from the
.I ALSA_OUTPUT_PORTS
environment variable if none is given on the command line.
.TP
.I \-d, \-\-delay=seconds
Specifies how long to wait after the end of each MIDI file,
to allow the last notes to die away.
.SH BUGS
.B aplaymidi
handles "Port Number" meta events, but not "Port Name" meta events.
.SH SEE ALSO
pmidi(1)
.br
playmidi(1)
.SH AUTHOR
Clemens Ladisch <clemens@ladisch.de>