Skip to content

M
mpd
Commit a29cc48f authored by Max Kellermann's avatar Max Kellermann
Browse files
Options

doc/{mpd.conf.5,mpdconf.example}: move documentation to the manual

parent 42af040f
Hide whitespace changes
Inline Side-by-side
Showing with 131 additions and 61 deletions
doc/mpd.conf.5
View file @ a29cc48f
......@@ -151,39 +151,10 @@ This is the gain (in dB) applied to songs with ReplayGain tags.
.B volume_normalization <yes or no>
If yes, mpd will normalize the volume of songs as they play. The default is no.
.TP
.B audio_buffer_size <size in KiB>
This specifies the size of the audio buffer in kibibytes. The default is 4096,
large enough for nearly 12 seconds of CD-quality audio.
.TP
.B buffer_before_play <0-100%>
This specifies how much of the audio buffer should be filled before playing a
song. Try increasing this if you hear skipping when manually changing songs.
The default is 10%, a little over 1 second of CD-quality audio with the default
buffer size.
.TP
.B http_proxy_host <hostname>
This setting is deprecated. Use the "proxy" setting in the "curl"
input block. See MPD user manual for details.
.TP
.B connection_timeout <seconds>
If a client does not send any new data in this time period, the connection is
closed. The default is 60.
.TP
.B max_connections <number>
This specifies the maximum number of clients that can be connected to mpd. The
default is 5.
.TP
.B max_playlist_length <number>
This specifies the maximum number of songs that can be in the playlist. The
default is 16384.
.TP
.B max_command_list_size <size in KiB>
This specifies the maximum size a command list can be. The default is 2048.
.TP
.B max_output_buffer_size <size in KiB>
This specifies the maximum size of the output buffer to a client. The default
is 8192.
.TP
.B filesystem_charset <charset>
This specifies the character set used for the filesystem. A list of supported
character sets can be obtained by running "iconv \-l". The default is
......
doc/mpdconf.example
View file @ a29cc48f
......@@ -373,38 +373,6 @@ input {
#
###############################################################################
# MPD Internal Buffering ######################################################
#
# 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 "4096"
#
# 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%"
#
###############################################################################
# Resource Limitations ########################################################
#
# 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"
#max_playlist_length "16384"
#max_command_list_size "2048"
#max_output_buffer_size "8192"
#
###############################################################################
# Character Encoding ##########################################################
#
# If file or directory names do not display correctly for your locale then you
......
doc/user.xml
View file @ a29cc48f
......@@ -914,6 +914,137 @@ systemctl start mpd.socket</programlisting>
</tgroup>
</informaltable>
</section>
<section>
<title>Resource Limitations</title>
<para>
These settings are various limitations to prevent
<application>MPD</application> from using too many
resources (denial of service).
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Setting</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<varname>connection_timeout</varname>
<parameter>SECONDS</parameter>
</entry>
<entry>
If a client does not send any new data in this time
period, the connection is closed. Clients waiting
in "idle" mode are excluded from this. Default is
<parameter>60</parameter>.
</entry>
</row>
<row>
<entry>
<varname>max_connections</varname>
<parameter>NUMBER</parameter>
</entry>
<entry>
This specifies the maximum number of clients that
can be connected to <application>MPD</application>
at the same time. Default is
<parameter>5</parameter>.
</entry>
</row>
<row>
<entry>
<varname>max_playlist_length</varname>
<parameter>NUMBER</parameter>
</entry>
<entry>
The maximum number of songs that can be in the
playlist. Default is <parameter>16384</parameter>.
</entry>
</row>
<row>
<entry>
<varname>max_command_list_size</varname>
<parameter>KBYTES</parameter>
</entry>
<entry>
The maximum size a command list. Default is
<parameter>2048</parameter> (2 MiB).
</entry>
</row>
<row>
<entry>
<varname>max_output_buffer_size</varname>
<parameter>KBYTES</parameter>
</entry>
<entry>
The maximum size of the output buffer to a client
(maximum response size). Default is
<parameter>8192</parameter> (8 MiB).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section>
<title>Buffer Settings</title>
<para>
Do not change these unless you know what you are doing.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Setting</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<varname>audio_buffer_size</varname>
<parameter>KBYTES</parameter>
</entry>
<entry>
Adjust the size of the internal audio buffer.
Default is <parameter>4096</parameter> (4 MiB).
</entry>
</row>
<row>
<entry>
<varname>buffer_before_play</varname>
<parameter>PERCENT</parameter>
</entry>
<entry>
Control 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. Default is
<parameter>10%</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>
</chapter>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment