This file is indexed.

/usr/share/doc/mpd/user-manual.html is in mpd 0.19.21-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Music Player Daemon - User's Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="idm1"></a>The Music Player Daemon - User's Manual</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dt><span class="chapter"><a href="#install">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#install_debian">Installing on Debian/Ubuntu</a></span></dt><dt><span class="section"><a href="#install_source">Compiling from source</a></span></dt><dt><span class="section"><a href="#systemd_socket"><code class="filename">systemd</code> socket activation</a></span></dt><dt><span class="section"><a href="#systemd_user"><code class="filename">systemd</code> user unit</a></span></dt></dl></dd><dt><span class="chapter"><a href="#config">3. Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#config_music_directory">Configuring the music directory</a></span></dt><dt><span class="section"><a href="#config_database_plugins">Configuring database plugins</a></span></dt><dt><span class="section"><a href="#config_neighbor_plugins">Configuring neighbor plugins</a></span></dt><dt><span class="section"><a href="#config_input_plugins">Configuring input plugins</a></span></dt><dt><span class="section"><a href="#config_decoder_plugins">Configuring decoder plugins</a></span></dt><dt><span class="section"><a href="#config_encoder_plugins">Configuring encoder plugins</a></span></dt><dt><span class="section"><a href="#config_audio_outputs">Configuring audio outputs</a></span></dt><dt><span class="section"><a href="#config_filters">Configuring filters</a></span></dt><dt><span class="section"><a href="#config_playlist_plugins">Configuring playlist plugins</a></span></dt><dt><span class="section"><a href="#config_audio_format">Audio Format Settings</a></span></dt><dd><dl><dt><span class="section"><a href="#config_global_audio_format">Global Audio Format</a></span></dt><dt><span class="section"><a href="#idm336">Resampler</a></span></dt></dl></dd><dt><span class="section"><a href="#config_other">Other Settings</a></span></dt><dd><dl><dt><span class="section"><a href="#idm441">The State File</a></span></dt><dt><span class="section"><a href="#idm468">Resource Limitations</a></span></dt><dt><span class="section"><a href="#idm510">Buffer Settings</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#advanced_config">4. Advanced configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#satellite">Satellite setup</a></span></dt><dt><span class="section"><a href="#realtime">Real-Time Scheduling</a></span></dt></dl></dd><dt><span class="chapter"><a href="#use">5. Using <span class="application">MPD</span></a></span></dt><dd><dl><dt><span class="section"><a href="#client">The client</a></span></dt><dt><span class="section"><a href="#music_directory_and_database">The music directory and the database</a></span></dt><dt><span class="section"><a href="#tags">Metadata</a></span></dt><dt><span class="section"><a href="#queue">The queue</a></span></dt></dl></dd><dt><span class="chapter"><a href="#advanced_usage">6. Advanced usage</a></span></dt><dd><dl><dt><span class="section"><a href="#bit_perfect">Bit-perfect playback</a></span></dt><dt><span class="section"><a href="#dsd">Direct Stream Digital (DSD)</a></span></dt></dl></dd><dt><span class="chapter"><a href="#plugin_reference">7. Plugin reference</a></span></dt><dd><dl><dt><span class="section"><a href="#database_plugins">Database plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm753"><code class="varname">simple</code></a></span></dt><dt><span class="section"><a href="#proxy_database"><code class="varname">proxy</code></a></span></dt><dt><span class="section"><a href="#idm804"><code class="varname">upnp</code></a></span></dt></dl></dd><dt><span class="section"><a href="#storage_plugins">Storage plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm810"><code class="varname">local</code></a></span></dt><dt><span class="section"><a href="#smbclient_storage"><code class="varname">smbclient</code></a></span></dt><dt><span class="section"><a href="#nfs_storage"><code class="varname">nfs</code></a></span></dt></dl></dd><dt><span class="section"><a href="#neighbor_plugins">Neighbor plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#smbclient_neighbor"><code class="varname">smbclient</code></a></span></dt><dt><span class="section"><a href="#upnp_neighbor"><code class="varname">upnp</code></a></span></dt></dl></dd><dt><span class="section"><a href="#input_plugins">Input plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm850"><code class="varname">alsa</code></a></span></dt><dt><span class="section"><a href="#idm860"><code class="varname">cdio_paranoia</code></a></span></dt><dt><span class="section"><a href="#idm879"><code class="varname">curl</code></a></span></dt><dt><span class="section"><a href="#idm912"><code class="varname">file</code></a></span></dt><dt><span class="section"><a href="#idm916"><code class="varname">mms</code></a></span></dt><dt><span class="section"><a href="#idm920"><code class="varname">nfs</code></a></span></dt><dt><span class="section"><a href="#idm932"><code class="varname">smbclient</code></a></span></dt></dl></dd><dt><span class="section"><a href="#decoder_plugins">Decoder plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#dsdiff_decoder"><code class="varname">dsdiff</code></a></span></dt><dt><span class="section"><a href="#dsf_decoder"><code class="varname">dsf</code></a></span></dt><dt><span class="section"><a href="#idm963"><code class="varname">fluidsynth</code></a></span></dt><dt><span class="section"><a href="#idm985"><code class="varname">mikmod</code></a></span></dt><dt><span class="section"><a href="#idm1009"><code class="varname">modplug</code></a></span></dt><dt><span class="section"><a href="#idm1027"><code class="varname">wildmidi</code></a></span></dt></dl></dd><dt><span class="section"><a href="#encoder_plugins">Encoder plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm1047"><code class="varname">flac</code></a></span></dt><dt><span class="section"><a href="#idm1064"><code class="varname">lame</code></a></span></dt><dt><span class="section"><a href="#idm1087"><code class="varname">null</code></a></span></dt><dt><span class="section"><a href="#idm1091"><code class="varname">shine</code></a></span></dt><dt><span class="section"><a href="#idm1108"><code class="varname">twolame</code></a></span></dt><dt><span class="section"><a href="#vorbis_encoder"><code class="varname">vorbis</code></a></span></dt><dt><span class="section"><a href="#idm1153"><code class="varname">wave</code></a></span></dt></dl></dd><dt><span class="section"><a href="#output_plugins">Output plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#alsa_output"><code class="varname">alsa</code></a></span></dt><dt><span class="section"><a href="#idm1259"><code class="varname">ao</code></a></span></dt><dt><span class="section"><a href="#idm1291"><code class="varname">fifo</code></a></span></dt><dt><span class="section"><a href="#idm1313"><code class="varname">jack</code></a></span></dt><dt><span class="section"><a href="#httpd_output"><code class="varname">httpd</code></a></span></dt><dt><span class="section"><a href="#idm1406"><code class="varname">null</code></a></span></dt><dt><span class="section"><a href="#oss_output"><code class="varname">oss</code></a></span></dt><dt><span class="section"><a href="#idm1470"><code class="varname">openal</code></a></span></dt><dt><span class="section"><a href="#idm1489"><code class="varname">osx</code></a></span></dt><dt><span class="section"><a href="#idm1493"><code class="varname">pipe</code></a></span></dt><dt><span class="section"><a href="#pulse_output"><code class="varname">pulse</code></a></span></dt><dt><span class="section"><a href="#idm1539"><code class="varname">roar</code></a></span></dt><dt><span class="section"><a href="#idm1564"><code class="varname">recorder</code></a></span></dt><dt><span class="section"><a href="#shout_output"><code class="varname">shout</code></a></span></dt><dt><span class="section"><a href="#idm1681"><code class="varname">solaris</code></a></span></dt></dl></dd><dt><span class="section"><a href="#playlist_plugins">Playlist plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm1701"><code class="varname">embcue</code></a></span></dt><dt><span class="section"><a href="#idm1705"><code class="varname">m3u</code></a></span></dt><dt><span class="section"><a href="#idm1710"><code class="varname">extm3u</code></a></span></dt><dt><span class="section"><a href="#idm1715"><code class="varname">pls</code></a></span></dt><dt><span class="section"><a href="#idm1720"><code class="varname">xspf</code></a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="intro"></a>Chapter 1. Introduction</h1></div></div></div><p>
      This document is work in progress.  Most of it may be incomplete
      yet.  Please help!
    </p><p>
      <span class="application">MPD</span> (Music Player Daemon) is, as the
      name suggests, a server software allowing you to remotely play
      your music, handle playlists, deliver music (HTTP streams with
      various sub-protocols) and organize playlists.
    </p><p>
      It has been written with minimal resource usage and stability in
      mind!  Infact, it runs fine on a Pentium 75, allowing you to use
      your cheap old PC to create a stereo system!
    </p><p>
      <span class="application">MPD</span> supports also gapless playback,
      buffered audio output, and crossfading!
    </p><p>
      The separate client and server design allows users to choose a
      user interface that best suites their tastes independently of
      the underlying daemon, which actually plays music!
    </p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="install"></a>Chapter 2. Installation</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#install_debian">Installing on Debian/Ubuntu</a></span></dt><dt><span class="section"><a href="#install_source">Compiling from source</a></span></dt><dt><span class="section"><a href="#systemd_socket"><code class="filename">systemd</code> socket activation</a></span></dt><dt><span class="section"><a href="#systemd_user"><code class="filename">systemd</code> user unit</a></span></dt></dl></div><p>
      We recommend that you use the software installation routines of
      your distribution to install <span class="application">MPD</span>.
      Most operating systems have a <span class="application">MPD</span>
      package, which is very easy to install.
    </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="install_debian"></a>Installing on Debian/Ubuntu</h2></div></div></div><p>
        Install the package <span class="application">MPD</span> via APT:
      </p><pre class="programlisting">apt-get install mpd</pre><p>
        When installed this way, <span class="application">MPD</span> by
        default looks for music in
        <code class="filename">/var/lib/mpd/music/</code>; this may not be
        correct. Look at your <code class="filename">/etc/mpd.conf</code>
        file...
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="install_source"></a>Compiling from source</h2></div></div></div><p>
        Download the source tarball from <a class="ulink" href="http://www.musicpd.org/download.html" target="_top">the
        <span class="application">MPD</span> home page</a> and unpack
        it:
      </p><pre class="programlisting">tar xf mpd-version.tar.xz
cd mpd-version</pre><p>
        Make sure that all the required libraries and build tools are
        installed.  The <code class="filename">INSTALL</code> file has a list.
      </p><p>
        For example, the following installs a fairly complete list of
        build dependencies on Debian Wheezy:
      </p><pre class="programlisting">
