Browse Source

Add man page

master
Damien Goutte-Gattat 9 years ago
parent
commit
2b49650d06
  1. 2
      Makefile.am
  2. 2
      configure.ac
  3. 1
      man/Makefile.am
  4. 87
      man/asysex.1

2
Makefile.am

@ -1,4 +1,4 @@
SUBDIRS = lib src
SUBDIRS = lib src man
ACLOCAL_AMFLAGS = -I m4 --install

2
configure.ac

@ -25,7 +25,7 @@ AM_PATH_ALSA([1.0.0],
[Define whether to use the ALSA MIDI API.])])
dnl Output files
AC_CONFIG_FILES([Makefile lib/Makefile src/Makefile])
AC_CONFIG_FILES([Makefile lib/Makefile src/Makefile man/Makefile])
AC_OUTPUT
dnl Summary

1
man/Makefile.am

@ -0,0 +1 @@
dist_man_MANS = asysex.1

87
man/asysex.1

@ -0,0 +1,87 @@
.TH ASYSEX 02/04/2012 "asysex"
.SH NAME
asysex - A SysEx Utility
.SH SYNOPSIS
.SY asysex
.RB [ \-h | --help ]
.RB [ \-v | --version ]
.RB [ \-p | --port
.IR port ]
.RB [ \-I | --inquiry ]
.YS
.SH DESCRIPTION
.PP
.B asysex
reads hexadecimal SysEx messages from standard input, sents
them to a specified MIDI port and reads back and prints out
a single SysEx message.
.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -v ", " --version
Display the version message.
.TP
.BR -p ", " --port " " \fIport\fR
Connect to the specified MIDI \fIport\fR.
.TP
.BR -I ", " --inquiry
Identify the connected MIDI device and exit.
.SH INPUT FORMAT
.PP
.B asysex
expects hexadecimal input. All characters others than [0-9],
[a-f] and [A-F] are ignored. The \(aq#\(aq character
introduces a comment which lasts until the next end-of-line,
and in which all characters are ignored, including
hexadecimal characters. Two hexadecimal characters (even
separated by other characters or a comment) are read as a
single byte.
.PP
The first byte \fBmust\fR be \(aqF0\(aq (\(lqSysEx message
begin\(rq), and the last byte \fBmust\fR be \(aqF7\(aq
(\(lqSysEx message end\(rq).
.PP
The following examples are valid input:
.sp
.nf
F0 7F000401007F F7 # Set Master Volume
.fi
.sp
.nf
# Send a Program Parameter Dump Request to a Korg device
F0 # Begin of SysEx message
42 # Korg ID
30 # Global MIDI channel is 1
7A # End of SysEx header
1C # Function is Program Parameter Dump
2 # Dump a single Program
1 # Select Bank B
09 # Select Program 10
00 # Reserved
F7 # End of SysEx message
.fi
.SH REPORTING BUGS
.PP
Report bugs to
.MT dgouttegattat@incenp.org
Damien Goutte-Gattat
.ME .
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2012 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or
.UR http://www.gnu.org/licenses/gpl.html
.UE .
Loading…
Cancel
Save