Adding documentation for gapless_mp3_playback config option.

git-svn-id: https://svn.musicpd.org/mpd/trunk@5158 09075e82-0dd4-0310-85a5-a0d7c8717e4f

2 files changed, 21 insertions, 6 deletions

diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5
index b6483273..821500e8 100644
--- a/doc/mpd.conf.5
+++ b/doc/mpd.conf.5
@@ -184,6 +184,17 @@ supported character sets can be obtained by running "iconv -l".  The default is
 to let libid3tag convert them (from ISO-8859-1, as the standard specifies) and
 do no additional conversion.
 .TP
+.B gapless_mp3_playback <yes or no>
+This specifies whether to support gapless playback of MP3s which have the
+necessary headers.  Useful if your MP3s have headers with incorrect
+information.  If you have such MP3s, it is highly recommended that you fix them
+using vbrfix (available from <http://www.willwap.co.uk/Programs/vbrfix.php>)
+instead of disabling gapless MP3 playback.
+.TP
+.B save_absolute_paths_in_playlists <yes or no>
+This specifies whether relative or absolute paths for song filenames are used
+when saving playlists.  The default is "no".
+.TP
 .B metadata_to_use <tags>
 This specifies the song metadata that will be scanned and made available to
 clients.  Note that you must recreate (not update) your database for changes to
@@ -193,10 +204,6 @@ tags may be specified as a comma separated list.  An example value is
 "artist,album,title,track".  The special value "none" may be used alone to
 disable all metadata.  The default is to use all known tag types except for
 comments.
-.TP
-.B save_absolute_paths_in_playlists <yes or no>
-This specifies whether relative or absolute paths for song filenames are used
-when saving playlists.  The default is "no".
 .SH REQUIRED AUDIO OUTPUT PARAMETERS
 .TP
 .B type <type>
diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index f55c22cd..71bcba1e 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -233,13 +233,21 @@ error_file                      "~/.mpd/mpd.error"
 
 ######################### OTHER OPTIONS ########################
 #
-# The metadata types MPD will recognize.
+# Try disabling this if you have MP3s which appear to end
+# abruptly.  If this solves the problem, it is highly
+# recommended that you fix your MP3s with vbrfix (available from
+# <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
+# point you can re-enable support for gapless MP3 playback.
 #
-#metadata_to_use                  "artist,album,title,track,name,genre,date,composer,performer,disc"
+#gapless_mp3_playback             "yes"
 #
 # Enable this if you wish to use your MPD created playlists in
 # other music players.
 #
 #save_absolute_paths_in_playlists "no"
 #
+# The metadata types MPD will recognize.
+#
+#metadata_to_use                  "artist,album,title,track,name,genre,date,composer,performer,disc"
+#
 ################################################################