apt-get install g++ \
  libmad0-dev libmpg123-dev libid3tag0-dev \
  libflac-dev libvorbis-dev libopus-dev \
  libadplug-dev libaudiofile-dev libsndfile1-dev libfaad-dev \
  libfluidsynth-dev libgme-dev libmikmod2-dev libmodplug-dev \
  libmpcdec-dev libwavpack-dev libwildmidi-dev \
  libsidplay2-dev libsidutils-dev libresid-builder-dev \
  libavcodec-dev libavformat-dev \
  libmp3lame-dev \
  libsamplerate0-dev libsoxr-dev \
  libbz2-dev libcdio-paranoia-dev libiso9660-dev libmms-dev \
  libzzip-dev \
  libcurl4-gnutls-dev libyajl-dev libexpat-dev \
  libasound2-dev libao-dev libjack-jackd2-dev libopenal-dev \
  libpulse-dev libroar-dev libshout3-dev \
  libmpdclient-dev \
  libnfs-dev libsmbclient-dev \
  libupnp-dev \
  libavahi-client-dev \
  libsqlite3-dev \
  libsystemd-dev libwrap0-dev \
  libcppunit-dev xmlto \
  libboost-dev \
  libglib2.0-dev libicu-dev
      </pre><p>
        Now configure the source tree:
      </p><pre class="programlisting">./configure</pre><p>
        The <em class="parameter"><code>--help</code></em> argument shows a list of
        compile-time options.  When everything is ready and
        configured, compile:
      </p><pre class="programlisting">make</pre><p>
        And install:
      </p><pre class="programlisting">make install</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="systemd_socket"></a><code class="filename">systemd</code> socket activation</h2></div></div></div><p>
        Using <code class="filename">systemd</code>, you can launch
        <span class="application">MPD</span> on demand when the first client
        attempts to connect.
      </p><p>
        <span class="application">MPD</span> comes with two
        <span class="application">systemd</span> unit files: a "service"
        unit and a "socket" unit.  These will only be installed when
        <span class="application">MPD</span> was configured with
        <em class="parameter"><code>--with-systemdsystemunitdir=/lib/systemd/system</code></em>.
      </p><p>
        To enable socket activation, type:
      </p><pre class="programlisting">systemctl enable mpd.socket
