Package: sidplay
Version: 2.0.9-6
Severity: minor
Tags: patch
The documentation does not mention that sidplay uses the HVSC's
SongLength.txt file to end songs at the proper time nor does it
describe how to configure it. (As shipped by Debian, sidplay currently
plays sid tunes forever, but that's a a topic for another bug). The
documentation should also mention how to configure a default time to
truncate SIDs which are not listed in the database.
I have attached a patch that fixes those problems.
--- doc/en/sidplay2.1.orig 2011-05-01 21:41:05.000000000 -0700
+++ doc/en/sidplay2.1 2011-05-01 21:40:51.000000000 -0700
@@ -126,8 +126,18 @@
set sample buffer size.
.RS
-.SH NOTES
-Place for notes..
+.SH INI FILES
+Sidplay2 stores many useful options that cannot be configured from the command
line in a file called \fI~/.sidplay/sidplay2.ini\fR. For example, by default
sidplay2 does not know the duration of SID tunes and will play them forever.
However, this can be fixed easily by downloading the Songlength Database (SLDB)
from the High Voltage Sid Collection and specifying the path to that file in
sidplay2.ini. It's also a good idea to specify a default duration for any SID
file not found in the database.
+
+.TP
+Example entries from \fI~/.sidplay/sidplay2.ini\fR
+.EX
+[SIDPlay2]
+Songlength Database = /home/ben/share/emu/C64Music/Songlengths.txt
+Default Play Length = 3:00
+.EE
+.PP
+
.SH OTHER INFORMATION
Sidplay2 Homepage:
http://sidplay2.sourceforge.net/
@@ -145,3 +155,14 @@
reSID engine - Dag Lem <re...@nimrod.no>
.br
man-page - Mikko Kilponen <mi...@uni.kaapeli.net>
+
+.SH BUGS
+
+.IP \(bu 4
+Sidplay2 ought to come with \fI/usr/share/sidplay/SongLengths.txt\fR instead
of making everybody download it to their home directory.
+.IP \(bu 4
+There should be documentation for the options in the INI file, perhaps
+.BR sidplay2.ini (5).
+.IP \(bu 4
+There should be command line equivalents for all INI options.
+
-- System Information:
Debian Release: wheezy/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: i386 (i686)
Kernel: Linux 2.6.38-2-686 (SMP w/1 CPU core)
Locale: LANG=en_US.utf8, LC_CTYPE=en_US.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages sidplay depends on:
ii libc6 2.11.2-11 Embedded GNU C Library: Shared lib
ii libgcc1 1:4.6.0-2 GCC support library
ii libresid-builder0c2a 2.1.1-8 SID chip emulation class based on
ii libsidplay2 2.1.1-8 SID (MOS 6581) emulation library
ii libsidutils0 2.1.1-8 utility functions for SID players
ii libstdc++6 4.6.0-2 The GNU Standard C++ Library v3
sidplay recommends no packages.
sidplay suggests no packages.
-- no debconf information
--- doc/en/sidplay2.1.orig 2011-05-01 21:41:05.000000000 -0700
+++ doc/en/sidplay2.1 2011-05-01 21:40:51.000000000 -0700
@@ -126,8 +126,18 @@
set sample buffer size.
.RS
-.SH NOTES
-Place for notes..
+.SH INI FILES
+Sidplay2 stores many useful options that cannot be configured from the command
line in a file called \fI~/.sidplay/sidplay2.ini\fR. For example, by default
sidplay2 does not know the duration of SID tunes and will play them forever.
However, this can be fixed easily by downloading the Songlength Database (SLDB)
from the High Voltage Sid Collection and specifying the path to that file in
sidplay2.ini. It's also a good idea to specify a default duration for any SID
file not found in the database.
+
+.TP
+Example entries from \fI~/.sidplay/sidplay2.ini\fR
+.EX
+[SIDPlay2]
+Songlength Database = /home/ben/share/emu/C64Music/Songlengths.txt
+Default Play Length = 3:00
+.EE
+.PP
+
.SH OTHER INFORMATION
Sidplay2 Homepage:
http://sidplay2.sourceforge.net/
@@ -145,3 +155,14 @@
reSID engine - Dag Lem <re...@nimrod.no>
.br
man-page - Mikko Kilponen <mi...@uni.kaapeli.net>
+
+.SH BUGS
+
+.IP \(bu 4
+Sidplay2 ought to come with \fI/usr/share/sidplay/SongLengths.txt\fR instead
of making everybody download it to their home directory.
+.IP \(bu 4
+There should be documentation for the options in the INI file, perhaps
+.BR sidplay2.ini (5).
+.IP \(bu 4
+There should be command line equivalents for all INI options.
+
