ports/audio/stymulator/files/ymplayer.1
Emanuel Haupt 429cc70389 - Fix a minor glitch in the OSS patches
- Provide manual pages
2010-03-28 10:45:00 +00:00

34 lines
1.2 KiB
Groff

.TH YMPLAYER "1" "March 2007" "0.21" "User Commands"
.SH NAME
.B ymplayer
- a curses based player for the YM chiptune format.
.SH DESCRIPTION
STYMulator is an Open Source (GPL License) player which plays music files in the YM chiptune format.
In particular the YM files are Yamaha YM2149 soundchip music data (registers) dumped from the ATARI 16-bit computers.
.PP
.B ymplayer
(part of STYMulator) is a console based player for this format. It uses the ncurses library for its user interface.
It originally came with ALSA for sound rendering, however this port has been patched to use OSS.
.SH SYNOPSIS
.B ymplayer
<input_ym_music_file>
.SH OPTIONS
.B ymplayer
has no options.
.PP
It requires a <input_ym_music_file> argument which is a relative or absolute path to
.I one
the YM music file.
.SH SEE ALSO
ym2wav(1)
.br
.SH AUTHOR
This manual page was written by Adam Cecile <gandalf@le-vert.net> and was modified by Emanuel Haupt <ehaupt@FreeBSD.org> for FreeBSD. OSS patches were provided by Pyraniton.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.