Huge mpdconf update.

Over time mpdconf has evolved and has been maintained and contributed to by many different folks at different
times. Try to give it some unity. Attempt to clear up some language and make things crystal clear. Add more
examples. Use tabs when it makes sense. Make better borders. Remove obsolete options. Try to put more defaults
when it makes sense.

1 files changed, 198 insertions, 175 deletions

diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index 83109383e..80e692f3c 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -1,92 +1,136 @@
 # An example configuration file for MPD
 # See the mpd.conf man page for a more detailed description of each parameter.
 
-######################## REQUIRED PATHS ########################
-music_directory                 "~/music"
-playlist_directory              "~/.mpd/playlists"
-db_file                         "~/.mpd/mpd.db"
-log_file                        "~/.mpd/mpd.log"
-error_file                      "~/.mpd/mpd.error"
-#follow_outside_symlinks         "yes"
-#follow_inside_symlinks          "yes"
-################################################################
+# Required files and directories ##############################################
+#
+# From this directory MPD will discover the available audio files and add them 
+# to the daemon's online database.
+#
+music_directory			"~/music"
+#
+# This is the MPD internal playlist directory. This directory is not intended
+# for preexisting playlists which were not created by MPD. 
+#
+playlist_directory		"~/.mpd/playlists"
+#
+# This is the database file. This holds MPDs audio file locations when the
+# daemon is down.
+#
+db_file				"~/.mpd/database"
+# 
+# The log files for the daemon. Great for troubleshooting, depending on your
+# log_level.
+#
+log_file			"~/.mpd/log"
+error_file			"~/.mpd/error-log"
+###############################################################################
 
 
-######################## OPTIONAL PATHS ########################
+# Optional files ##############################################################
 #
-# If you wish to use mpd --kill to stop MPD, then you must
-# specify a file here in which to store MPD's process ID.
+# This file is required for mpd --kill, and some init script, usage.
 #
-#pid_file                        "~/.mpd/mpd.pid"
+#pid_file			"~/.mpd/pid"
 #
-# If specified, MPD will save its current state (playlist,
-# current song, playing/paused, etc.) at exit.  This will be
-# used to restore the session the next time it is run.
+# This file contains information about most variables to get MPD back into the
+# same general shape it was in before it was brought down. This file must be 
+# specified to utilize this feature.
 #
-#state_file                      "~/.mpd/mpdstate"
+#state_file			"~/.mpd/state"
 #
-################################################################
+###############################################################################
 
 
-######################## DAEMON OPTIONS ########################
+# General music daemon options ################################################
+#
+# If the user option is set, MPD will attempt to drop root privileges when it 
+# begins. Otherwise, MPD will run as root, which is not recommended.
+#
+#user				"nobody"
 #
-# If started as root, MPD will drop root privileges and run as
-# this user instead.  Otherwise, MPD will run as the user it was
-# started by.  If left unspecified, MPD will not drop root
-# privileges at all (not recommended).
+# The address for the daemon to listen on. Careful attention should be paid 
+# if this is assigned to anything other then the default, any. This option can
+# deny access to control of the daemon.
 #
-#user                            "nobody"
+# For network
+#bind_to_address		"any"
 #
-# The address and port to listen on.
+# And for Unix Socket
+#bind_to_address		"~/.mpd/socket"
 #
-#bind_to_address                 "any"
-#port                            "6600"
+# The port that is desired for the daemon to get assigned to.
 #
-# Bind to a Unix domain socket:
+#port				"6600"
 #
-#bind_to_address                 "/var/run/mpd/socket"
+# Controls the type of information which is logged. Available options are
+# "default", "secure" or "verbose". The verbose option recommended 
+# for troubleshooting, though can quickly stretch available resources on 
+# limited hardware.
 #
-# Controls the amount of information that is logged.  Can be
-# "default", "secure", or "verbose".
+#log_level			"default"
 #
