Initial revision 6759
[qball-mpd.git] / doc / mpdconf.example
blobbe04adb91a1d7669bfd91c4a993a6ce99fbbc5b0
1 # An example configuration file for MPD
2 # See the mpd.conf man page for a more detailed description of each parameter.
4 ######################## REQUIRED PATHS ########################
5 music_directory                 "~/music"
6 playlist_directory              "~/.mpd/playlists"
7 db_file                         "~/.mpd/mpd.db"
8 log_file                        "~/.mpd/mpd.log"
9 error_file                      "~/.mpd/mpd.error"
10 ################################################################
13 ######################## OPTIONAL PATHS ########################
15 # If you wish to use mpd --kill to stop MPD, then you must
16 # specify a file here in which to store MPD's process ID.
18 #pid_file                        "~/.mpd/mpd.pid"
20 # If specified, MPD will save its current state (playlist,
21 # current song, playing/paused, etc.) at exit.  This will be
22 # used to restore the session the next time it is run.
24 #state_file                      "~/.mpd/mpdstate"
26 ################################################################
29 ######################## DAEMON OPTIONS ########################
31 # If started as root, MPD will drop root privileges and run as
32 # this user instead.  Otherwise, MPD will run as the user it was
33 # started by.  If left unspecified, MPD will not drop root
34 # privileges at all (not recommended).
36 #user                            "nobody"
38 # The address and port to listen on.
40 #bind_to_address                 "any"
41 #port                            "6600"
43 # Controls the amount of information that is logged.  Can be
44 # "default", "secure", or "verbose".
46 #log_level                       "default"
48 ################################################################
51 ########################### ZEROCONF ###########################
53 # If yes, service information will be published with Zeroconf.
55 #zeroconf_enabled                "yes"
57 # The service name to publish.  This name should be unique on
58 # your local network.
60 #zeroconf_name                   "Music Player"
62 ################################################################
65 ########################## PERMISSIONS #########################
67 # MPD can require that users specify a password before using it.
68 # You may specify one ore more here, along with what users who
69 # log in with that password are allowed to do.
71 #password                        "password@read,add,control,admin"
73 # Specifies what permissions a user who has not logged in with a
74 # password has.  By default, all users have full access to MPD
75 # if no password is specified above, or no access if one or
76 # more passwords are specified.
78 #default_permissions             "read,add,control,admin"
80 ################################################################
83 ########################## AUDIO OUTPUT ########################
85 # MPD supports many audio output types, as well as playing
86 # through multiple audio outputs at the same time.  You can
87 # specify one or more here.  If you don't specify any, MPD will
88 # automatically scan for a usable audio output.
90 # See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs>
91 # for examples of other audio outputs.
93 # An example of an ALSA output:
95 #audio_output {
96 #        type                    "alsa"
97 #        name                    "My ALSA Device"
98 #        device                  "hw:0,0"     # optional
99 #        format                  "44100:16:2" # optional
102 # An example of an OSS output:
104 #audio_output {
105 #        type                    "oss"
106 #        name                    "My OSS Device"
107 #        device                  "/dev/dsp"   # optional
108 #        format                  "44100:16:2" # optional
111 # An example of a shout output (for streaming to Icecast):
113 #audio_output {
114 #        type                    "shout"
115 #        name                    "My Shout Stream"
116 #        host                    "localhost"
117 #        port                    "8000"
118 #        mount                   "/mpd.ogg"
119 #        password                "hackme"
120 #        quality                 "5.0"
121 #        bitrate                 "128"
122 #        format                  "44100:16:1"
123 #        user                    "source"                # optional
124 #        description             "My Stream Description" # optional
125 #        genre                   "jazz"                  # optional
126 #        public                  "no"                    # optional
127 #        timeout                 "2"                     # optional
130 # An example of a null output (for no audio output):
132 #audio_output {
133 #        type                    "null"
134 #        name                    "My Null Output"
137 # Force all decoded audio to be converted to this format before
138 # being passed to the audio outputs.
140 #audio_output_format             "44100:16:2"
142 # If MPD has been compiled with libsamplerate support, this
143 # specifies the sample rate converter to use.  Possible
144 # values can be found in the mpd.conf man page or the
145 # libsamplerate documentation.
147 #samplerate_converter            "Fastest Sinc Interpolator"
149 ################################################################
152 ############################# MIXER ############################
154 # MPD needs to know what mixer settings to change when you
155 # adjust the volume.  If you don't specify one here, MPD will
156 # pick one based on which ones it was compiled with support for.
158 # An example for controlling an ALSA mixer:
160 #mixer_type                      "alsa"
161 #mixer_device                    "default"
162 #mixer_control                   "PCM"
164 # An example for controlling an OSS mixer:
166 #mixer_type                      "oss"
167 #mixer_device                    "/dev/mixer"
168 #mixer_control                   "PCM"
170 # If you want MPD to adjust the volume of audio sent to the
171 # audio outputs, you can tell it to use the software mixer:
173 #mixer_type                      "software"
175 ################################################################
178 ######################### NORMALIZATION ########################
180 # Specifies the type of ReplayGain to use.  Can be "album" or
181 # "track".  ReplayGain will not be used if not specified.  See
182 # <http://www.replaygain.org> for more details.
184 #replaygain                      "album"
186 # Sets the pre-amp used for files that have ReplayGain tags.
188 #replaygain_preamp               "0"
190 # Enable on the fly volume normalization.  This will cause the
191 # volume of all songs played to be adjusted so that they sound
192 # as though they are of equal loudness.
194 #volume_normalization            "no"
196 ################################################################
199 ########################### BUFFERING ##########################
201 # The size of the buffer containing decoded audio.  You probably
202 # shouldn't change this.
204 #audio_buffer_size               "2048"
206 # How much of the buffer to fill before beginning to play.
207 # Increase this if you hear skipping when changing songs.
209 #buffer_before_play              "10%"
211 # Similar options for the HTTP stream buffer.  If you hear
212 # skipping while playing HTTP streams, you may wish to increase
213 # these.
215 #http_buffer_size                "128"
216 #http_prebuffer_size             "25%"
218 ################################################################
221 ########################### HTTP PROXY #########################
223 # Specifies the HTTP proxy to use for playing HTTP streams.
225 #http_proxy_host                 "proxy.isp.com"
226 #http_proxy_port                 "8080"
227 #http_proxy_user                 "user"
228 #http_proxy_password             "password"
230 ################################################################
233 ############################# LIMITS ###########################
235 # These are various limits to prevent MPD from using too many
236 # resources.  You should only change them if they start
237 # restricting your usage of MPD.
239 #connection_timeout              "60"
240 #max_connections                 "5"
241 #max_playlist_length             "16384"
242 #max_command_list_size           "2048"
243 #max_output_buffer_size          "8192"
245 ################################################################
248 ###################### CHARACTER ENCODINGS #####################
250 # If file or directory names do not display correctly, then you
251 # may need to change this.  In most cases it should be either
252 # "ISO-8859-1" or "UTF-8".  You must recreate your database
253 # after changing this (use mpd --create-db).
255 #filesystem_charset              "ISO-8859-1"
257 # The encoding that ID3v1 tags should be converted from.
259 #id3v1_encoding                  "ISO-8859-1"
261 ################################################################
264 ######################### OTHER OPTIONS ########################
266 # Try disabling this if you have MP3s which appear to end
267 # abruptly.  If this solves the problem, it is highly
268 # recommended that you fix your MP3s with vbrfix (available from
269 # <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
270 # point you can re-enable support for gapless MP3 playback.
272 #gapless_mp3_playback             "yes"
274 # Enable this if you wish to use your MPD created playlists in
275 # other music players.
277 #save_absolute_paths_in_playlists "no"
279 # A list of tag types that MPD will scan for and make available
280 # to clients.
282 #metadata_to_use                  "artist,album,title,track,name,genre,date,composer,performer,disc"
284 ################################################################