systemctl start mpd.socket</pre><p>
        In this configuration, <span class="application">MPD</span> will
        ignore the <code class="varname">bind_to_address</code> and
        <code class="varname">port</code> settings.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="systemd_user"></a><code class="filename">systemd</code> user unit</h2></div></div></div><p>
        You can launch <span class="application">MPD</span> as a
        <code class="filename">systemd</code> user unit.  The service file will
        only be installed when <span class="application">MPD</span> was
        configured with
        <em class="parameter"><code>--with-systemduserunitdir=/usr/lib/systemd/user</code></em>
        or
        <em class="parameter"><code>--with-systemduserunitdir=$HOME/.local/share/systemd/user</code></em>.
      </p><p>
        Once the user unit is installed, you can start and stop
        <span class="application">MPD</span> like any other service:
      </p><pre class="programlisting">systemctl --user start mpd</pre><p>
        To auto-start <span class="application">MPD</span> upon login, type:
      </p><pre class="programlisting">systemctl --user enable mpd</pre></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="config"></a>Chapter 3. Configuration</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#config_music_directory">Configuring the music directory</a></span></dt><dt><span class="section"><a href="#config_database_plugins">Configuring database plugins</a></span></dt><dt><span class="section"><a href="#config_neighbor_plugins">Configuring neighbor plugins</a></span></dt><dt><span class="section"><a href="#config_input_plugins">Configuring input plugins</a></span></dt><dt><span class="section"><a href="#config_decoder_plugins">Configuring decoder plugins</a></span></dt><dt><span class="section"><a href="#config_encoder_plugins">Configuring encoder plugins</a></span></dt><dt><span class="section"><a href="#config_audio_outputs">Configuring audio outputs</a></span></dt><dt><span class="section"><a href="#config_filters">Configuring filters</a></span></dt><dt><span class="section"><a href="#config_playlist_plugins">Configuring playlist plugins</a></span></dt><dt><span class="section"><a href="#config_audio_format">Audio Format Settings</a></span></dt><dd><dl><dt><span class="section"><a href="#config_global_audio_format">Global Audio Format</a></span></dt><dt><span class="section"><a href="#idm336">Resampler</a></span></dt></dl></dd><dt><span class="section"><a href="#config_other">Other Settings</a></span></dt><dd><dl><dt><span class="section"><a href="#idm441">The State File</a></span></dt><dt><span class="section"><a href="#idm468">Resource Limitations</a></span></dt><dt><span class="section"><a href="#idm510">Buffer Settings</a></span></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_music_directory"></a>Configuring the music directory</h2></div></div></div><p>
        When you play local files, you should organize them within a
        directory called the "music directory".  This is configured in
        <span class="application">MPD</span> with the
        <code class="varname">music_directory</code> setting.
      </p><p>
        By default, <span class="application">MPD</span> follows symbolic
        links in the music directory.  This behavior can be switched
        off: <code class="varname">follow_outside_symlinks</code> controls
        whether <span class="application">MPD</span> follows links pointing
        to files outside of the music directory, and
        <code class="varname">follow_inside_symlinks</code> lets you disable
        symlinks to files inside the music directory.
      </p><p>
        Instead of using local files, you can use <a class="link" href="#storage_plugins" title="Storage plugins">storage plugins</a> to access
        files on a remote file server.  For example, to use music from
        the SMB/CIFS server "myfileserver" on the share called
        "Music", configure the music directory
        "<em class="parameter"><code>smb://myfileserver/Music</code></em>".  For a
        recipe, read the <a class="link" href="#satellite" title="Satellite setup">Satellite
        MPD</a> section.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_database_plugins"></a>Configuring database plugins</h2></div></div></div><p>
        If a music directory is configured, one database plugin is
        used.  To configure this plugin, add a
        <code class="varname">database</code> block to
        <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">database {
    plugin "simple"
    path "/var/lib/mpd/db"
}
      </pre><p>
        The following table lists the <code class="varname">database</code>
        options valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">plugin</code>
              </td><td>
                The name of the plugin.
              </td></tr></tbody></table></div><p>
        More information can be found in the <a class="link" href="#database_plugins" title="Database plugins">database plugin reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_neighbor_plugins"></a>Configuring neighbor plugins</h2></div></div></div><p>
        All neighbor plugins are disabled by default to avoid unwanted
        overhead.  To enable (and configure) a plugin, add a
        <code class="varname">neighbor</code> block to
        <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">neighbors {
    plugin "smbclient"
}
      </pre><p>
        The following table lists the <code class="varname">neighbor</code>
        options valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">plugin</code>
              </td><td>
                The name of the plugin.
              </td></tr></tbody></table></div><p>
        More information can be found in the <a class="link" href="#neighbor_plugins" title="Neighbor plugins">neighbor plugin reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_input_plugins"></a>Configuring input plugins</h2></div></div></div><p>
        To configure an input plugin, add a <code class="varname">input</code>
        block to <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">input {
    plugin "curl"
    proxy "proxy.local"
}
      </pre><p>
        The following table lists the <code class="varname">input</code> options
        valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">plugin</code>
              </td><td>
                The name of the plugin.
              </td></tr><tr><td>
                <code class="varname">enabled</code>
                <em class="parameter"><code>yes|no</code></em>
              </td><td>
                Allows you to disable a input plugin without
                recompiling.  By default, all plugins are enabled.
              </td></tr></tbody></table></div><p>
        More information can be found in the <a class="link" href="#input_plugins" title="Input plugins">input plugin reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_decoder_plugins"></a>Configuring decoder plugins</h2></div></div></div><p>
        Most decoder plugins do not need any special configuration.
        To configure a decoder, add a <code class="varname">decoder</code> block
        to <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">decoder {
    plugin "wildmidi"
    config_file "/etc/timidity/timidity.cfg"
}
      </pre><p>
        The following table lists the <code class="varname">decoder</code>
        options valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">plugin</code>
              </td><td>
                The name of the plugin.
              </td></tr><tr><td>
                <code class="varname">enabled</code>
                <em class="parameter"><code>yes|no</code></em>
              </td><td>
                Allows you to disable a decoder plugin without
                recompiling.  By default, all plugins are enabled.
              </td></tr></tbody></table></div><p>
        More information can be found in the <a class="link" href="#decoder_plugins" title="Decoder plugins">decoder plugin reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_encoder_plugins"></a>Configuring encoder plugins</h2></div></div></div><p>
        Encoders are used by some of the output plugins (such as <a class="link" href="#shout_output" title="shout"><code class="varname">shout</code></a>).  The
        encoder settings are included in the
        <code class="varname">audio_output</code> section.  More information can
        be found in the <a class="link" href="#encoder_plugins" title="Encoder plugins">encoder plugin
        reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_audio_outputs"></a>Configuring audio outputs</h2></div></div></div><p>
        Audio outputs are devices which actually play the audio chunks
        produced by <span class="application">MPD</span>.  You can configure
        any number of audio output devices, but there must be at least
        one.  If none is configured, <span class="application">MPD</span>
        attempts to auto-detect.  Usually, this works quite well with
        ALSA, OSS and on Mac OS X.
      </p><p>
        To configure an audio output manually, add an
        <code class="varname">audio_output</code> block to
        <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">audio_output {
    type "alsa"
    name "my ALSA device"
    device "hw:0"
}
      </pre><p>
        The following table lists the <code class="varname">audio_output</code>
        options valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">type</code>
              </td><td>
                The name of the plugin.
              </td></tr><tr><td>
                <code class="varname">name</code>
              </td><td>
                The name of the audio output.  It is visible to the
                client.  Some plugins also use it internally, e.g. as
                a name registered in the PULSE server.
              </td></tr><tr><td><a name="ao_format"></a>
                <code class="varname">format</code>
              </td><td>
                <p>
                  Always open the audio output with the specified audio
                  format (samplerate:bits:channels), regardless of the
                  format of the input file.  This is optional for most
                  plugins.
                </p>
                <p>
                  Any of the three attributes may be an asterisk to
                  specify that this attribute should not be enforced,
                  example: <em class="parameter"><code>48000:16:*</code></em>.
                  <em class="parameter"><code>*:*:*</code></em> is equal to not having
                  a <code class="varname">format</code> specification.
                </p>
                <p>
                  The following values are valid for
                  <code class="varname">bits</code>: <code class="varname">8</code>
                  (signed 8 bit integer samples),
                  <code class="varname">16</code>, <code class="varname">24</code> (signed
                  24 bit integer samples padded to 32 bit),
                  <code class="varname">32</code> (signed 32 bit integer
                  samples), <code class="varname">f</code> (32 bit floating
                  point, -1.0 to 1.0).
                </p>
              </td></tr><tr><td>
                <code class="varname">enabled</code>
                  <em class="parameter"><code>yes|no</code></em>
              </td><td>
                Specifies whether this audio output is enabled when
                <span class="application">MPD</span> is started.  By
                default, all audio outputs are enabled.
              </td></tr><tr><td>
                <code class="varname">tags</code>
                <em class="parameter"><code>yes|no</code></em>
              </td><td>
                If set to <em class="parameter"><code>no</code></em>, then
                <span class="application">MPD</span> will not send tags to
                this output.  This is only useful for output plugins
                that can receive tags, for example the <a class="link" href="#httpd_output" title="httpd"><code class="varname">httpd</code></a>
                output plugin.
              </td></tr><tr><td>
                <code class="varname">always_on</code>
                  <em class="parameter"><code>yes|no</code></em>
              </td><td>
                If set to <em class="parameter"><code>yes</code></em>, then
                <span class="application">MPD</span> attempts to keep this
                audio output always open.  This may be useful for
                streaming servers, when you don't want to disconnect
                all listeners even when playback is accidentally
                stopped.
              </td></tr><tr><td>
                <code class="varname">mixer_type</code>
                <em class="parameter"><code>hardware|software|none</code></em>
              </td><td>
                Specifies which mixer should be used for this audio
                output: the hardware mixer (available for <a class="link" href="#alsa_output" title="alsa">ALSA</a>, <a class="link" href="#oss_output" title="oss">OSS</a> and <a class="link" href="#pulse_output" title="pulse">PulseAudio</a>), the
                software mixer or no mixer
                (<em class="parameter"><code>none</code></em>).  By default, the
                hardware mixer is used for devices which support it,
                and none for the others.
              </td></tr><tr><td>
                <code class="varname">replay_gain_handler</code>
                <em class="parameter"><code>software|mixer|none</code></em>
              </td><td>
                Specifies how replay gain is applied.  The default is
                <em class="parameter"><code>software</code></em>, which uses an
                internal software volume control.
                <em class="parameter"><code>mixer</code></em> uses the configured
                (hardware) mixer control.  <em class="parameter"><code>none</code></em>
                disables replay gain on this audio output.
              </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_filters"></a>Configuring filters</h2></div></div></div><p>
        Filters are plugins which modify an audio stream.
      </p><p>
        To configure a filter, add a <code class="varname">filter</code> block
        to <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">filter {
    plugin "volume"
    name "software volume"
}
      </pre><p>
        The following table lists the <code class="varname">filter</code>
        options valid for all plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">plugin</code>
              </td><td>
                The name of the plugin.
              </td></tr><tr><td>
                <code class="varname">name</code>
              </td><td>
                The name of the filter.
              </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_playlist_plugins"></a>Configuring playlist plugins</h2></div></div></div><p>
        Playlist plugins are used to load remote playlists.  This is
        not related to <span class="application">MPD</span>'s playlist
        directory.
      </p><p>
        To configure a playlist plugin, add a
        <code class="varname">playlist_plugin</code> block to
        <code class="filename">mpd.conf</code>:
      </p><pre class="programlisting">playlist_plugin {
    name "m3u"
    enabled "true"
}
      </pre><p>
        The following table lists the
        <code class="varname">playlist_plugin</code> options valid for all
        plugins:
      </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                Name
              </th><th>
                Description
              </th></tr></thead><tbody><tr><td>
                <code class="varname">name</code>
              </td><td>
                The name of the plugin.
              </td></tr><tr><td>
                <code class="varname">enabled</code>
                <em class="parameter"><code>yes|no</code></em>
              </td><td>
                Allows you to disable a input plugin without
                recompiling.  By default, all plugins are enabled.
              </td></tr></tbody></table></div><p>
        More information can be found in the <a class="link" href="#playlist_plugins" title="Playlist plugins">playlist plugin reference</a>.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_audio_format"></a>Audio Format Settings</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="config_global_audio_format"></a>Global Audio Format</h3></div></div></div><p>
          The setting <code class="varname">audio_output_format</code> forces
          <span class="application">MPD</span> to use one audio format for
          all outputs.  Doing that is usually not a good idea.  The
          values are the same as in <a class="link" href="#ao_format"><code class="varname">format</code> in the <code class="varname">audio_output</code>
          section</a>.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm336"></a>Resampler</h3></div></div></div><p>
          Sometimes, music needs to be resampled before it can be
          played; for example, CDs use a sample rate of 44,100 Hz
          while many cheap audio chips can only handle 48,000 Hz.
          Resampling reduces the quality and consumes a lot of CPU.
          There are different options, some of them optimized for high
          quality and others for low CPU usage, but you can't have
          both at the same time.  Often, the resampler is the
          component that is responsible for most of
          <span class="application">MPD</span>'s CPU usage.  Since
          <span class="application">MPD</span> comes with high quality
          defaults, it may appear that <span class="application">MPD</span>
          consumes more CPU than other software.
        </p><p>
          The following resamplers are available (if enabled at
          compile time):
        </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
              <a class="ulink" href="http://www.mega-nerd.com/SRC/" target="_top"><span class="application">libsamplerate</span></a>
              a.k.a. Secret Rabbit Code (SRC).
            </p></li><li class="listitem"><p>
              <a class="ulink" href="http://sourceforge.net/projects/soxr/" target="_top"><span class="application">libsoxr</span></a>,
              the SoX Resampler library
            </p></li><li class="listitem"><p>
              internal: low CPU usage, but very poor quality.  This is
              the fallback if <span class="application">MPD</span> was
              compiled without an external resampler.
            </p></li></ul></div><p>
          The setting <code class="varname">samplerate_converter</code> controls
          how <span class="application">MPD</span> shall resample music.
          Possible values:
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>
                  Value
                </th><th>
                  Description
                </th></tr></thead><tbody><tr><td>
                  "<em class="parameter"><code>internal</code></em>"
                </td><td>
                  The internal resampler.  Low CPU usage, but very
                  poor quality.
                </td></tr><tr><td>
                  "<em class="parameter"><code>soxr very high</code></em>"
                </td><td>
                  Use <span class="application">libsoxr</span> with "Very
                  High Quality" setting.
                </td></tr><tr><td>
                  "<em class="parameter"><code>soxr high</code></em>" or
                  "<em class="parameter"><code>soxr</code></em>"
                </td><td>
                  Use <span class="application">libsoxr</span> with "High
                  Quality" setting.
                </td></tr><tr><td>
                  "<em class="parameter"><code>soxr medium</code></em>"
                </td><td>
                  Use <span class="application">libsoxr</span> with "Medium
                  Quality" setting.
                </td></tr><tr><td>
                  "<em class="parameter"><code>soxr low</code></em>"
                </td><td>
                  Use <span class="application">libsoxr</span> with "Low
                  Quality" setting.
                </td></tr><tr><td>
                  "<em class="parameter"><code>soxr quick</code></em>"
                </td><td>
                  Use <span class="application">libsoxr</span> with "Quick"
                  setting.
                </td></tr><tr><td>
                  "<em class="parameter"><code>Best Sinc Interpolator</code></em>" or
                  "<em class="parameter"><code>0</code></em>"
                </td><td>
                  <span class="application">libsamplerate</span>: Band
                  limited sinc interpolation, best quality, 97dB SNR,
                  96% BW.
                </td></tr><tr><td>
                  "<em class="parameter"><code>Medium Sinc Interpolator</code></em>" or
                  "<em class="parameter"><code>1</code></em>"
                </td><td>
                  <span class="application">libsamplerate</span>: Band
                  limited sinc interpolation, medium quality, 97dB
                  SNR, 90% BW.
                </td></tr><tr><td>
                  "<em class="parameter"><code>Fastest Sinc Interpolator</code></em>" or
                  "<em class="parameter"><code>2</code></em>"
                </td><td>
                  <span class="application">libsamplerate</span>: Band
                  limited sinc interpolation, fastest, 97dB SNR, 80%
                  BW.
                </td></tr><tr><td>
                  "<em class="parameter"><code>ZOH Sinc Interpolator</code></em>" or
                  "<em class="parameter"><code>3</code></em>"
                </td><td>
                  <span class="application">libsamplerate</span>: Zero order
                  hold interpolator, very fast, very poor quality with
                  audible distortions.
                </td></tr><tr><td>
                  "<em class="parameter"><code>Linear Interpolator</code></em>" or
                  "<em class="parameter"><code>4</code></em>"
                </td><td>
                  <span class="application">libsamplerate</span>: Linear
                  interpolator, very fast, poor quality.
                </td></tr></tbody></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="config_other"></a>Other Settings</h2></div></div></div><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                <code class="varname">metadata_to_use</code>
                <em class="parameter"><code>TAG1,TAG2,...</code></em>
              </td><td>
                Use only the specified tags, and ignore the others.
                This setting can reduce the database size and
                <span class="application">MPD</span>'s memory usage by
                omitting unused tags.  By default, all tags but
                <code class="varname">comment</code> are enabled.  The special
                value "none" disables all tags.
              </td></tr></tbody></table></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm441"></a>The State File</h3></div></div></div><p>
          The <span class="emphasis"><em>state file</em></span> is a file where
          <span class="application">MPD</span> saves and restores its state
          (play queue, playback position etc.) to keep it persistent
          across restarts and reboots.  It is an optional setting.
        </p><p>
          <span class="application">MPD</span> will attempt to load the
          state file during startup, and will save it when shutting
          down the daemon.  Additionally, the state file is refreshed
          every two minutes (after each state change).
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">state_file</code>
                  <em class="parameter"><code>PATH</code></em>
                </td><td>
                  Specify the state file location.  The parent
                  directory must be writable by the
                  <span class="application">MPD</span> user
                  (<em class="parameter"><code>+wx</code></em>).
                </td></tr><tr><td>
                  <code class="varname">state_file_interval</code>
                  <em class="parameter"><code>SECONDS</code></em>
                </td><td>
                  Auto-save the state file this number of seconds
                  after each state change.  Defaults to
                  <em class="parameter"><code>120</code></em> (2 minutes).
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm468"></a>Resource Limitations</h3></div></div></div><p>
          These settings are various limitations to prevent
          <span class="application">MPD</span> from using too many
          resources (denial of service).
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">connection_timeout</code>
                  <em class="parameter"><code>SECONDS</code></em>
                </td><td>
                  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
                  <em class="parameter"><code>60</code></em>.
                </td></tr><tr><td>
                  <code class="varname">max_connections</code>
                  <em class="parameter"><code>NUMBER</code></em>
                </td><td>
                  This specifies the maximum number of clients that
                  can be connected to <span class="application">MPD</span>
                  at the same time.  Default is
                  <em class="parameter"><code>5</code></em>.
                </td></tr><tr><td>
                  <code class="varname">max_playlist_length</code>
                  <em class="parameter"><code>NUMBER</code></em>
                </td><td>
                  The maximum number of songs that can be in the
                  playlist.  Default is <em class="parameter"><code>16384</code></em>.
                </td></tr><tr><td>
                  <code class="varname">max_command_list_size</code>
                  <em class="parameter"><code>KBYTES</code></em>
                </td><td>
                  The maximum size a command list.  Default is
                  <em class="parameter"><code>2048</code></em> (2 MiB).
                </td></tr><tr><td>
                  <code class="varname">max_output_buffer_size</code>
                  <em class="parameter"><code>KBYTES</code></em>
                </td><td>
                  The maximum size of the output buffer to a client
                  (maximum response size).  Default is
                  <em class="parameter"><code>8192</code></em> (8 MiB).
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm510"></a>Buffer Settings</h3></div></div></div><p>
          Do not change these unless you know what you are doing.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">audio_buffer_size</code>
                  <em class="parameter"><code>KBYTES</code></em>
                </td><td>
                  Adjust the size of the internal audio buffer.
                  Default is <em class="parameter"><code>4096</code></em> (4 MiB).
                </td></tr><tr><td>
                  <code class="varname">buffer_before_play</code>
                  <em class="parameter"><code>PERCENT</code></em>
                </td><td>
                  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
                  <em class="parameter"><code>10%</code></em>.
                </td></tr></tbody></table></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="advanced_config"></a>Chapter 4. Advanced configuration</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#satellite">Satellite setup</a></span></dt><dt><span class="section"><a href="#realtime">Real-Time Scheduling</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="satellite"></a>Satellite setup</h2></div></div></div><p>
        <span class="application">MPD</span> runs well on weak machines such
        as the <a class="ulink" href="http://www.raspberrypi.org/" target="_top">Raspberry
        Pi</a>.  However, such hardware tends to not have storage
        big enough to hold a music collection.  Mounting music from a
        file server can be very slow, especially when updating the
        database.
      </p><p>
        One approach for optimization is running
        <span class="application">MPD</span> on the file server, which not
        only exports raw files, but also provides access to a readily
        scanned database.  Example configuration:
      </p><pre class="programlisting">music_directory "nfs://fileserver.local/srv/mp3"