-#log_level                       "default"
+# If you have a problem with your MP3s ending abruptly it is recommended that 
+# you set this argument to "no" to attempt to fix the problem. If this solves
+# the problem, it is highly recommended to fix the MP3 files with vbrfix
+# (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
+# point gapless MP3 playback can be enabled.
 #
-################################################################
+#gapless_mp3_playback			"yes"
+#
+# Enable this have MPD create playlists in a format usable by other music
+# players.
+#
+#save_absolute_paths_in_playlists	"no"
+#
+# A list of tag types that MPD will discover during audio file discovery.
+# Optionally, comments can be added to this list.
+#
+#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
+#
+###############################################################################
 
+# Symbolic link behavior ######################################################
+#
+# Allow MPD to discover audio files by following symbolic links outside of the 
+# configured music_directory.
+#
+#follow_outside_symlinks	"yes"
+#
+# Allow MPD to discover audio files by following symbolic links inside of the
+# configured music_directory.
+#
+#follow_inside_symlinks		"yes"
+#
+###############################################################################
 
-########################### ZEROCONF ###########################
+# Zeroconf / Avahi Service Discovery ##########################################
 #
-# If yes, service information will be published with Zeroconf.
+# If yes, service information will be published with Zeroconf / Avahi.
 #
-#zeroconf_enabled                "yes"
+#zeroconf_enabled		"yes"
 #
-# The service name to publish.  This name should be unique on
-# your local network.
+# The unique name for this MPD server for your network.
 #
-#zeroconf_name                   "Music Player"
+#zeroconf_name			"Music Player"
 #
-################################################################
+###############################################################################
 
 
-########################## PERMISSIONS #########################
+# Permissions #################################################################
 #
-# MPD can require that users specify a password before using it.
-# You may specify one ore more here, along with what users who
-# log in with that password are allowed to do.
+# MPD can require password authorization. This can be specified multiple times
+# for different user profiles.
 #
 #password                        "password@read,add,control,admin"
 #
-# Specifies what permissions a user who has not logged in with a
-# password has.  By default, all users have full access to MPD
-# if no password is specified above, or no access if one or
-# more passwords are specified.
+# This specifies the permissions a user has who has not yet logged in. 
 #
 #default_permissions             "read,add,control,admin"
 #
-################################################################
+###############################################################################
 
 
-########################## AUDIO OUTPUT ########################
+# Audio Output ################################################################
 #
 # MPD supports many audio output types, as well as playing
 # through multiple audio outputs at the same time.  You can
@@ -99,194 +143,173 @@ error_file                      "~/.mpd/mpd.error"
 # An example of an ALSA output:
 #
 #audio_output {
-#        type                    "alsa"
-#        name                    "My ALSA Device"
-#        device                  "hw:0,0"     # optional
-#        format                  "44100:16:2" # optional
+#	type			"alsa"
+#	name			"My ALSA Device"
+#	device			"hw:0,0"	# optional
+#	format			"44100:16:2"	# optional
 #}
 #
 # An example of an OSS output:
 #
 #audio_output {
-#        type                    "oss"
-#        name                    "My OSS Device"
-#        device                  "/dev/dsp"   # optional
-#        format                  "44100:16:2" # optional
+#	type			"oss"
+#	name			"My OSS Device"
+#	device			"/dev/dsp"	# optional
+#	format			"44100:16:2"	# optional
 #}
 #
 # An example of a shout output (for streaming to Icecast):
 #
 #audio_output {
-#        type                    "shout"
-#        encoding                "ogg"                   # optional
-#        name                    "My Shout Stream"
-#        host                    "localhost"
-#        port                    "8000"
-#        mount                   "/mpd.ogg"
-#        password                "hackme"
-#        quality                 "5.0"
-#        bitrate                 "128"
-#        format                  "44100:16:1"
-#        protocol                "icecast2"              # optional
-#        user                    "source"                # optional
-#        description             "My Stream Description" # optional
-#        genre                   "jazz"                  # optional
-#        public                  "no"                    # optional
-#        timeout                 "2"                     # optional
+#	type			"shout"
+#	encoding		"ogg"			# optional
+#	name			"My Shout Stream"
+#	host			"localhost"
+#	port			"8000"
+#	mount			"/mpd.ogg"
+#	password		"hackme"
+#	quality			"5.0"
+#	bitrate			"128"
+#	format			"44100:16:1"
+#	protocol		"icecast2"		# optional
+#	user			"source"		# optional
+#	description		"My Stream Description"	# optional
+#	genre			"jazz"			# optional
+#	public			"no"			# optional
+#	timeout			"2"			# optional
 #}
 #
