configure.ac: Move wavpack to Decoder Plugins, add header.
[mpd-mk.git] / doc / mpdconf.example
blob3b69e9bb3de1b2ce5e3b4f13070dcf46ce647cb5
1 # An example configuration file for MPD
2 # See the mpd.conf man page for a more detailed description of each parameter.
5 # Files and directories #######################################################
7 # This setting controls the top directory which MPD will search to discover the
8 # available audio files and add them to the daemon's online database. This 
9 # setting defaults to the XDG directory, otherwise the music directory will be
10 # be disabled and audio files will only be accepted over ipc socket (using
11 # file:// protocol) or streaming files over an accepted protocol.
13 #music_directory                "~/music"
15 # This setting sets the MPD internal playlist directory. The purpose of this
16 # directory is storage for playlists created by MPD. The server will use 
17 # playlist files not created by the server but only if they are in the MPD
18 # format. This setting defaults to playlist saving being disabled.
20 #playlist_directory             "~/.mpd/playlists"
22 # This setting sets the location of the MPD database. This file is used to
23 # load the database at server start up and store the database while the 
24 # server is not up. This setting defaults to disabled which will allow
25 # MPD to accept files over ipc socket (using file:// protocol) or streaming
26 # files over an accepted protocol.
28 #db_file                        "~/.mpd/database"
29
30 # These settings are the locations for the daemon log files for the daemon.
31 # These logs are great for troubleshooting, depending on your log_level
32 # settings.
34 # The special value "syslog" makes MPD use the local syslog daemon. This
35 # setting defaults to logging to syslog, otherwise logging is disabled.
37 #log_file                       "~/.mpd/log"
39 # This setting sets the location of the file which stores the process ID
40 # for use of mpd --kill and some init scripts. This setting is disabled by
41 # default and the pid file will not be stored.
43 #pid_file                       "~/.mpd/pid"
45 # This setting sets the location of the file which contains information about
46 # most variables to get MPD back into the same general shape it was in before
47 # it was brought down. This setting is disabled by default and the server 
48 # state will be reset on server start up.
50 #state_file                     "~/.mpd/state"
52 # The location of the sticker database.  This is a database which
53 # manages dynamic information attached to songs.
55 #sticker_file                   "~/.mpd/sticker.sql"
57 ###############################################################################
60 # General music daemon options ################################################
62 # This setting specifies the user that MPD will run as. MPD should never run as
63 # root and you may use this setting to make MPD change its user ID after
64 # initialization. This setting is disabled by default and MPD is run as the
65 # current user.
67 #user                           "nobody"
69 # This setting specifies the group that MPD will run as. If not specified
70 # primary group of user specified with "user" setting will be used (if set).
71 # This is useful if MPD needs to be a member of group such as "audio" to
72 # have permission to use sound card.
74 #group                          "nogroup"
76 # This setting sets the address for the daemon to listen on. Careful attention
77 # should be paid if this is assigned to anything other then the default, any.
78 # This setting can deny access to control of the daemon.
80 # For network
81 #bind_to_address                "any"
83 # And for Unix Socket
84 #bind_to_address                "~/.mpd/socket"
86 # This setting is the TCP port that is desired for the daemon to get assigned
87 # to.
89 #port                           "6600"
91 # This setting controls the type of information which is logged. Available 
92 # setting arguments are "default", "secure" or "verbose". The "verbose" setting
93 # argument is recommended for troubleshooting, though can quickly stretch
94 # available resources on limited hardware storage.
96 #log_level                      "default"
98 # If you have a problem with your MP3s ending abruptly it is recommended that 
99 # you set this argument to "no" to attempt to fix the problem. If this solves
100 # the problem, it is highly recommended to fix the MP3 files with vbrfix
101 # (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
102 # point gapless MP3 playback can be enabled.
104 #gapless_mp3_playback                   "yes"
106 # This setting enables MPD to create playlists in a format usable by other
107 # music players.
109 #save_absolute_paths_in_playlists       "no"
111 # This setting defines a list of tag types that will be extracted during the 
112 # audio file discovery process. Optionally, 'comment' can be added to this
113 # list.
115 #metadata_to_use        "artist,album,title,track,name,genre,date,composer,performer,disc"
117 # This setting enables automatic update of MPD's database when files in 
118 # music_directory are changed.
120 #auto_update    "yes"
122 # Limit the depth of the directories being watched, 0 means only watch
123 # the music directory itself.  There is no limit by default.
125 #auto_update_depth "3"
127 ###############################################################################
130 # Symbolic link behavior ######################################################
132 # If this setting is set to "yes", MPD will discover audio files by following 
133 # symbolic links outside of the configured music_directory.
135 #follow_outside_symlinks        "yes"
137 # If this setting is set to "yes", MPD will discover audio files by following
138 # symbolic links inside of the configured music_directory.
140 #follow_inside_symlinks         "yes"
142 ###############################################################################
145 # Zeroconf / Avahi Service Discovery ##########################################
147 # If this setting is set to "yes", service information will be published with
148 # Zeroconf / Avahi.
150 #zeroconf_enabled               "yes"
152 # The argument to this setting will be the Zeroconf / Avahi unique name for
153 # this MPD server on the network.
155 #zeroconf_name                  "Music Player"
157 ###############################################################################
160 # Permissions #################################################################
162 # If this setting is set, MPD will require password authorization. The password
163 # can setting can be specified multiple times for different password profiles.
165 #password                        "password@read,add,control,admin"
167 # This setting specifies the permissions a user has who has not yet logged in. 
169 #default_permissions             "read,add,control,admin"
171 ###############################################################################
174 # Input #######################################################################
177 input {
178         plugin "curl"
179 #       proxy "proxy.isp.com:8080"
180 #       proxy_user "user"
181 #       proxy_password "password"
185 ###############################################################################
187 # Audio Output ################################################################
189 # MPD supports various audio output types, as well as playing through multiple 
190 # audio outputs at the same time, through multiple audio_output settings 
191 # blocks. Setting this block is optional, though the server will only attempt
192 # autodetection for one sound card.
194 # See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of 
195 # other audio outputs.
197 # An example of an ALSA output:
199 #audio_output {
200 #       type            "alsa"
201 #       name            "My ALSA Device"
202 ##      device          "hw:0,0"        # optional
203 ##      format          "44100:16:2"    # optional
204 ##      mixer_type      "hardware"      # optional
205 ##      mixer_device    "default"       # optional
206 ##      mixer_control   "PCM"           # optional
207 ##      mixer_index     "0"             # optional
210 # An example of an OSS output:
212 #audio_output {
213 #       type            "oss"
214 #       name            "My OSS Device"
215 ##      device          "/dev/dsp"      # optional
216 ##      format          "44100:16:2"    # optional
217 ##      mixer_type      "hardware"      # optional
218 ##      mixer_device    "/dev/mixer"    # optional
219 ##      mixer_control   "PCM"           # optional
222 # An example of a shout output (for streaming to Icecast):
224 #audio_output {
225 #       type            "shout"
226 #       encoding        "ogg"                   # optional
227 #       name            "My Shout Stream"
228 #       host            "localhost"
229 #       port            "8000"
230 #       mount           "/mpd.ogg"
231 #       password        "hackme"
232 #       quality         "5.0"
233 #       bitrate         "128"
234 #       format          "44100:16:1"
235 ##      protocol        "icecast2"              # optional
236 ##      user            "source"                # optional
237 ##      description     "My Stream Description" # optional
238 ##      genre           "jazz"                  # optional
239 ##      public          "no"                    # optional
240 ##      timeout         "2"                     # optional
241 ##      mixer_type      "software"              # optional
244 # An example of a recorder output:
246 #audio_output {
247 #       type            "recorder"
248 #       name            "My recorder"
249 #       encoder         "vorbis"                # optional, vorbis or lame
250 #       path            "/var/lib/mpd/recorder/mpd.ogg"
251 ##      quality         "5.0"                   # do not define if bitrate is defined
252 #       bitrate         "128"                   # do not define if quality is defined
253 #       format          "44100:16:1"
256 # An example of a httpd output (built-in HTTP streaming server):
258 #audio_output {
259 #       type            "httpd"
260 #       name            "My HTTP Stream"
261 #       encoder         "vorbis"                # optional, vorbis or lame
262 #       port            "8000"
263 ##      quality         "5.0"                   # do not define if bitrate is defined
264 #       bitrate         "128"                   # do not define if quality is defined
265 #       format          "44100:16:1"
266 #       max_clients     "0"                     # optional 0=no limit
269 # An example of a pulseaudio output (streaming to a remote pulseaudio server)
271 #audio_output {
272 #       type            "pulse"
273 #       name            "My Pulse Output"
274 ##      server          "remote_server"         # optional
275 ##      sink            "remote_server_sink"    # optional
278 ## Example "pipe" output:
280 #audio_output {
281 #       type            "pipe"
282 #       name            "my pipe"
283 #       command         "aplay -f cd 2>/dev/null"
284 ## Or if you're want to use AudioCompress
285 #       command         "AudioCompress -m | aplay -f cd 2>/dev/null"
286 ## Or to send raw PCM stream through PCM:
287 #       command         "nc example.org 8765"
288 #       format          "44100:16:2"
291 ## An example of a null output (for no audio output):
293 #audio_output {
294 #       type            "null"
295 #       name            "My Null Output"
296 #       mixer_type      "none"                  # optional
299 # This setting will change all decoded audio to be converted to the specified
300 # format before being passed to the audio outputs. By default, this setting is
301 # disabled.
303 #audio_output_format            "44100:16:2"
305 # If MPD has been compiled with libsamplerate support, this setting specifies 
306 # the sample rate converter to use.  Possible values can be found in the 
307 # mpd.conf man page or the libsamplerate documentation. By default, this is
308 # setting is disabled.
310 #samplerate_converter           "Fastest Sinc Interpolator"
312 ###############################################################################
315 # Normalization automatic volume adjustments ##################################
317 # This setting specifies the type of ReplayGain to use. This setting can have
318 # the argument "off", "album" or "track". See <http://www.replaygain.org>
319 # for more details. This setting is off by default.
321 #replaygain                     "album"
323 # This setting sets the pre-amp used for files that have ReplayGain tags. By
324 # default this setting is disabled.
326 #replaygain_preamp              "0"
328 # This setting enables on-the-fly normalization volume adjustment. This will
329 # result in the volume of all playing audio to be adjusted so the output has 
330 # equal "loudness". This setting is disabled by default.
332 #volume_normalization           "no"
334 ###############################################################################
337 # MPD Internal Buffering ######################################################
339 # This setting adjusts the size of internal decoded audio buffering. Changing
340 # this may have undesired effects. Don't change this if you don't know what you
341 # are doing.
343 #audio_buffer_size              "2048"
345 # This setting controls the percentage of the buffer which is filled before 
346 # beginning to play. Increasing this reduces the chance of audio file skipping, 
347 # at the cost of increased time prior to audio playback.
349 #buffer_before_play             "10%"
351 ###############################################################################
354 # Resource Limitations ########################################################
356 # These settings are various limitations to prevent MPD from using too many
357 # resources. Generally, these settings should be minimized to prevent security
358 # risks, depending on the operating resources.
360 #connection_timeout             "60"
361 #max_connections                "10"
362 #max_playlist_length            "16384"
363 #max_command_list_size          "2048"
364 #max_output_buffer_size         "8192"
366 ###############################################################################
369 # Character Encoding ##########################################################
371 # If file or directory names do not display correctly for your locale then you 
372 # may need to modify this setting.
374 #filesystem_charset             "UTF-8"
376 # This setting controls the encoding that ID3v1 tags should be converted from.
378 #id3v1_encoding                 "ISO-8859-1"
380 ###############################################################################
383 # SIDPlay decoder #############################################################
385 # songlength_database:
386 #  Location of your songlengths file, as distributed with the HVSC.
387 #  The sidplay plugin checks this for matching MD5 fingerprints.
388 #  See http://www.c64.org/HVSC/DOCUMENTS/Songlengths.faq
390 # default_songlength:
391 #  This is the default playing time in seconds for songs not in the
392 #  songlength database, or in case you're not using a database.
393 #  A value of 0 means play indefinitely.
395 # filter:
396 #  Turns the SID filter emulation on or off.
398 #decoder {
399 #       plugin                  "sidplay"
400 #       songlength_database     "/media/C64Music/DOCUMENTS/Songlengths.txt"
401 #       default_songlength      "120"
402 #       filter "true"
405 ###############################################################################