diff options
Diffstat (limited to 'doc/mpdconf.example')
| -rw-r--r-- | doc/mpdconf.example | 403 |
1 files changed, 223 insertions, 180 deletions
diff --git a/doc/mpdconf.example b/doc/mpdconf.example index 151c9464f..d2d14098d 100644 --- a/doc/mpdconf.example +++ b/doc/mpdconf.example @@ -1,288 +1,331 @@ # 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 "no" -#follow_inside_symlinks "yes" -################################################################ +# Required files and directories ############################################## +# +# This setting controls the top directory which MPD will search to discover the +# available audio files and add them to the daemon's online database. +# +music_directory "~/music" +# +# This setting sets the MPD internal playlist directory. The purpose of this +# directory is storage for playlists created by MPD. The server will use +# playlist files not created by the server but only if they are in the MPD +# format. +# +playlist_directory "~/.mpd/playlists" +# +# This setting sets the location of the MPD database. This file is used to +# load the database at server start up and store the database while the +# server is not up. +# +db_file "~/.mpd/database" +# +# These settings are the locations for the daemon log files for the daemon. +# These logs are great for troubleshooting, depending on your log_level +# settings. +# +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 setting sets the location of the file which stores the process ID +# for use of mpd --kill and some init scripts. This setting is disabled by +# default. # -#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 setting sets the location of the file which contains information about +# most variables to get MPD back into the same general shape it was in before +# it was brought down. This setting is disabled by default. # -#state_file "~/.mpd/mpdstate" +#state_file "~/.mpd/state" # -################################################################ +############################################################################### -######################## DAEMON OPTIONS ######################## +# General music daemon options ################################################ +# +# This setting specifies the user that MPD will run as, if set. MPD should +# never run as root and you may use this setting to make MPD change its user +# id after initialization. Do not use this setting if you start MPD as an +# unprivileged user. This setting is disabled by default, and the server will +# run as root. +# +#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). +# This setting sets 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 setting 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" +# This setting is the port that is desired for the daemon to get assigned to. # -# Controls the amount of information that is logged. Can be -# "default", "secure", or "verbose". +#port "6600" # -#log_level "default" +# This setting controls the type of information which is logged. Available +# setting arguments are "default", "secure" or "verbose". The "verbose" setting +# argument is recommended for troubleshooting, though can quickly stretch +# available resources on limited hardware storage. # -################################################################ +#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" +# +# This setting enables MPD to create playlists in a format usable by other +# music players. +# +#save_absolute_paths_in_playlists "no" +# +# This setting defines a list of tag types that will be extracted during the +# audio file discovery process. Optionally, 'comment' can be added to this +# list. +# +#metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc" +# +############################################################################### +# Symbolic link behavior ###################################################### +# +# If this setting is set to "yes", MPD will discover audio files by following +# symbolic links outside of the configured music_directory. +# +#follow_outside_symlinks "yes" +# +# If this setting is set to "yes, MPD will 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 this setting is set to "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 argument to this setting will be the Zeroconf / Avahi unique name for +# this MPD server on the 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. +# If this setting is set, MPD will require password authorization. The password +# can setting can be specified multiple times for different password 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 setting 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 -# specify one or more here. If you don't specify any, MPD will -# automatically scan for a usable audio output. +# MPD supports various audio output types, as well as playing through multiple +# audio outputs at the same time, through multiple audio_output settings +# blocks. Setting this block is optional, though the server will only attempt +# autodetection for one sound card. # -# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> -# for examples of other audio outputs. +# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of +# other audio outputs. # # 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_format "44100:16:2" +#audio_output { +# type "null" +# name "My Null Output" +#} # -# 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. +# This setting will change all decoded audio to be converted to the specified +# format before being passed to the audio outputs. By default, this setting is +# disabled. # -#samplerate_converter "Fastest Sinc Interpolator" +#audio_output_format "44100:16:2" # -################################################################ +# If MPD has been compiled with libsamplerate support, this setting 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 +# setting 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 the dependencies +# which were compiled into the server. # # 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, and will work with all outputs. # -#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. +# This setting specifies the type of ReplayGain to use. This setting can have +# the argument "album" or "track". See <http://www.replaygain.org> for more +# details. By default this setting is disabled. # -#replaygain "album" +#replaygain "album" # -# Sets the pre-amp used for files that have ReplayGain tags. +# This setting sets the pre-amp used for files that have ReplayGain tags. By +# default this setting is disabled. # -#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. +# This setting enables 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. -# -#audio_buffer_size "2048" +# MPD Internal Buffering ###################################################### # -# How much of the buffer to fill before beginning to play. -# Increase this if you hear skipping when changing songs. +# This setting adjusts the size of internal decoded audio buffering. Changing +# this may have undesired effects. Don't change this if you don't know what you +# are doing. # -#buffer_before_play "10%" +#audio_buffer_size "2048" # -# Similar options for the HTTP stream buffer. If you hear -# skipping while playing HTTP streams, you may wish to increase -# these. +# This setting controls the percentage of the buffer which is filled before +# beginning to play. Increasing this reduces the chance of audio file skipping, +# at the cost of increased time prior to audio playback. # -#http_buffer_size "128" -#http_prebuffer_size "25%" +#buffer_before_play "10%" # -################################################################ +############################################################################### -########################### HTTP PROXY ######################### +# HTTP Streaming Proxy ######################################################## # -# Specifies the HTTP proxy to use for playing HTTP streams. +# This setting specifies the HTTP proxy to use for playing HTTP streams. By +# default, these settings 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 settings are various limitations to prevent MPD from using too many +# resources. Generally, these settings 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 ##################### -# -# 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). -# -#filesystem_charset "ISO-8859-1" -# -# 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" +# Character Encoding ########################################################## # -# Enable this if you wish to use your MPD created playlists in -# other music players. +# If file or directory names do not display correctly for your locale then you +# may need to modify this setting. After modification of this setting mpd +# --create-db must be run to change the database. # -#save_absolute_paths_in_playlists "no" +#filesystem_charset "UTF-8" # -# A list of tag types that MPD will scan for and make available -# to clients. +# This setting controls the encoding that ID3v1 tags should be converted from. # -#metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc" +#id3v1_encoding "ISO-8859-1" # -################################################################ +############################################################################### |