-# An example of a null output (for no audio output):
+# An example of a pulseaudio output (streaming to a remote pulseaudio server)
 #
 #audio_output {
-#        type                    "null"
-#        name                    "My Null Output"
+#	type			"pulse"
+#	name			"My Pulse Output"
+#	server			"remote_server"
+#	sink			"remote_server_sink"
 #}
 #
-# Force all decoded audio to be converted to this format before
-# being passed to the audio outputs.
+## An example of a null output (for no audio output):
+#
+#audio_output {
+#	type			"null"
+#	name			"My Null Output"
+#}
 #
-#audio_output_format             "44100:16:2"
+# Force all decoded audio to be converted to this format before being passed 
+# to the audio outputs. By default, this option is disabled.
 #
-# If MPD has been compiled with libsamplerate support, this
-# specifies the sample rate converter to use.  Possible
-# values can be found in the mpd.conf man page or the
-# libsamplerate documentation.
+#audio_output_format		"44100:16:2"
 #
-#samplerate_converter            "Fastest Sinc Interpolator"
+# If MPD has been compiled with libsamplerate support, this specifies the 
+# sample rate converter to use.  Possible values can be found in the mpd.conf 
+# man page or the libsamplerate documentation. By default, this is option is 
+# disabled.
 #
-################################################################
+#samplerate_converter		"Fastest Sinc Interpolator"
+#
+###############################################################################
 
 
-############################# MIXER ############################
+# Volume control mixer ########################################################
 #
-# MPD needs to know what mixer settings to change when you
-# adjust the volume.  If you don't specify one here, MPD will
-# pick one based on which ones it was compiled with support for.
+# MPD has limited volume controls, to use them pick one below. If one is not
+# specified it may be autodetected at startup, depending on available options.
 #
 # An example for controlling an ALSA mixer:
 #
-#mixer_type                      "alsa"
-#mixer_device                    "default"
-#mixer_control                   "PCM"
+#mixer_type			"alsa"
+#mixer_device			"default"
+#mixer_control			"PCM"
 #
 # An example for controlling an OSS mixer:
 #
-#mixer_type                      "oss"
-#mixer_device                    "/dev/mixer"
-#mixer_control                   "PCM"
+#mixer_type			"oss"
+#mixer_device			"/dev/mixer"
+#mixer_control			"PCM"
 #
-# If you want MPD to adjust the volume of audio sent to the
-# audio outputs, you can tell it to use the software mixer:
+# This example is a general volume control mixer, it is used to adjust the 
+# volume of the audio sent to the audio output. 
 #
-#mixer_type                      "software"
+#mixer_type			"software"
 #
-################################################################
+###############################################################################
 
 
-######################### NORMALIZATION ########################
+# Normalization automatic volume adjustments ##################################
 #
-# Specifies the type of ReplayGain to use.  Can be "album" or
-# "track".  ReplayGain will not be used if not specified.  See
-# <http://www.replaygain.org> for more details.
+# Specifies the type of ReplayGain to use. This option can either be "album" or
+# "track". See <http://www.replaygain.org> for more details. If this option is
+# unset it is disabled.
 #
-#replaygain                      "album"
+#replaygain			"album"
 #
-# Sets the pre-amp used for files that have ReplayGain tags.
+# Sets the pre-amp used for files that have ReplayGain tags, if enabled.
 #
-#replaygain_preamp               "0"
+#replaygain_preamp		"0"
 #