#music_directory "smb://fileserver.local/mp3"

database {
    plugin "proxy"
    host "fileserver.local"
}
      </pre><p>
        The <a class="link" href="#config_music_directory" title="Configuring the music directory"><code class="varname">music_directory</code></a>
        setting tells <span class="application">MPD</span> to read files
        from the given NFS server.  It does this by connecting to the
        server from userspace.  This does not actually mount the file
        server into the kernel's virtual file system, and thus
        requires no kernel cooperation and no special privileges.  It
        does not even require a kernel with NFS support, only the
        <a class="link" href="#nfs_storage" title="nfs"><code class="filename">nfs</code></a>
        storage plugin (using the <code class="filename">libnfs</code>
        userspace library).  The same can be done with SMB/CIFS using
        the <a class="link" href="#smbclient_storage" title="smbclient"><code class="filename">smbclient</code></a>
        storage plugin (using <code class="filename">libsmbclient</code>).
      </p><p>
        The <a class="link" href="#config_database_plugins" title="Configuring database plugins"><code class="varname">database</code></a>
        setting tells <span class="application">MPD</span> to pass all
        database queries on to the <span class="application">MPD</span>
        instance running on the file server (using the <a class="link" href="#proxy_database" title="proxy"><code class="filename">proxy</code></a>
        plugin).
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="realtime"></a>Real-Time Scheduling</h2></div></div></div><p>
        On Linux, <span class="application">MPD</span> attempts to configure
        <a class="ulink" href="https://en.wikipedia.org/wiki/Real-time_computing" target="_top">real-time
        scheduling</a> for some threads that benefit from it.
      </p><p>
        This is only possible you allow <span class="application">MPD</span>
        to do it.  This privilege is controlled by
        <code class="varname">RLIMIT_RTPRIO</code>
        <code class="varname">RLIMIT_RTTIME</code>.  You can configure this
        privilege with <span class="command"><strong>ulimit</strong></span> before launching
        <span class="application">MPD</span>:
      </p><pre class="programlisting">ulimit -HS -r 50; mpd</pre><p>
        Or you can use the <span class="command"><strong>prlimit</strong></span> program from the
        <span class="application">util-linux</span> package:
      </p><pre class="programlisting">prlimit --rtprio=50 --rttime=unlimited mpd</pre><p>
        The <span class="application">systemd</span> service file shipped
        with <span class="application">MPD</span> comes with this setting.
      </p><p>
        This works only if the Linux kernel was compiled with
        <code class="varname">CONFIG_RT_GROUP_SCHED</code> disabled.  Use the
        following command to check this option for your current
        kernel:
      </p><pre class="programlisting">zgrep ^CONFIG_RT_GROUP_SCHED /proc/config.gz</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
          There is a rumor that real-time scheduling improves audio
          quality.  That is not true.  All it does is reduce the
          probability of skipping (audio buffer xruns) when the
          computer is under heavy load.
        </p></div></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="use"></a>Chapter 5. Using <span class="application">MPD</span></h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#client">The client</a></span></dt><dt><span class="section"><a href="#music_directory_and_database">The music directory and the database</a></span></dt><dt><span class="section"><a href="#tags">Metadata</a></span></dt><dt><span class="section"><a href="#queue">The queue</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="client"></a>The client</h2></div></div></div><p>
        After you have installed, configured and started
        <span class="application">MPD</span>, you choose a client to control
        the playback.
      </p><p>
        The most basic client is <code class="filename">mpc</code>, which
        provides a command line interface.  It is useful in shell
        scripts.  Many people bind specific <code class="filename">mpc</code>
        commands to hotkeys.
      </p><p>
        The <a class="ulink" href="http://www.musicpd.org/clients/" target="_top"><span class="application">MPD</span>
        Wiki</a> contains an extensive list of clients to choose
        from.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="music_directory_and_database"></a>The music directory and the database</h2></div></div></div><p>
        The "music directory" is where you store your music files.
        <span class="application">MPD</span> stores all relevant meta
        information about all songs in its "database".  Whenever you
        add, modify or remove songs in the music directory, you have
        to update the database, for example with
        <code class="filename">mpc</code>:
      </p><pre class="programlisting">mpc update</pre><p>
        Depending on the size of your music collection and the speed
        of the storage, this can take a while.
      </p><p>
        To exclude a file from the update, create a file called
        <code class="filename">.mpdignore</code> in its parent directory.  Each
        line of that file may contain a list of shell wildcards.
      </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="tags"></a>Metadata</h2></div></div></div><p>
        When scanning or playing a song,
        <span class="application">MPD</span> parses its metadata.  The
        following tags are supported:
      </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
      <code class="varname">artist</code>: the artist name.  Its meaning is not
      well-defined; see <code class="varname">composer</code> and
      <code class="varname">performer</code> for more specific tags.
    </p></li><li class="listitem"><p>
      <code class="varname">artistsort</code>: same as
      <code class="varname">artist</code>, but for sorting.  This usually omits
      prefixes such as "The".
    </p></li><li class="listitem"><p>
      <code class="varname">album</code>: the album name.
    </p></li><li class="listitem"><p>
      <code class="varname">albumsort</code>: same as <code class="varname">album</code>,
      but for sorting.
    </p></li><li class="listitem"><p>
      <code class="varname">albumartist</code>: on multi-artist albums, this is
      the artist name which shall be used for the whole album.  The
      exact meaning of this tag is not well-defined.
    </p></li><li class="listitem"><p>
      <code class="varname">albumartistsort</code>: same as
      <code class="varname">albumartist</code>, but for sorting.
    </p></li><li class="listitem"><p>
      <code class="varname">title</code>: the song title.
    </p></li><li class="listitem"><p>
      <code class="varname">track</code>: the track number within the album.
    </p></li><li class="listitem"><p>
      <code class="varname">name</code>: a name for this song.  This is not the
      song title.  The exact meaning of this tag is not well-defined.
      It is often used by badly configured internet radio stations
      with broken tags to squeeze both the artist name and the song
      title in one tag.
    </p></li><li class="listitem"><p>
      <code class="varname">genre</code>: the music genre.
    </p></li><li class="listitem"><p>
      <code class="varname">date</code>: the song's release date.  This is
      usually a 4-digit year.
    </p></li><li class="listitem"><p>
      <code class="varname">composer</code>: the artist who composed the song.
    </p></li><li class="listitem"><p>
      <code class="varname">performer</code>: the artist who performed the song.
    </p></li><li class="listitem"><p>
      <code class="varname">comment</code>: a human-readable comment about this
      song.  The exact meaning of this tag is not well-defined.
    </p></li><li class="listitem"><p>
      <code class="varname">disc</code>: the disc number in a multi-disc album.
    </p></li><li class="listitem"><p>
      <code class="varname">musicbrainz_artistid</code>: the artist id in the
      <a class="ulink" href="http://musicbrainz.org/doc/MusicBrainzTag" target="_top">MusicBrainz</a>
      database.
    </p></li><li class="listitem"><p>
      <code class="varname">musicbrainz_albumid</code>: the album id in the
      <a class="ulink" href="http://musicbrainz.org/doc/MusicBrainzTag" target="_top">MusicBrainz</a>
      database.
    </p></li><li class="listitem"><p>
      <code class="varname">musicbrainz_albumartistid</code>: the album artist
      id in the <a class="ulink" href="http://musicbrainz.org/doc/MusicBrainzTag" target="_top">MusicBrainz</a>
      database.
    </p></li><li class="listitem"><p>
      <code class="varname">musicbrainz_trackid</code>: the track id in the
      <a class="ulink" href="http://musicbrainz.org/doc/MusicBrainzTag" target="_top">MusicBrainz</a>
      database.
    </p></li><li class="listitem"><p>
      <code class="varname">musicbrainz_releasetrackid</code>: the release track
      id in the <a class="ulink" href="http://musicbrainz.org/doc/MusicBrainzTag" target="_top">MusicBrainz</a>
      database.
    </p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="queue"></a>The queue</h2></div></div></div><p>
        The queue (sometimes called "current playlist") is a list of
        songs to be played by <span class="application">MPD</span>.  To play
        a song, add it to the queue and start playback.  Most clients
        offer an interface to edit the queue.
      </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="advanced_usage"></a>Chapter 6. Advanced usage</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#bit_perfect">Bit-perfect playback</a></span></dt><dt><span class="section"><a href="#dsd">Direct Stream Digital (DSD)</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="bit_perfect"></a>Bit-perfect playback</h2></div></div></div><p>
        "Bit-perfect playback" is a phrase used by audiophiles to
        describe a setup that plays back digital music as-is, without
        applying any modifications such as resampling, format
        conversion or software volume.  Naturally, this implies a
        lossless codec.
      </p><p>
        By default, <span class="application">MPD</span> attempts to do
        bit-perfect playback, unless you tell it not to.  Precondition
        is a sound chip that supports the audio format of your music
        files.  If the audio format is not supported,
        <span class="application">MPD</span> attempts to fall back to the
        nearest supported audio format, trying to lose as little
        quality as possible.
      </p><p>
        To verify if <span class="application">MPD</span> converts the audio
        format, enable verbose logging, and watch for these lines:
      </p><pre class="programlisting">decoder: audio_format=44100:24:2, seekable=true
