Skip to content

Commit

Permalink
aseqsend: Refine man page
Browse files Browse the repository at this point in the history
Make man page a bit nicer; reformatting and setting bold/italic
properly, typo fixes, and adding a few more words and sections.

Signed-off-by: Takashi Iwai <[email protected]>
  • Loading branch information
tiwai committed Jul 23, 2024
1 parent df68ec3 commit dec1ef0
Showing 1 changed file with 29 additions and 18 deletions.
47 changes: 29 additions & 18 deletions seq/aseqsend/aseqsend.1
Original file line number Diff line number Diff line change
@@ -1,55 +1,63 @@
.TH ASEQSEND 1 "11 Mar 2024"

.SH NAME
.B aseqsend
\- send arbitrary messages to selected ALSA MIDI seqencer port
aseqsend \- send arbitrary messages to selected ALSA MIDI seqencer port

.SH SYNOPSIS
aseqsend \-p client:port -s file-name|"hex encoded byte-string"
\fBaseqsend\fP \-p client:port -s file-name
.br
\fBaseqsend\fP \-p client:port "hex encoded byte-string"

.SH DESCRIPTION
.B aseqsend
is a command-line utility which allows one to send SysEx (system exclusive) data to ALSA MIDI seqencer port.
\fBaseqsend\fP is a command-line utility which allows one to send
SysEx (system exclusive) data to ALSA MIDI sequencer port.
It can also send any other MIDI commands.
Messages to be send can be given in the last argument as hex encoded byte string or can be read from raw binary file.
When sending several SysEx messages at once there is a delay of 1ms after each message as deafult and can be set to different value with option \-i.
Messages to be sent can be given in the last argument as hex encoded
byte string or can be read from raw binary file.
When sending several SysEx messages at once there is a delay of 1ms
after each message as default and can be set to different value with
option \-i.

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.

\fBaseqsend\fP can send UMP packets as MIDI 2.0 device by specifying
via \-u option as well, while the default operation is the legacy MIDI
1.0 byte stream.

.SH OPTIONS

.TP
\-h, \-\-help
\fI\-h, \-\-help\fP
Prints a list of options.

.TP
\-V, \-\-version
\fI\-V, \-\-version\fP
Prints the current version.

.TP
\-l, \-\-list
\fI\-l, \-\-list\FP
Prints a list of possible output ports.

.TP
\-v, \-\-verbose
\fI\-v, \-\-verbose\fP
Prints number of bytes actually sent

.TP
\-p, -\-port=client:port
\fI\-p, -\-port=client:port\fP
Target port by number or name

.TP
\-s, \-\-file=filename
\fI\-s, \-\-file=filename\fP
Send raw binary data from given file name

.TP
\-i, \-\-interval=msec
Interval between SysEx messages in miliseconds
\fI\-i, \-\-interval=msec\fP
Interval between SysEx messages in milliseconds

.TP
\-u, \-\-ump=version
\fI\-u, \-\-ump=version\fP
Specify the MIDI version. 0 for the legacy MIDI 1.0 (default),
1 for UMP MIDI 1.0 protocol and 2 for UMP MIDI 2.0 protocol.

Expand All @@ -58,9 +66,12 @@ reads the input as raw UMP packets, 4 each byte in big endian.

.SH EXAMPLES

aseqsend -p 128:0 "F0 41 10 00 00 64 12 18 00 21 06 59 41 59 4E F7"
\fBaseqsend -p 128:0 "F0 41 10 00 00 64 12 18 00 21 06 59 41 59 4E F7"\fP

\fBaseqsend -p 128:0 -s I7BulkDump.syx\fP

aseqsend -p 128:0 -s I7BulkDump.syx
.SH SEE ALSO
\fBaseqdump(1)\fP

.SH AUTHOR
Miroslav Kovac <[email protected]>

0 comments on commit dec1ef0

Please sign in to comment.