oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

Fix a few problems with the huge mpdconf update. There's alot of shift here, mostly due to word wraps. This, also, improves on uniformity and clarity of the document.

Browse Source
This commit is contained in:
Avuton Olrich 2008-12-24 15:02:01 -08:00
parent 1b5dd452d1
commit fbc573d03a
1 changed files with 86 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
doc/mpdconf.example
View File

@ -3,23 +3,27 @@
# Required files and directories ############################################## # Required files and directories ##############################################
# #
# From this directory MPD will discover the available audio files and add them # This setting controls the top directory which MPD will search to discover the
# to the daemon's online database. # available audio files and add them to the daemon's online database.
# #
music_directory "~/music" music_directory "~/music"
# #
# This is the MPD internal playlist directory. This directory is not intended # This setting sets the MPD internal playlist directory. The purpose of this
# for preexisting playlists which were not created by MPD. # 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" playlist_directory "~/.mpd/playlists"
# #
# This is the database file. This holds MPDs audio file locations when the # This setting sets the location of the MPD database. This file is used to
# daemon is down. # load the database at server start up and store the database while the
# server is not up.
# #
db_file "~/.mpd/database" db_file "~/.mpd/database"
# #
# The log files for the daemon. Great for troubleshooting, depending on your # These settings are the locations for the daemon log files for the daemon.
# log_level. # These logs are great for troubleshooting, depending on your log_level
# settings.
# #
log_file "~/.mpd/log" log_file "~/.mpd/log"
error_file "~/.mpd/error-log" error_file "~/.mpd/error-log"
@ -28,13 +32,15 @@ error_file "~/.mpd/error-log"
# Optional files ############################################################## # 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" #pid_file "~/.mpd/pid"
# #
# This file contains information about most variables to get MPD back into the # This setting sets the location of the file which contains information about
# same general shape it was in before it was brought down. This file must be # most variables to get MPD back into the same general shape it was in before
# specified to utilize this feature. # it was brought down. This setting is disabled by default.
# #
#state_file "~/.mpd/state" #state_file "~/.mpd/state"
# #
@ -43,16 +49,17 @@ error_file "~/.mpd/error-log"
# General music daemon options ################################################ # General music daemon options ################################################
# #
# This specifies the user that MPD will run as, if set. MPD should # This setting 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 # never run as root and you may use this setting to make MPD change its user
# its user id after initialization. Do not use this option if you # id after initialization. Do not use this setting if you start MPD as an
# start MPD as an unprivileged user. # unprivileged user. This setting is disabled by default, and the server will
# run as root.
# #
#user "nobody" #user "nobody"
# #
# The address for the daemon to listen on. Careful attention should be paid # This setting sets the address for the daemon to listen on. Careful attention
# if this is assigned to anything other then the default, any. This option can # should be paid if this is assigned to anything other then the default, any.
# deny access to control of the daemon. # This setting can deny access to control of the daemon.
# #
# For network # For network
#bind_to_address "any" #bind_to_address "any"
@ -60,14 +67,14 @@ error_file "~/.mpd/error-log"
# And for Unix Socket # And for Unix Socket
#bind_to_address "~/.mpd/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" #port "6600"
# #
# Controls the type of information which is logged. Available options are # This setting controls the type of information which is logged. Available
# "default", "secure" or "verbose". The verbose option recommended # setting arguments are "default", "secure" or "verbose". The "verbose" setting
# for troubleshooting, though can quickly stretch available resources on # argument is recommended for troubleshooting, though can quickly stretch
# limited hardware. # available resources on limited hardware storage.
# #
#log_level "default" #log_level "default"
# #
@ -79,13 +86,14 @@ error_file "~/.mpd/error-log"
# #
#gapless_mp3_playback "yes" #gapless_mp3_playback "yes"
# #
# Enable this have MPD create playlists in a format usable by other music # This setting enables MPD to create playlists in a format usable by other
# players. # music players.
# #
#save_absolute_paths_in_playlists "no" #save_absolute_paths_in_playlists "no"
# #
# A list of tag types that MPD will discover during audio file discovery. # This setting defines a list of tag types that will be extracted during the
# Optionally, comments can be added to this list. # 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" #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 ###################################################### # Symbolic link behavior ######################################################
# #
# Allow MPD to discover audio files by following symbolic links outside of the # If this setting is set to "yes", MPD will discover audio files by following
# configured music_directory. # symbolic links outside of the configured music_directory.
# #
#follow_outside_symlinks "yes" #follow_outside_symlinks "yes"
# #
# Allow MPD to discover audio files by following symbolic links inside of the # If this setting is set to "yes, MPD will discover audio files by following
# configured music_directory. # symbolic links inside of the configured music_directory.
# #
#follow_inside_symlinks "yes" #follow_inside_symlinks "yes"
# #
@ -107,11 +115,13 @@ error_file "~/.mpd/error-log"
# Zeroconf / Avahi Service Discovery ########################################## # 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" #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" #zeroconf_name "Music Player"
# #
@ -120,12 +130,12 @@ error_file "~/.mpd/error-log"
# Permissions ################################################################# # Permissions #################################################################
# #
# MPD can require password authorization. This can be specified multiple times # If this setting is set, MPD will require password authorization. The password
# for different user profiles. # can setting can be specified multiple times for different password profiles.
# #
#password "password@read,add,control,admin" #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" #default_permissions "read,add,control,admin"
# #
@ -134,13 +144,13 @@ error_file "~/.mpd/error-log"
# Audio Output ################################################################ # Audio Output ################################################################
# #
# MPD supports many audio output types, as well as playing # MPD supports various audio output types, as well as playing through multiple
# through multiple audio outputs at the same time. You can # audio outputs at the same time, through multiple audio_output settings
# specify one or more here. If you don't specify any, MPD will # blocks. Setting this block is optional, though the server will only attempt
# automatically scan for a usable audio output. # autodetection for one sound card.
# #
# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> # See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of
# for examples of other audio outputs. # other audio outputs.
# #
# An example of an ALSA output: # An example of an ALSA output:
# #
@ -197,15 +207,16 @@ error_file "~/.mpd/error-log"
# name "My Null Output" # name "My Null Output"
#} #}
# #
# Force all decoded audio to be converted to this format before being passed # This setting will change all decoded audio to be converted to the specified
# to the audio outputs. By default, this option is disabled. # format before being passed to the audio outputs. By default, this setting is
# disabled.
# #
#audio_output_format "44100:16:2" #audio_output_format "44100:16:2"
# #
# If MPD has been compiled with libsamplerate support, this specifies the # If MPD has been compiled with libsamplerate support, this setting specifies
# sample rate converter to use. Possible values can be found in the mpd.conf # the sample rate converter to use. Possible values can be found in the
# man page or the libsamplerate documentation. By default, this is option is # mpd.conf man page or the libsamplerate documentation. By default, this is
# disabled. # setting is disabled.
# #
#samplerate_converter "Fastest Sinc Interpolator" #samplerate_converter "Fastest Sinc Interpolator"
# #
@ -215,7 +226,8 @@ error_file "~/.mpd/error-log"
# Volume control mixer ######################################################## # Volume control mixer ########################################################
# #
# MPD has limited volume controls, to use them pick one below. If one is not # 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: # An example for controlling an ALSA mixer:
# #
@ -230,7 +242,7 @@ error_file "~/.mpd/error-log"
#mixer_control "PCM" #mixer_control "PCM"
# #
# This example is a general volume control mixer, it is used to adjust the # 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" #mixer_type "software"
# #
@ -239,19 +251,20 @@ error_file "~/.mpd/error-log"
# Normalization automatic volume adjustments ################################## # Normalization automatic volume adjustments ##################################
# #
# Specifies the type of ReplayGain to use. This option can either be "album" or # This setting specifies the type of ReplayGain to use. This setting can have
# "track". See <http://www.replaygain.org> for more details. If this option is # the argument "album" or "track". See <http://www.replaygain.org> for more
# unset it is disabled. # details. By default this setting is disabled.
# #
#replaygain "album" #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" #replaygain_preamp "0"
# #
# Enable on-the-fly normalization volume adjustment. This will result in the # This setting enables on-the-fly normalization volume adjustment. This will
# volume of all playing audio to be adjusted so the output has equal # result in the volume of all playing audio to be adjusted so the output has
# "loudness". # equal "loudness".
# #
#volume_normalization "no" #volume_normalization "no"
# #
@ -260,14 +273,15 @@ error_file "~/.mpd/error-log"
# MPD Internal Buffering ###################################################### # MPD Internal Buffering ######################################################
# #
# The size of internal decoded audio buffering. Changing this can have # This setting adjusts the size of internal decoded audio buffering. Changing
# ill effects. Don't change this if you don't know what you are doing. # this may have undesired effects. Don't change this if you don't know what you
# are doing.
# #
#audio_buffer_size "2048" #audio_buffer_size "2048"
# #
# The percent of the buffer to fill before beginning to play. Increasing this # This setting controls the percentage of the buffer which is filled before
# reduces the chance of audio file skipping, but increases the time before # beginning to play. Increasing this reduces the chance of audio file skipping,
# audio playback. # at the cost of increased time prior to audio playback.
# #
#buffer_before_play "10%" #buffer_before_play "10%"
# #
@ -276,8 +290,8 @@ error_file "~/.mpd/error-log"
# HTTP Streaming Proxy ######################################################## # HTTP Streaming Proxy ########################################################
# #
# Specifies the HTTP proxy to use for playing HTTP streams. By default, these # This setting specifies the HTTP proxy to use for playing HTTP streams. By
# options will be disabled. # default, these settings will be disabled.
# #
#http_proxy_host "proxy.isp.com" #http_proxy_host "proxy.isp.com"
#http_proxy_port "8080" #http_proxy_port "8080"
@ -289,9 +303,9 @@ error_file "~/.mpd/error-log"
# Resource Limitations ######################################################## # Resource Limitations ########################################################
# #
# These are various limitations to prevent MPD from using too many resources. # These settings are various limitations to prevent MPD from using too many
# Generally, these options should be minimized to prevent security risks, # resources. Generally, these settings should be minimized to prevent security
# depending on the operating resources. # risks, depending on the operating resources.
# #
#connection_timeout "60" #connection_timeout "60"
#max_connections "10" #max_connections "10"
@ -304,13 +318,13 @@ error_file "~/.mpd/error-log"
# Character Encoding ########################################################## # Character Encoding ##########################################################
# #
# If file or directory names do not display correctly for your local then you # If file or directory names do not display correctly for your locale then you
# may need to modify this option. After option modification mpd --create-db # may need to modify this setting. After modification of this setting mpd
# must be run. # --create-db must be run to change the database.
# #
#filesystem_charset "UTF-8" #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" #id3v1_encoding "ISO-8859-1"
# #