output: opened plugin=alsa name="An ALSA output" audio_format=44100:16:2
output: converting from 44100:24:2</pre><p>
        This example shows that a 24 bit file is being played, but the
        sond chip cannot play 24 bit.  It falls back to 16 bit,
        discarding 8 bit.
      </p><p>
        However, this does not yet prove bit-perfect playback;
        <span class="application">ALSA</span> may be fooling
        <span class="application">MPD</span> that the audio format is
        supported.  To verify the format really being sent to the
        physical sound chip, try:
      </p><pre class="programlisting">cat /proc/asound/card*/pcm*p/sub*/hw_params
access: RW_INTERLEAVED
format: S16_LE
subformat: STD
channels: 2
rate: 44100 (44100/1)
period_size: 4096
buffer_size: 16384</pre><p>
        Obey the "format" row, which indicates that the current
        playback format is 16 bit (signed 16 bit integer, little
        endian).
      </p><p>
        Check list for bit-perfect playback:
      </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
            Use the <a class="link" href="#alsa_output" title="alsa">ALSA</a> output
            plugin.
          </p></li><li class="listitem"><p>
            Disable sound processing inside
            <span class="application">ALSA</span> by configuring a
            "hardware" device (<em class="parameter"><code>hw:0,0</code></em> or
            similar).
          </p></li><li class="listitem"><p>
            Don't use software volume (setting <a class="link" href="#config_audio_outputs" title="Configuring audio outputs"><code class="varname">mixer_type</code></a>).
          </p></li><li class="listitem"><p>
            Don't force <span class="application">MPD</span> to use a
            specific audio format (settings <a class="link" href="#config_audio_outputs" title="Configuring audio outputs"><code class="varname">format</code></a>,
            <a class="link" href="#config_global_audio_format" title="Global Audio Format"><code class="varname">audio_output_format</code></a>).
          </p></li><li class="listitem"><p>
            Verify that you are really doing bit-perfect playback
            using <span class="application">MPD</span>'s verbose log and
            <code class="filename">/proc/asound/card*/pcm*p/sub*/hw_params</code>.
            Some DACs can also indicate the audio format.
          </p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="dsd"></a>Direct Stream Digital (DSD)</h2></div></div></div><p>
        DSD (<a class="ulink" href="https://en.wikipedia.org/wiki/Direct_Stream_Digital" target="_top">Direct
        Stream Digital</a>) is a digital format that stores audio
        as a sequence of single-bit values at a very high sampling
        rate.
      </p><p>
        <span class="application">MPD</span> understands the file formats
        <a class="link" href="#dsdiff_decoder" title="dsdiff"><code class="filename">dff</code></a>
        and <a class="link" href="#dsf_decoder" title="dsf"><code class="filename">dsf</code></a>.  There
        are three ways to play back DSD:
      </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
            Native DSD playback.  Requires
            <span class="application">ALSA</span> 1.0.27.1 or later, a sound
            driver/chip that supports DSD and of course a DAC that
            supports DSD.
          </p></li><li class="listitem"><p>
            DoP (DSD over PCM) playback.  This wraps DSD inside fake
            24 bit PCM according to the <a class="ulink" href="http://dsd-guide.com/dop-open-standard" target="_top">DoP
            standard</a>.  Requires a DAC that supports DSD.  No
            support from ALSA and the sound chip required (except for
            <a class="link" href="#bit_perfect" title="Bit-perfect playback">bit-perfect</a> 24 bit PCM
            support).
          </p></li><li class="listitem"><p>
            Convert DSD to PCM on-the-fly.
          </p></li></ul></div><p>
        Native DSD playback is used automatically if available.  DoP
        is only used if enabled explicitly using the <a class="link" href="#alsa_output" title="alsa"><code class="varname">dop</code></a> option,
        because there is no way for <span class="application">MPD</span> to
        find out whether the DAC supports it.  DSD to PCM conversion
        is the fallback if DSD cannot be used directly.
      </p></div></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="plugin_reference"></a>Chapter 7. Plugin reference</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#database_plugins">Database plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm753"><code class="varname">simple</code></a></span></dt><dt><span class="section"><a href="#proxy_database"><code class="varname">proxy</code></a></span></dt><dt><span class="section"><a href="#idm804"><code class="varname">upnp</code></a></span></dt></dl></dd><dt><span class="section"><a href="#storage_plugins">Storage plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm810"><code class="varname">local</code></a></span></dt><dt><span class="section"><a href="#smbclient_storage"><code class="varname">smbclient</code></a></span></dt><dt><span class="section"><a href="#nfs_storage"><code class="varname">nfs</code></a></span></dt></dl></dd><dt><span class="section"><a href="#neighbor_plugins">Neighbor plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#smbclient_neighbor"><code class="varname">smbclient</code></a></span></dt><dt><span class="section"><a href="#upnp_neighbor"><code class="varname">upnp</code></a></span></dt></dl></dd><dt><span class="section"><a href="#input_plugins">Input plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm850"><code class="varname">alsa</code></a></span></dt><dt><span class="section"><a href="#idm860"><code class="varname">cdio_paranoia</code></a></span></dt><dt><span class="section"><a href="#idm879"><code class="varname">curl</code></a></span></dt><dt><span class="section"><a href="#idm912"><code class="varname">file</code></a></span></dt><dt><span class="section"><a href="#idm916"><code class="varname">mms</code></a></span></dt><dt><span class="section"><a href="#idm920"><code class="varname">nfs</code></a></span></dt><dt><span class="section"><a href="#idm932"><code class="varname">smbclient</code></a></span></dt></dl></dd><dt><span class="section"><a href="#decoder_plugins">Decoder plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#dsdiff_decoder"><code class="varname">dsdiff</code></a></span></dt><dt><span class="section"><a href="#dsf_decoder"><code class="varname">dsf</code></a></span></dt><dt><span class="section"><a href="#idm963"><code class="varname">fluidsynth</code></a></span></dt><dt><span class="section"><a href="#idm985"><code class="varname">mikmod</code></a></span></dt><dt><span class="section"><a href="#idm1009"><code class="varname">modplug</code></a></span></dt><dt><span class="section"><a href="#idm1027"><code class="varname">wildmidi</code></a></span></dt></dl></dd><dt><span class="section"><a href="#encoder_plugins">Encoder plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm1047"><code class="varname">flac</code></a></span></dt><dt><span class="section"><a href="#idm1064"><code class="varname">lame</code></a></span></dt><dt><span class="section"><a href="#idm1087"><code class="varname">null</code></a></span></dt><dt><span class="section"><a href="#idm1091"><code class="varname">shine</code></a></span></dt><dt><span class="section"><a href="#idm1108"><code class="varname">twolame</code></a></span></dt><dt><span class="section"><a href="#vorbis_encoder"><code class="varname">vorbis</code></a></span></dt><dt><span class="section"><a href="#idm1153"><code class="varname">wave</code></a></span></dt></dl></dd><dt><span class="section"><a href="#output_plugins">Output plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#alsa_output"><code class="varname">alsa</code></a></span></dt><dt><span class="section"><a href="#idm1259"><code class="varname">ao</code></a></span></dt><dt><span class="section"><a href="#idm1291"><code class="varname">fifo</code></a></span></dt><dt><span class="section"><a href="#idm1313"><code class="varname">jack</code></a></span></dt><dt><span class="section"><a href="#httpd_output"><code class="varname">httpd</code></a></span></dt><dt><span class="section"><a href="#idm1406"><code class="varname">null</code></a></span></dt><dt><span class="section"><a href="#oss_output"><code class="varname">oss</code></a></span></dt><dt><span class="section"><a href="#idm1470"><code class="varname">openal</code></a></span></dt><dt><span class="section"><a href="#idm1489"><code class="varname">osx</code></a></span></dt><dt><span class="section"><a href="#idm1493"><code class="varname">pipe</code></a></span></dt><dt><span class="section"><a href="#pulse_output"><code class="varname">pulse</code></a></span></dt><dt><span class="section"><a href="#idm1539"><code class="varname">roar</code></a></span></dt><dt><span class="section"><a href="#idm1564"><code class="varname">recorder</code></a></span></dt><dt><span class="section"><a href="#shout_output"><code class="varname">shout</code></a></span></dt><dt><span class="section"><a href="#idm1681"><code class="varname">solaris</code></a></span></dt></dl></dd><dt><span class="section"><a href="#playlist_plugins">Playlist plugins</a></span></dt><dd><dl><dt><span class="section"><a href="#idm1701"><code class="varname">embcue</code></a></span></dt><dt><span class="section"><a href="#idm1705"><code class="varname">m3u</code></a></span></dt><dt><span class="section"><a href="#idm1710"><code class="varname">extm3u</code></a></span></dt><dt><span class="section"><a href="#idm1715"><code class="varname">pls</code></a></span></dt><dt><span class="section"><a href="#idm1720"><code class="varname">xspf</code></a></span></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="database_plugins"></a>Database plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm753"></a><code class="varname">simple</code></h3></div></div></div><p>
          The default plugin.  Stores a copy of the database in
          memory.  A file is used for permanent storage.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">path</code>
                </td><td>
                  The path of the database file.
                </td></tr><tr><td>
                  <code class="varname">cache_directory</code>
                </td><td>
                  The path of the cache directory for additional
                  storages mounted at runtime.  This setting is
                  necessary for the <span class="command"><strong>mount</strong></span> protocol
                  command.
                </td></tr><tr><td>
                  <code class="varname">compress</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Compress the database file using
                  <code class="filename">gzip</code>?  Enabled by default (if
                  built with <code class="filename">zlib</code>).
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="proxy_database"></a><code class="varname">proxy</code></h3></div></div></div><p>
          Provides access to the database of another
          <span class="application">MPD</span> instance using
          <code class="filename">libmpdclient</code>.  This is useful when you
          run mount the music directory via NFS/SMB, and the file
          server already runs a <span class="application">MPD</span>
          instance.  Only the file server needs to update the
          database.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">host</code>
                </td><td>
                  The host name of the "master"
                  <span class="application">MPD</span> instance.
                </td></tr><tr><td>
                  <code class="varname">port</code>
                </td><td>
                  The port number of the "master"
                  <span class="application">MPD</span> instance.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm804"></a><code class="varname">upnp</code></h3></div></div></div><p>
          Provides access to UPnP media servers.
        </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="storage_plugins"></a>Storage plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm810"></a><code class="varname">local</code></h3></div></div></div><p>
          The default plugin which gives
          <span class="application">MPD</span> access to local files.  It is
          used when <code class="varname">music_directory</code> refers to a
          local directory.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="smbclient_storage"></a><code class="varname">smbclient</code></h3></div></div></div><p>
          Load music files from a SMB/CIFS server.  It used used when
          <code class="varname">music_directory</code> contains a
          <em class="parameter"><code>smb://</code></em> URI, for example
          "<em class="parameter"><code>smb://myfileserver/Music</code></em>".
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="nfs_storage"></a><code class="varname">nfs</code></h3></div></div></div><p>
          Load music files from a NFS server.  It used used when
          <code class="varname">music_directory</code> contains a
          <em class="parameter"><code>nfs://</code></em> URI according to <a class="ulink" href="http://tools.ietf.org/html/rfc2224" target="_top">RFC2224</a>,
          for example "<em class="parameter"><code>nfs://servername/path</code></em>".
        </p><p>
          This plugin uses <a class="ulink" href="https://github.com/sahlberg/libnfs" target="_top"><code class="filename">libnfs</code></a>,
          which supports only NFS version 3.  Since
          <span class="application">MPD</span> is not allowed to bind to
          "privileged ports", the NFS server needs to enable the
          "insecure" setting; example
          <code class="filename">/etc/exports</code>:
        </p><pre class="programlisting">/srv/mp3 192.168.1.55(ro,insecure)</pre><p>
          Don't fear: "insecure" does not mean that your NFS server is
          insecure.  A few decades ago, people thought the concept of
          "privileged ports" would make network services "secure",
          which was a fallacy.  The absence of this obsolete
          "security" measure means little.
        </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="neighbor_plugins"></a>Neighbor plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="smbclient_neighbor"></a><code class="varname">smbclient</code></h3></div></div></div><p>
          Provides a list of SMB/CIFS servers on the local network.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="upnp_neighbor"></a><code class="varname">upnp</code></h3></div></div></div><p>
          Provides a list of UPnP servers on the local network.
        </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="input_plugins"></a>Input plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm850"></a><code class="varname">alsa</code></h3></div></div></div><p>
          Allows <span class="application">MPD</span> on Linux to play audio
          directly from a soundcard using the scheme
          <code class="filename">alsa://</code>. Audio is formatted as 44.1 kHz
          16-bit stereo (CD format). Examples:
        </p><p>
          <code class="filename">mpc add alsa://</code> plays audio from device hw:0,0
        </p><p>
          <code class="filename">mpc add alsa://hw:1,0</code> plays audio from device
          hw:1,0
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm860"></a><code class="varname">cdio_paranoia</code></h3></div></div></div><p>
          Plays audio CDs.  The URI has the form:
          "<code class="filename">cdda://[DEVICE][/TRACK]</code>".  The
          simplest form <code class="filename">cdda://</code> plays the whole
          disc in the default drive.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">default_byte_order</code>
                <em class="parameter"><code>little_endian|big_endian</code></em>
                </td><td>
                  If the CD drive does not specify a byte order,
                  <span class="application">MPD</span> assumes it is the
                  CPU's native byte order.  This setting allows
                  overriding this.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm879"></a><code class="varname">curl</code></h3></div></div></div><p>
          Opens remote files or streams over HTTP.
        </p><p>
          Note that unless overridden by the below settings (e.g. by
          setting them to a blank value), general curl configuration
          from environment variables such as http_proxy or specified
          in ~/.curlrc will be in effect.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">proxy</code>
                </td><td>
                  Sets the address of the HTTP proxy server.
                </td></tr><tr><td>
                  <code class="varname">proxy_user</code>,
                  <code class="varname">proxy_password</code>
                </td><td>
                  Configures proxy authentication.
                </td></tr><tr><td>
                  <code class="varname">verify_peer</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Verify the peer's SSL certificate?  <a class="ulink" href="http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html" target="_top">More
                  information</a>.
                </td></tr><tr><td>
                  <code class="varname">verify_host</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Verify the certificate's name against host?  <a class="ulink" href="http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html" target="_top">More
                  information</a>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm912"></a><code class="varname">file</code></h3></div></div></div><p>
          Opens local files.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm916"></a><code class="varname">mms</code></h3></div></div></div><p>
          Plays streams with the MMS protocol.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm920"></a><code class="varname">nfs</code></h3></div></div></div><p>
          Allows <span class="application">MPD</span> to access files on
          NFSv3 servers without actually mounting them (i.e. in
          userspace, without help from the kernel's VFS layer).  All
          URIs with the <code class="filename">nfs://</code> scheme are used
          according to <a class="ulink" href="http://tools.ietf.org/html/rfc2224" target="_top">RFC2224</a>.
          Example:
        </p><p>
          <code class="filename">mpc add nfs://servername/path/filename.ogg</code>
        </p><p>
          Note that this usually requires enabling the "insecure" flag
          in the server's <code class="filename">/etc/exports</code> file,
          because <span class="application">MPD</span> cannot bind to
          so-called "privileged" ports.  Don't fear: this will not
          make your file server insecure; the flag was named in a time
          long ago when privileged ports were thought to be meaningful
          for security.  By today's standards, NFSv3 is not secure at
          all, and if you believe it is, you're already doomed.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm932"></a><code class="varname">smbclient</code></h3></div></div></div><p>
          Allows <span class="application">MPD</span> to access files on
          SMB/CIFS servers (e.g. Samba or Microsoft Windows).  All
          URIs with the <code class="filename">smb://</code> scheme are used.
          Example:
        </p><p>
          <code class="filename">mpc add smb://servername/sharename/filename.ogg</code>
        </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="decoder_plugins"></a>Decoder plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="dsdiff_decoder"></a><code class="varname">dsdiff</code></h3></div></div></div><p>
          Decodes DFF files containing DSDIFF data (e.g. SACD rips).
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">lsbitfirst</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Decode the least significant bit first.  Default is
                  <em class="parameter"><code>no</code></em>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="dsf_decoder"></a><code class="varname">dsf</code></h3></div></div></div><p>
          Decodes DSF files containing DSDIFF data (e.g. SACD rips).
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm963"></a><code class="varname">fluidsynth</code></h3></div></div></div><p>
          MIDI decoder based on <a class="ulink" href="http://www.fluidsynth.org/" target="_top"><span class="application">FluidSynth</span></a>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">sample_rate</code>
                </td><td>
                  The sample rate that shall be synthesized by the
                  plugin.  Defaults to 48000.
                </td></tr><tr><td>
                  <code class="varname">soundfont</code>
                </td><td>
                  The absolute path of the soundfont file.  Defaults
                  to
                  <code class="filename">/usr/share/sounds/sf2/FluidR3_GM.sf2</code>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm985"></a><code class="varname">mikmod</code></h3></div></div></div><p>
          Module player based on <a class="ulink" href="http://mikmod.sourceforge.net/" target="_top"><span class="application">MikMod</span></a>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">loop</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Allow backward loops in modules.  Default is
		  <em class="parameter"><code>no</code></em>.
                </td></tr><tr><td>
                  <code class="varname">sample_rate</code>
                </td><td>
                  Sets the sample rate generated by
                  <code class="filename">libmikmod</code>.  Default is 44100.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1009"></a><code class="varname">modplug</code></h3></div></div></div><p>
          Module player based on <span class="application">MODPlug</span>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">loop_count</code>
                </td><td>
                  Number of times to loop the module if it uses backward loops.
                  Default is <em class="parameter"><code>0</code></em> which prevents looping.
                  <em class="parameter"><code>-1</code></em> loops forever.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1027"></a><code class="varname">wildmidi</code></h3></div></div></div><p>
          MIDI decoder based on <a class="ulink" href="http://www.mindwerks.net/projects/wildmidi/" target="_top"><span class="application">libwildmidi</span></a>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">config_file</code>
                </td><td>
                  The absolute path of the timidity config file.  Defaults
                  to
                  <code class="filename">/etc/timidity/timidity.cfg</code>.
                </td></tr></tbody></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="encoder_plugins"></a>Encoder plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1047"></a><code class="varname">flac</code></h3></div></div></div><p>
          Encodes into <a class="ulink" href="https://xiph.org/flac/" target="_top">FLAC</a> (lossless).
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">compression</code>
                </td><td>
                  Sets the <code class="filename">libFLAC</code> compression
                  level.  The levels range from 0 (fastest, least
                  compression) to 8 (slowest, most compression).
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1064"></a><code class="varname">lame</code></h3></div></div></div><p>
          Encodes into MP3 using the <a class="ulink" href="http://lame.sourceforge.net/" target="_top"><span class="application">LAME</span></a>
          library.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">quality</code>
                </td><td>
                  Sets the quality for VBR.  0 is the highest quality,
                  9 is the lowest quality.  Cannot be used with
                  <code class="varname">bitrate</code>.
                </td></tr><tr><td>
                  <code class="varname">bitrate</code>
                </td><td>
                  Sets the bit rate in kilobit per second.  Cannot be
                  used with <code class="varname">quality</code>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1087"></a><code class="varname">null</code></h3></div></div></div><p>
          Does not encode anything, passes the input PCM data as-is.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1091"></a><code class="varname">shine</code></h3></div></div></div><p>
          Encodes into MP3 using the <a class="ulink" href="https://github.com/savonet/shine" target="_top"><span class="application">Shine</span></a>
          library.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">bitrate</code>
                </td><td>
                  Sets the bit rate in kilobit per second.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1108"></a><code class="varname">twolame</code></h3></div></div></div><p>
          Encodes into MP2 using the <a class="ulink" href="http://www.twolame.org/" target="_top"><span class="application">TwoLAME</span></a>
          library.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">quality</code>
                </td><td>
                  Sets the quality for VBR.  0 is the highest quality,
                  9 is the lowest quality.  Cannot be used with
                  <code class="varname">bitrate</code>.
                </td></tr><tr><td>
                  <code class="varname">bitrate</code>
                </td><td>
                  Sets the bit rate in kilobit per second.  Cannot be
                  used with <code class="varname">quality</code>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="vorbis_encoder"></a><code class="varname">vorbis</code></h3></div></div></div><p>
          Encodes into <a class="ulink" href="http://www.vorbis.com/" target="_top">Ogg
          Vorbis</a>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">quality</code>
                </td><td>
                  Sets the quality for VBR.  -1 is the lowest quality,
                  10 is the highest quality.  Cannot be used with
                  <code class="varname">bitrate</code>.
                </td></tr><tr><td>
                  <code class="varname">bitrate</code>
                </td><td>
                  Sets the bit rate in kilobit per second.  Cannot be
                  used with <code class="varname">quality</code>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1153"></a><code class="varname">wave</code></h3></div></div></div><p>
          Encodes into WAV (lossless).
        </p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="output_plugins"></a>Output plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="alsa_output"></a><code class="varname">alsa</code></h3></div></div></div><p>
          The <a class="ulink" href="http://www.alsa-project.org/" target="_top"><span class="application">Advanced
          Linux Sound Architecture</span>
          (<span class="application">ALSA</span>)</a> plugin uses
          <code class="filename">libasound</code>.  It is recommended if you
          are using Linux.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">device</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Sets the device which should be used.  This can be
                  any valid ALSA device name.  The default value is
                  "default", which makes
                  <code class="filename">libasound</code> choose a device.  It
                  is recommended to use a "hw" or "plughw" device,
                  because otherwise, <code class="filename">libasound</code>
                  automatically enables "dmix", which has major
                  disadvantages (fixed sample rate, poor resampler,
                  ...).
                </td></tr><tr><td>
                  <code class="varname">use_mmap</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>yes</code></em>, then
                  <code class="filename">libasound</code> will try to use
                  memory mapped I/O.
                </td></tr><tr><td>
                  <code class="varname">buffer_time</code>
                  <em class="parameter"><code>US</code></em>
                </td><td>
                  Sets the device's buffer time in microseconds.
                  Don't change unless you know what you're doing.
                </td></tr><tr><td>
                  <code class="varname">period_time</code>
                  <em class="parameter"><code>US</code></em>
                </td><td>
                  Sets the device's period time in microseconds.
                  Don't change unless you really know what you're
                  doing.
                </td></tr><tr><td>
                  <code class="varname">auto_resample</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>no</code></em>, then
                  <code class="filename">libasound</code> will not attempt to
                  resample, handing the responsibility over to
                  <span class="application">MPD</span>.  It is recommended
                  to let <span class="application">MPD</span> resample (with
                  <span class="application">libsamplerate</span>), because
                  ALSA is quite poor at doing so.
                </td></tr><tr><td>
                  <code class="varname">auto_channels</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>no</code></em>, then
                  <code class="filename">libasound</code> will not attempt to
                  convert between different channel numbers.
                </td></tr><tr><td>
                  <code class="varname">auto_format</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>no</code></em>, then
                  <code class="filename">libasound</code> will not attempt to
                  convert between different sample formats (16 bit, 24
                  bit, floating point, ...).
                </td></tr><tr><td>
                  <code class="varname">dop</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>yes</code></em>, then DSD over
                  PCM according to the <a class="ulink" href="http://dsd-guide.com/dop-open-standard" target="_top">DoP
                  standard</a> is enabled.  This wraps DSD
                  samples in fake 24 bit PCM, and is understood by
                  some DSD capable products, but may be harmful to
                  other hardware.  Therefore, the default is
                  <em class="parameter"><code>no</code></em> and you can enable the
                  option at your own risk.
                </td></tr></tbody></table></div><p>
          The according hardware mixer plugin understands the
          following settings:
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">mixer_device</code>
                  <em class="parameter"><code>DEVICE</code></em>
                </td><td>
                  <p>
                    Sets the ALSA mixer device name, defaulting to
                    <em class="parameter"><code>default</code></em> which lets ALSA
                    pick a value.
                  </p>
                </td></tr><tr><td>
                  <code class="varname">mixer_control</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  <p>
                    Choose a mixer control, defaulting to
                    <em class="parameter"><code>PCM</code></em>.  Type <span class="command"><strong>amixer
                    scontrols</strong></span> to get a list of available
                    mixer controls.
                  </p>
                </td></tr><tr><td>
                  <code class="varname">mixer_index</code>
                  <em class="parameter"><code>NUMBER</code></em>
                </td><td>
                  Choose a mixer control index.  This is necessary if
                  there is more than one control with the same name.
                  Defaults to <em class="parameter"><code>0</code></em> (the first
                  one).
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1259"></a><code class="varname">ao</code></h3></div></div></div><p>
          The <code class="varname">ao</code> plugin uses the portable <a class="ulink" href="https://www.xiph.org/ao/" target="_top"><code class="filename">libao</code></a>
          library.  Use only if there is no native plugin for your
          operating system.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">driver</code>
                  <em class="parameter"><code>D</code></em>
                </td><td>
                  The <code class="filename">libao</code> driver to use for
                  audio output.  Possible values depend on what libao
                  drivers are available.  See <a class="ulink" href="http://www.xiph.org/ao/doc/drivers.html" target="_top">http://www.xiph.org/ao/doc/drivers.html</a>
                  for information on some commonly used drivers.
                  Typical values for Linux include "oss" and "alsa09".
                  The default is "default", which causes libao to
                  select an appropriate plugin.
                </td></tr><tr><td>
                  <code class="varname">options</code>
                  <em class="parameter"><code>O</code></em>
                </td><td>
                  Options to pass to the selected
                  <code class="filename">libao</code> driver.
                </td></tr><tr><td>
                  <code class="varname">write_size</code>
                  <em class="parameter"><code>O</code></em>
                </td><td>
                  This specifies how many bytes to write to the audio
                  device at once.  This parameter is to work around a
                  bug in older versions of libao on sound cards with
                  very small buffers.  The default is 1024.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1291"></a><code class="varname">fifo</code></h3></div></div></div><p>
          The <code class="varname">fifo</code> plugin writes raw PCM data to a
          FIFO (First In, First Out) file.  The data can be read by
          another program.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">path</code>
                  <em class="parameter"><code>P</code></em>
                </td><td>
                  This specifies the path of the FIFO to write to.
                  Must be an absolute path.  If the path does not
                  exist, it will be created when
                  <span class="application">MPD</span> is started, and
                  removed when <span class="application">MPD</span> is
                  stopped.  The FIFO will be created with the same
                  user and group as <span class="application">MPD</span> is
                  running as.  Default permissions can be modified by
                  using the builtin shell command
                  <code class="filename">umask</code>.  If a FIFO already
                  exists at the specified path it will be reused, and
                  will not be removed when
                  <span class="application">MPD</span> is stopped.  You can
                  use the "mkfifo" command to create this, and then
                  you may modify the permissions to your liking.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1313"></a><code class="varname">jack</code></h3></div></div></div><p>
          The <code class="varname">jack</code> plugin connects to a <a class="ulink" href="http://jackaudio.org/" target="_top"><span class="application">JACK</span></a>
          server.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">client_name</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  The name of the <span class="application">JACK</span>
                  client.  Defaults to "Music Player Daemon".
                </td></tr><tr><td>
                  <code class="varname">server_name</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Optional name of the <span class="application">JACK</span>
                  server.
                </td></tr><tr><td>
                  <code class="varname">autostart</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>yes</code></em>, then
                  <code class="filename">libjack</code> will automatically
                  launch the <span class="application">JACK</span> daemon.
                  Disabled by default.
                </td></tr><tr><td>
                  <code class="varname">source_ports</code>
                  <em class="parameter"><code>A,B</code></em>
                </td><td>
                  The names of the <span class="application">JACK</span>
                  source ports to be created.  By default, the ports
                  "left" and "right" are created.  To use more ports,
                  you have to tweak this option.
                </td></tr><tr><td>
                  <code class="varname">destination_ports</code>
                  <em class="parameter"><code>A,B</code></em>
                </td><td>
                  The names of the <span class="application">JACK</span>
                  destination ports to connect to.
                </td></tr><tr><td>
                  <code class="varname">ringbuffer_size</code>
                  <em class="parameter"><code>NBYTES</code></em>
                </td><td>
                  Sets the size of the ring buffer for each channel.
                  Do not configure this value unless you know what
                  you're doing.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="httpd_output"></a><code class="varname">httpd</code></h3></div></div></div><p>
          The <code class="varname">httpd</code> plugin creates a HTTP server,
          similar to <a class="ulink" href="http://www.shoutcast.com/" target="_top"><span class="application">ShoutCast</span></a>
          / <a class="ulink" href="http://icecast.org/" target="_top"><span class="application">IceCast</span></a>.
          HTTP streaming clients like
          <span class="application">mplayer</span>, <span class="application">VLC</span>,
          and <span class="application">mpv</span> can connect to it.
        </p><p>
          It is highly recommended to configure a fixed
          <code class="varname">format</code>, because a stream cannot switch
          its audio format on-the-fly when the song changes.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">port</code>
                  <em class="parameter"><code>P</code></em>
                </td><td>
                  Binds the HTTP server to the specified port.
                </td></tr><tr><td>
                  <code class="varname">bind_to_address</code>
                  <em class="parameter"><code>ADDR</code></em>
                </td><td>
                  Binds the HTTP server to the specified address (IPv4 or
                  IPv6). Multiple addresses in parallel are not supported.
                </td></tr><tr><td>
                  <code class="varname">encoder</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Chooses an encoder plugin.  A list of encoder
                  plugins can be found in the <a class="link" href="#encoder_plugins" title="Encoder plugins">encoder plugin
                  reference</a>.
                </td></tr><tr><td>
                  <code class="varname">max_clients</code>
                  <em class="parameter"><code>MC</code></em>
                </td><td>
                  Sets a limit, number of concurrent clients. When set
                  to 0 no limit will apply.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1406"></a><code class="varname">null</code></h3></div></div></div><p>
          The <code class="varname">null</code> plugin does nothing.  It
          discards everything sent to it.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">sync</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  If set to <em class="parameter"><code>no</code></em>, then the timer
                  is disabled - the device will accept PCM chunks at
                  arbitrary rate (useful for benchmarking).  The
                  default behaviour is to play in real time.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="oss_output"></a><code class="varname">oss</code></h3></div></div></div><p>
          The "Open Sound System" plugin is supported on most Unix
          platforms.
        </p><p>
          On Linux, <span class="application">OSS</span> has been superseded
          by <span class="application">ALSA</span>.  Use the <a class="link" href="#alsa_output" title="alsa"><span class="application">ALSA</span> output
          plugin</a> instead of this one on Linux.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">device</code>
                  <em class="parameter"><code>PATH</code></em>
                </td><td>
                  Sets the path of the PCM device.  If not specified,
                  then <span class="application">MPD</span> will attempt to
                  open <code class="filename">/dev/sound/dsp</code> and
                  <code class="filename">/dev/dsp</code>.
                </td></tr></tbody></table></div><p>
          The according hardware mixer plugin understands the
          following settings:
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">mixer_device</code>
                  <em class="parameter"><code>DEVICE</code></em>
                </td><td>
                  <p>
                    Sets the OSS mixer device path, defaulting to
                    <code class="filename">/dev/mixer</code>.
                  </p>
                </td></tr><tr><td>
                  <code class="varname">mixer_control</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  <p>
                    Choose a mixer control, defaulting to
                    <em class="parameter"><code>PCM</code></em>.
                  </p>
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1470"></a><code class="varname">openal</code></h3></div></div></div><p>
          The "OpenAL" plugin uses <a class="ulink" href="http://kcat.strangesoft.net/openal.html" target="_top"><code class="filename">libopenal</code></a>.
          It is supported on many platforms.  Use only if there is no
          native plugin for your operating system.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">device</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Sets the device which should be used.  This can be
                  any valid OpenAL device name. If not specified, then
                  <code class="filename">libopenal</code> will choose a default device.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1489"></a><code class="varname">osx</code></h3></div></div></div><p>
          The "Mac OS X" plugin uses Apple's CoreAudio API.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1493"></a><code class="varname">pipe</code></h3></div></div></div><p>
          The <code class="varname">pipe</code> plugin starts a program and
          writes raw PCM data into its standard input.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">command</code>
                  <em class="parameter"><code>CMD</code></em>
                </td><td>
                  This command is invoked with the shell.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="pulse_output"></a><code class="varname">pulse</code></h3></div></div></div><p>
          The <code class="varname">pulse</code> plugin connects to a <a class="ulink" href="http://www.freedesktop.org/wiki/Software/PulseAudio/" target="_top"><span class="application">PulseAudio</span></a>
          server.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">server</code>
                  <em class="parameter"><code>HOSTNAME</code></em>
                </td><td>
                  Sets the host name of the
                  <span class="application">PulseAudio</span> server.  By
                  default, <span class="application">MPD</span> connects to
                  the local <span class="application">PulseAudio</span>
                  server.
                </td></tr><tr><td>
                  <code class="varname">sink</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Specifies the name of the
                  <span class="application">PulseAudio</span> sink
                  <span class="application">MPD</span> should play on.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1539"></a><code class="varname">roar</code></h3></div></div></div><p>
          The <code class="varname">roar</code> plugin connects to a <a class="ulink" href="http://roaraudio.keep-cool.org/" target="_top">RoarAudio</a>
          server.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">server</code>
                  <em class="parameter"><code>HOSTNAME</code></em>
                </td><td>
                  The host name of the RoarAudio server.  If not
                  specified, then <span class="application">MPD</span> will
                  connect to the default locations.
                </td></tr><tr><td>
                  <code class="varname">role</code>
                  <em class="parameter"><code>ROLE</code></em>
                </td><td>
                  The "role" that <span class="application">MPD</span>
                  registers itself as in the RoarAudio server.  The
                  default is "music".
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1564"></a><code class="varname">recorder</code></h3></div></div></div><p>
          The <code class="varname">recorder</code> plugin writes the audio
          played by <span class="application">MPD</span> to a file.  This
          may be useful for recording radio streams.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">path</code>
                  <em class="parameter"><code>P</code></em>
                </td><td>
                  Write to this file.
                </td></tr><tr><td>
                  <code class="varname">encoder</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Chooses an encoder plugin.  A list of encoder
                  plugins can be found in the <a class="link" href="#encoder_plugins" title="Encoder plugins">encoder plugin
                  reference</a>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="shout_output"></a><code class="varname">shout</code></h3></div></div></div><p>
          The <code class="varname">shout</code> plugin connects to a <a class="ulink" href="http://www.shoutcast.com/" target="_top"><span class="application">ShoutCast</span></a>
          or <a class="ulink" href="http://icecast.org/" target="_top"><span class="application">IceCast</span></a>
          server.  It forwards tags to this server.
        </p><p>
          You must set a <code class="varname">format</code>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">host</code>
                  <em class="parameter"><code>HOSTNAME</code></em>
                </td><td>
                  Sets the host name of the <a class="ulink" href="http://www.shoutcast.com/" target="_top"><span class="application">ShoutCast</span></a>
                  / <a class="ulink" href="http://icecast.org/" target="_top"><span class="application">IceCast</span></a>
                  server.
                </td></tr><tr><td>
                  <code class="varname">port</code>
                  <em class="parameter"><code>PORTNUMBER</code></em>
                </td><td>
                  Connect to this port number on the specified host.
                </td></tr><tr><td>
                  <code class="varname">timeout</code>
                  <em class="parameter"><code>SECONDS</code></em>
                </td><td>
                  Set the timeout for the shout connection in seconds.
                  Defaults to 2 seconds.
                </td></tr><tr><td>
                  <code class="varname">protocol</code>
                  <em class="parameter"><code>icecast2|icecast1|shoutcast</code></em>
                </td><td>
                  Specifies the protocol that wil be used to connect
                  to the server.  The default is
                  "<em class="parameter"><code>icecast2</code></em>".

                </td></tr><tr><td>
                  <code class="varname">mount</code>
                  <em class="parameter"><code>URI</code></em>
                </td><td>
                  Mounts the <span class="application">MPD</span> stream in
                  the specified URI.
                </td></tr><tr><td>
                  <code class="varname">user</code>
                  <em class="parameter"><code>USERNAME</code></em>
                </td><td>
                  Sets the user name for submitting the stream to the
                  server.  Default is "source".
                </td></tr><tr><td>
                  <code class="varname">password</code>
                  <em class="parameter"><code>PWD</code></em>
                </td><td>
                  Sets the password for submitting the stream to the
                  server.
                </td></tr><tr><td>
                  <code class="varname">name</code>
                  <em class="parameter"><code>NAME</code></em>
                </td><td>
                  Sets the name of the stream.
                </td></tr><tr><td>
                  <code class="varname">genre</code>
                  <em class="parameter"><code>GENRE</code></em>
                </td><td>
                  Sets the genre of the stream (optional).
                </td></tr><tr><td>
                  <code class="varname">description</code>
                  <em class="parameter"><code>DESCRIPTION</code></em>
                </td><td>
                  Sets a short description of the stream (optional).
                </td></tr><tr><td>
                  <code class="varname">url</code>
                  <em class="parameter"><code>URL</code></em>
                </td><td>
                  Sets a URL associated with the stream (optional).
                </td></tr><tr><td>
                  <code class="varname">public</code>
                  <em class="parameter"><code>yes|no</code></em>
                </td><td>
                  Specifies whether the stream should be "public".
                  Default is <em class="parameter"><code>no</code></em>.
                </td></tr><tr><td>
                  <code class="varname">encoder</code>
                  <em class="parameter"><code>PLUGIN</code></em>
                </td><td>
                  Chooses an encoder plugin.  Default is <a class="link" href="#vorbis_encoder" title="vorbis"><em class="parameter"><code>vorbis</code></em></a>.
                  A list of encoder plugins can be found in the <a class="link" href="#encoder_plugins" title="Encoder plugins">encoder plugin
                  reference</a>.
                </td></tr></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1681"></a><code class="varname">solaris</code></h3></div></div></div><p>
          The "Solaris" plugin runs only on SUN Solaris, and plays via
          <code class="filename">/dev/audio</code>.
        </p><div class="informaltable"><table class="informaltable" border="1"><colgroup><col><col></colgroup><thead><tr><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>
                  <code class="varname">device</code>
                  <em class="parameter"><code>PATH</code></em>
                </td><td>
                  Sets the path of the audio device, defaults to
                  <code class="filename">/dev/audio</code>.
                </td></tr></tbody></table></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="playlist_plugins"></a>Playlist plugins</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1701"></a><code class="varname">embcue</code></h3></div></div></div><p>
          Reads CUE sheets from the "CUESHEET" tag of song files.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1705"></a><code class="varname">m3u</code></h3></div></div></div><p>
          Reads <code class="filename">.m3u</code> playlist files.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1710"></a><code class="varname">extm3u</code></h3></div></div></div><p>
          Reads extended <code class="filename">.m3u</code> playlist files.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1715"></a><code class="varname">pls</code></h3></div></div></div><p>
          Reads <code class="filename">.pls</code> playlist files.
        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm1720"></a><code class="varname">xspf</code></h3></div></div></div><p>
          Reads <a class="ulink" href="http://www.xspf.org/" target="_top">XSPF</a>
          playlist files.
        </p></div></div></div></div></body></html>