diff options
| -rw-r--r-- | doc/mpdconf.example | 158 |
1 files changed, 86 insertions, 72 deletions
diff --git a/doc/mpdconf.example b/doc/mpdconf.example index ccbb0039..d2d14098 100644 --- a/doc/mpdconf.example +++ b/doc/mpdconf.example @@ -3,23 +3,27 @@ # Required files and directories ############################################## # -# From this directory MPD will discover the available audio files and add them -# to the daemon's online database. +# 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 is the MPD internal playlist directory. This directory is not intended -# for preexisting playlists which were not created by MPD. +# 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 is the database file. This holds MPDs audio file locations when the -# daemon is down. +# 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" # -# The log files for the daemon. Great for troubleshooting, depending on your -# log_level. +# 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" @@ -28,13 +32,15 @@ error_file "~/.mpd/error-log" # Optional files ############################################################## # -# This file is required for mpd --kill, and some init script, usage. +# 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/pid" # -# 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. +# 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/state" # @@ -43,16 +49,17 @@ error_file "~/.mpd/error-log" # General music daemon options ################################################ # -# This specifies the user that MPD will run as, if set. MPD should -# never run as root, and you may use this option to make MPD change -# its user id after initialization. Do not use this option if you -# start MPD as an unprivileged user. +# 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" # -# 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. +# 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. # # For network #bind_to_address "any" @@ -60,14 +67,14 @@ error_file "~/.mpd/error-log" # And for Unix Socket #bind_to_address "~/.mpd/socket" # -# The port that is desired for the daemon to get assigned to. +# This setting is the port that is desired for the daemon to get assigned to. # #port "6600" # -# 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. +# 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" # @@ -79,13 +86,14 @@ error_file "~/.mpd/error-log" # #gapless_mp3_playback "yes" # -# Enable this have MPD create playlists in a format usable by other music -# players. +# This setting enables MPD to 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. +# 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" # @@ -93,13 +101,13 @@ error_file "~/.mpd/error-log" # Symbolic link behavior ###################################################### # -# Allow MPD to discover audio files by following symbolic links outside of the -# configured music_directory. +# 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" # -# Allow MPD to discover audio files by following symbolic links inside of the -# configured music_directory. +# 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" # @@ -107,11 +115,13 @@ error_file "~/.mpd/error-log" # Zeroconf / Avahi Service Discovery ########################################## # -# If yes, service information will be published with Zeroconf / Avahi. +# If this setting is set to "yes", service information will be published with +# Zeroconf / Avahi. # #zeroconf_enabled "yes" # -# The unique name for this MPD server for your network. +# The argument to this setting will be the Zeroconf / Avahi unique name for +# this MPD server on the network. # #zeroconf_name "Music Player" # @@ -120,12 +130,12 @@ error_file "~/.mpd/error-log" # Permissions ################################################################# # -# MPD can require password authorization. This can be specified multiple times -# for different user profiles. +# 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" # -# This specifies the permissions a user has who has not yet logged in. +# This setting specifies the permissions a user has who has not yet logged in. # #default_permissions "read,add,control,admin" # @@ -134,13 +144,13 @@ error_file "~/.mpd/error-log" # 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: # @@ -197,15 +207,16 @@ error_file "~/.mpd/error-log" # name "My Null Output" #} # -# Force all decoded audio to be converted to this format before being passed -# to the audio outputs. By default, this option is disabled. +# 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. # #audio_output_format "44100:16:2" # -# 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. +# 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" # @@ -215,7 +226,8 @@ error_file "~/.mpd/error-log" # Volume control mixer ######################################################## # # 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. +# specified it may be autodetected at startup, depending on the dependencies +# which were compiled into the server. # # An example for controlling an ALSA mixer: # @@ -230,7 +242,7 @@ error_file "~/.mpd/error-log" #mixer_control "PCM" # # This example is a general volume control mixer, it is used to adjust the -# volume of the audio sent to the audio output. +# volume of the audio sent to the audio output, and will work with all outputs. # #mixer_type "software" # @@ -239,19 +251,20 @@ error_file "~/.mpd/error-log" # Normalization automatic volume adjustments ################################## # -# 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. +# 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" # -# Sets the pre-amp used for files that have ReplayGain tags, if enabled. +# This setting sets the pre-amp used for files that have ReplayGain tags. By +# default this setting is disabled. # #replaygain_preamp "0" # -# 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". +# 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" # @@ -260,14 +273,15 @@ error_file "~/.mpd/error-log" # MPD Internal Buffering ###################################################### # -# 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. +# 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. # #audio_buffer_size "2048" # -# 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. +# 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. # #buffer_before_play "10%" # @@ -276,8 +290,8 @@ error_file "~/.mpd/error-log" # HTTP Streaming Proxy ######################################################## # -# Specifies the HTTP proxy to use for playing HTTP streams. By default, these -# options will be disabled. +# 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" @@ -289,9 +303,9 @@ error_file "~/.mpd/error-log" # Resource Limitations ######################################################## # -# 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. +# 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 "10" @@ -304,13 +318,13 @@ error_file "~/.mpd/error-log" # Character Encoding ########################################################## # -# 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. +# 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. # #filesystem_charset "UTF-8" # -# The encoding that ID3v1 tags should be converted from. +# This setting controls the encoding that ID3v1 tags should be converted from. # #id3v1_encoding "ISO-8859-1" # |