summaryrefslogtreecommitdiff
path: root/audio/stymulator/files/ymplayer.1
diff options
context:
space:
mode:
Diffstat (limited to 'audio/stymulator/files/ymplayer.1')
-rw-r--r--audio/stymulator/files/ymplayer.134
1 files changed, 34 insertions, 0 deletions
diff --git a/audio/stymulator/files/ymplayer.1 b/audio/stymulator/files/ymplayer.1
new file mode 100644
index 000000000000..5d5d5bfd2da1
--- /dev/null
+++ b/audio/stymulator/files/ymplayer.1
@@ -0,0 +1,34 @@
+.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.