-# Enable on the fly volume normalization.  This will cause the
-# volume of all songs played to be adjusted so that they sound
-# as though they are of equal loudness.
+# Enable on-the-fly normalization volume adjustment. This will result in the 
+# volume of all playing audio to be adjusted so the output has equal 
+# "loudness".
 #
-#volume_normalization            "no"
+#volume_normalization		"no"
 #
-################################################################
+###############################################################################
 
 
-########################### BUFFERING ##########################
-#
-# The size of the buffer containing decoded audio.  You probably
-# shouldn't change this.
+# MPD Internal Buffering ######################################################
 #
-#audio_buffer_size               "2048"
+# The size of internal decoded audio buffering. Changing this can have 
+# ill effects. Don't change this if you don't know what you are doing.
 #
-# How much of the buffer to fill before beginning to play.
-# Increase this if you hear skipping when changing songs.
+#audio_buffer_size		"2048"
 #
-#buffer_before_play              "10%"
+# The percent of the buffer to fill before beginning to play. Increasing this
+# reduces the chance of audio file skipping, but increases the time before 
+# audio playback.
 #
-# Similar options for the HTTP stream buffer.  If you hear
-# skipping while playing HTTP streams, you may wish to increase
-# these.
+#buffer_before_play		"10%"
 #
-#http_buffer_size                "128"
-#http_prebuffer_size             "25%"
-#
-################################################################
+###############################################################################
 
 
-########################### HTTP PROXY #########################
+# HTTP Streaming Proxy ########################################################
 #
-# Specifies the HTTP proxy to use for playing HTTP streams.
+# Specifies the HTTP proxy to use for playing HTTP streams. By default, these
+# options will be disabled.
 #
-#http_proxy_host                 "proxy.isp.com"
-#http_proxy_port                 "8080"
-#http_proxy_user                 "user"
-#http_proxy_password             "password"
+#http_proxy_host		"proxy.isp.com"
+#http_proxy_port		"8080"
+#http_proxy_user		"user"
+#http_proxy_password		"password"
 #
-################################################################
+###############################################################################
 
 
-############################# LIMITS ###########################
+# Resource Limitations ########################################################
 #
-# These are various limits to prevent MPD from using too many
-# resources.  You should only change them if they start
-# restricting your usage of MPD.
+# These are various limitations to prevent MPD from using too many resources.
+# Generally, these options should be minimized to prevent security risks,
+# depending on the operating resources.
 #
-#connection_timeout              "60"
-#max_connections                 "5"
-#max_playlist_length             "16384"
-#max_command_list_size           "2048"
-#max_output_buffer_size          "8192"
+#connection_timeout		"60"
+#max_connections		"10"
+#max_playlist_length		"16384"
+#max_command_list_size		"2048"
+#max_output_buffer_size		"8192"
 #
-################################################################
+###############################################################################
 
 
-###################### CHARACTER ENCODINGS #####################
+# Character Encoding ##########################################################
 #
-# If file or directory names do not display correctly, then you
-# may need to change this.  In most cases it should be either
-# "ISO-8859-1" or "UTF-8".  You must recreate your database
-# after changing this (use mpd --create-db).
+# If file or directory names do not display correctly for your local then you 
+# may need to modify this option. After option modification  mpd --create-db 
+# must be run.
 #
-#filesystem_charset              "ISO-8859-1"
+#filesystem_charset		"UTF-8"
 #
 # The encoding that ID3v1 tags should be converted from.
 #
-#id3v1_encoding                  "ISO-8859-1"
-#
-################################################################
-
-
-######################### OTHER OPTIONS ########################
-#
-# 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.
-#
-#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"
-#
-# A list of tag types that MPD will scan for and make available
-# to clients.
-#
-#metadata_to_use                  "artist,album,title,track,name,genre,date,composer,performer,disc"
+#id3v1_encoding			"ISO-8859-1"
 #
-################################################################
+###############################################################################
\ No newline at end of file