gentoo-ebuilds/media-sound/mpd/files/mpd.conf.5-0.24.2

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MPD.CONF" "5" "Apr 08, 2025" "0.24.2" "Music Player Daemon"
.SH NAME
mpd.conf \- mpd.conf documentation
.SH DESCRIPTION
.sp
\fBmpd.conf\fP is the configuration file for \fBmpd(1)\fP\&. If
not specified on the command line, MPD first searches for it at
\fB$XDG_CONFIG_HOME/mpd/mpd.conf\fP then at \fB~/.mpdconf\fP then
at \fB~/.mpd/mpd.conf\fP and then in \fB/etc/mpd.conf\fP\&.
.sp
Each line in the configuration file contains a setting name and its value, e.g.:
.sp
\fBconnection_timeout \(dq5\(dq\fP
.sp
Lines starting with \fB#\fP are treated as comments and ignored.
.sp
For settings that specify a file system path, the tilde (\(aq~\(aq) is expanded to $HOME.
In addition, the following path expansions are supported:
.INDENT 0.0
.IP \(bu 2
\fI$HOME\fP
.IP \(bu 2
\fI$XDG_CONFIG_HOME\fP
.IP \(bu 2
\fI$XDG_MUSIC_DIR\fP
.IP \(bu 2
\fI$XDG_CACHE_HOME\fP
.IP \(bu 2
\fI$XDG_RUNTIME_DIR\fP
.UNINDENT
.sp
\fBmusic_directory \(dq~/Music\(dq\fP
.sp
\fBdb_file \(dq$XDG_CONFIG_HOME/mpd/database\(dq\fP
.sp
Some of the settings are grouped in blocks with curly braces, e.g. per\-plugin settings:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
audio_output {
    type \(dqalsa\(dq
    name \(dqMy ALSA output\(dq
    device \(dqiec958:CARD=Intel,DEV=0\(dq
    mixer_control \(dqPCM\(dq
}
.EE
.UNINDENT
.UNINDENT
.sp
The \fBinclude\fP directive can be used to include settings from
another file; the given file name is relative to the current file:
.sp
\fBinclude \(dqother.conf\(dq\fP
.sp
You can use include_optional instead if you want the included file to be
optional; the directive will be ignored if the file does not exist:
.sp
\fBinclude_optional \(dqmay_not_exist.conf\(dq\fP
.sp
See \fBdocs/mpdconf.example\fP in the source tarball for an example
configuration file.
.sp
This manual is not complete, it lists only the most important options.
Please read the MPD user manual for a complete configuration guide:
\X'tty: link http://www.musicpd.org/doc/user/'\fI\%http://www.musicpd.org/doc/user/\fP\X'tty: link'
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B db_file <file>
This specifies where the db file will be stored.
.TP
.B log_file <file>
This specifies where the log file should be located. The special value \(dqsyslog\(dq makes MPD use the local syslog daemon.
.TP
.B sticker_file <file>
The location of the sticker database. This is a database which manages
dynamic information attached to songs.
.TP
.B pid_file <file>
This specifies the file to save mpd\(aqs process ID in.
.TP
.B music_directory <directory>
This specifies the directory where music is located. If you do not configure
this, you can only play streams.
.TP
.B playlist_directory <directory>
This specifies the directory where saved playlists are stored. If
you do not configure this, you cannot save playlists.
.TP
.B state_file <file>
This specifies if a state file is used and where it is located. The state of
mpd will be saved to this file when mpd is terminated by a TERM signal or by
the \fBkill\fP command. When mpd is restarted, it will read the state file and
restore the state of mpd (including the playlist).
.TP
.B restore_paused <yes or no>
Put MPD into pause mode instead of starting playback after startup.
.TP
.B user <username>
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.
.TP
.B port <port>
This specifies the port that mpd listens on. The default is 6600.
.TP
.B log_level <level>
Suppress all messages below the given threshold.  The following
log levels are available:
.INDENT 7.0
.IP \(bu 2
\fBerror\fP: errors
.IP \(bu 2
\fBwarning\fP: warnings
.IP \(bu 2
\fBnotice\fP: interesting informational messages
.IP \(bu 2
\fBinfo\fP: unimportant informational messages
.IP \(bu 2
\fBverbose\fP: debug messages (for developers and for
troubleshooting)
.UNINDENT
.sp
The default is \fBnotice\fP\&.
.TP
.B follow_outside_symlinks <yes or no>
Control if MPD will follow symbolic links pointing outside the music dir. You
must recreate the database after changing this option. The default is \(dqyes\(dq.
.TP
.B follow_inside_symlinks <yes or no>
Control if MPD will follow symbolic links pointing inside the music dir,
potentially adding duplicates to the database. You must recreate the
database after changing this option. The default is \(dqyes\(dq.
.TP
.B zeroconf_enabled <yes or no>
If yes, and MPD has been compiled with support for Avahi or Bonjour, service
information will be published with Zeroconf. The default is yes.
.TP
.B zeroconf_name <name>
If Zeroconf is enabled, this is the service name to publish. This name should
be unique to your local network, but name collisions will be properly dealt
with. The default is \(dqMusic Player @ %h\(dq, where %h will be replaced with the
hostname of the machine running MPD.
.TP
.B audio_output
See DESCRIPTION and the various \fBAUDIO OUTPUT PARAMETERS\fP sections for the
format of this parameter. Multiple audio_output sections may be specified. If
no audio_output section is specified, then MPD will scan for a usable audio
output.
.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 \(dqiconv \-l\(dq. The default is
determined from the locale when the db was originally created.
.TP
.B save_absolute_paths_in_playlists <yes or no>
This specifies whether relative or absolute paths for song filenames are used
when saving playlists. The default is \(dqno\(dq.
.TP
.B auto_update <yes or no>
This specifies the whether to support automatic update of music database
when files are changed in music_directory. The default is to disable
autoupdate of database.
.TP
.B auto_update_depth <N>
Limit the depth of the directories being watched, 0 means only watch the
music directory itself. There is no limit by default.
.UNINDENT
.SH REQUIRED AUDIO OUTPUT PARAMETERS
.INDENT 0.0
.TP
.B type <type>
This specifies the audio output type. See the list of supported outputs in
\fBmpd \-\-version\fP for possible values.
.TP
.B name <name>
This specifies a unique name for the audio output.
.UNINDENT
.SH OPTIONAL AUDIO OUTPUT PARAMETERS
.INDENT 0.0
.TP
.B format <sample_rate:bits:channels>
This specifies the sample rate, bits per sample, and number of channels of
audio that is sent to the audio output device. See documentation for the
\fBaudio_output_format\fP parameter for more details. The default is to use
whatever audio format is passed to the audio output. Any of the three
attributes may be an asterisk to specify that this attribute should not be
enforced
.TP
.B replay_gain_handler <software, mixer or none>
Specifies how replay gain is applied. The default is \(dqsoftware\(dq, which uses
an internal software volume control. \(dqmixer\(dq uses the configured (hardware)
mixer control. \(dqnone\(dq disables replay gain on this audio output.
.TP
.B mixer_type <hardware, software or none>
Specifies which mixer should be used for this audio output: the hardware
mixer (available for ALSA, OSS and PulseAudio), the software mixer or no
mixer (\(dqnone\(dq). By default, the hardware mixer is used for devices which
support it, and none for the others.
.UNINDENT
.SH FILES
.INDENT 0.0
.TP
.B \fB$XDG_CONFIG_HOME/mpd/mpd.conf\fP
User configuration file (usually \fB~/.config/mpd/mpd.conf\fP).
.TP
.B \fB/etc/mpd.conf\fP
Global configuration file.
.UNINDENT
.SH SEE ALSO
.sp
\fBmpd(1)\fP, \fBmpc(1)\fP
.SH AUTHOR
Max Kellermann
.SH COPYRIGHT
2003-2025 The Music Player Daemon Project
.\" Generated by docutils manpage writer.
.