~ubuntu-branches/ubuntu/trusty/mpd/trusty

« back to all changes in this revision

Viewing changes to doc/mpd.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Angel Abad
  • Date: 2011-02-02 12:26:30 UTC
  • mfrom: (1.5.11 upstream)
  • Revision ID: james.westby@ubuntu.com-20110202122630-bdyx8w4k94doz4fs
Tags: 0.16.1-1ubuntu1
* Merge from debian unstable. Remaining changes:
  - debian/control:
    + Don't build-depend on libmikmod2-dev (Debian bug #510675).
    + Move avahi-daemon from Suggests field to Recommends field.
  - debian/mpd.init.d:
    + Read mpd user from mpd.conf.
  - debian/control, debian/rules:
    + Add libmp3lame-dev to the build dependencies and enable lame.

Show diffs side-by-side

added added

removed removed

Lines of Context:
129
129
their own audio format which will be used for actual output to the audio
130
130
device.  An example is "44100:16:2" for 44100Hz, 16 bits, and 2 channels.  The
131
131
default is to use the audio format of the input file.
 
132
Any of the three attributes may be an asterisk to specify that this
 
133
attribute should not be enforced
132
134
.TP
133
135
.B samplerate_converter <integer or prefix>
134
136
This specifies the libsamplerate converter to use.  The supplied value should
168
170
For an up-to-date list of available converters, please see the libsamplerate
169
171
documentation (available online at <\fBhttp://www.mega-nerd.com/SRC/\fP>).
170
172
.TP
171
 
.B mixer_type <alsa, oss, software, hardware or disabled>
172
 
This specifies which mixer to use.  The default is hardware and depends on
173
 
what audio output support mpd was built with. Options alsa and oss are
174
 
legacy and should not be used in new configs, but when set mixer_device
175
 
and mixer_control will apply.
176
 
.TP
177
 
.B mixer_device <mixer dev>
178
 
This specifies which mixer to use.  The default for oss is
179
 
"/dev/mixer"; the default for alsa is "default". This global option is
180
 
deprecated and should not be used.  Look at the mixer_device option of
181
 
corresponding output device instead.
182
 
.TP
183
 
.B mixer_control <mixer ctrl>
184
 
This specifies which mixer control to use (sometimes referred to as
185
 
the "device").  Examples of mixer controls are PCM, Line1, Master,
186
 
etc.  An example for OSS is "Pcm", and an example for alsa is
187
 
"PCM". This global option is deprecated and should not be used. Look
188
 
at the mixer_control option of corresponding output device instead.
189
 
.TP
190
 
.B replaygain <album or track>
 
173
.B replaygain <off or album or track or auto>
191
174
If specified, mpd will adjust the volume of songs played using ReplayGain tags
192
175
(see <\fBhttp://www.replaygain.org/\fP>).  Setting this to "album" will adjust
193
176
volume using the album's ReplayGain tags, while setting it to "track" will
194
 
adjust it using the track ReplayGain tags.  Currently only FLAC, Ogg Vorbis,
195
 
Musepack, and MP3 (through ID3v2 ReplayGain tags, not APEv2) are supported.
 
177
adjust it using the track ReplayGain tags.  "auto" uses the track ReplayGain
 
178
tags if random play is activated otherwise the album ReplayGain tags. Currently
 
179
only FLAC, Ogg Vorbis, Musepack, and MP3 (through ID3v2 ReplayGain tags, not
 
180
APEv2) are supported.
196
181
.TP
197
182
.B replaygain_preamp <-15 to 15>
198
183
This is the gain (in dB) applied to songs with ReplayGain tags.
265
250
"artist,album,title,track".  The special value "none" may be used alone to
266
251
disable all metadata.  The default is to use all known tag types except for
267
252
comments.
 
253
.TP
 
254
.B auto_update <yes or no>
 
255
This specifies the wheter to support automatic update of music database when
 
256
files are changed in music_directory. The default is to disable autoupdate
 
257
of database.
 
258
.TP
 
259
.B auto_update_depth <N>
 
260
Limit the depth of the directories being watched, 0 means only watch
 
261
the music directory itself.  There is no limit by default.
268
262
.SH REQUIRED AUDIO OUTPUT PARAMETERS
269
263
.TP
270
264
.B type <type>
280
274
audio that is sent to the audio output device.  See documentation for the
281
275
\fBaudio_output_format\fP parameter for more details.  The default is to use
282
276
whatever audio format is passed to the audio output.
 
277
Any of the three attributes may be an asterisk to specify that this
 
278
attribute should not be enforced
 
279
.TP
 
280
.B replay_gain_handler <software, mixer or none>
 
281
Specifies how replay gain is applied.  The default is "software",
 
282
which uses an internal software volume control.  "mixer" uses the
 
283
configured (hardware) mixer control.  "none" disables replay gain on
 
284
this audio output.
283
285
.SH OPTIONAL ALSA OUTPUT PARAMETERS
284
286
.TP
285
287
.B device <dev>
286
288
This specifies the device to use for audio output.  The default is "default".
287
289
.TP
 
290
.B mixer_type <hardware, software or none>
 
291
Specifies which mixer should be used for this audio output: the
 
292
hardware mixer (available for ALSA, OSS and PulseAudio), the software
 
293
mixer or no mixer ("none").  By default, the hardware mixer is used
 
294
for devices which support it, and none for the others.
 
295
.TP
288
296
.B mixer_device <mixer dev>
289
297
This specifies which mixer to use.  The default is "default".  To use
290
298
the second sound card in a system, use "hw:1".
352
360
.TP
353
361
.B sink <sink>
354
362
The sink to output to.  The default is to let PulseAudio choose a sink.
355
 
.SH REQUIRED JACK OUTPUT PARAMETERS
 
363
.SH OPTIONAL JACK OUTPUT PARAMETERS
356
364
.TP
357
 
.B name <name>
 
365
.B client_name <name>
358
366
The client name to use when connecting to JACK.  The output ports <name>:left
359
367
and <name>:right will also be created for the left and right channels,
360
368
respectively.
361
 
.SH OPTIONAL JACK OUTPUT PARAMETERS
362
369
.TP
363
370
.B ports <left_port,right_port>
364
371
This specifies the left and right ports to connect to for the left and right