From cb331ae436700efcfc81a15e6f98ae89c34392e0 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Tue, 13 Oct 2009 16:19:21 +0200
Subject: playlist_list: pass configuration to playlist plugins

This patch completes the configuration support.
---
 doc/user.xml | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

(limited to 'doc')

diff --git a/doc/user.xml b/doc/user.xml
index 359e17a3..53173e48 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -391,6 +391,68 @@ cd mpd-version</programlisting>
         </tgroup>
       </informaltable>
     </section>
+
+    <section>
+      <title>Configuring playlist plugins</title>
+
+      <para>
+        Playlist plugins are used to load remote playlists.  This is
+        not related to MPD's playlist directory.
+      </para>
+
+      <para>
+        To configure a filter, add a
+        <varname>playlist_plugin</varname> block to
+        <filename>mpd.conf</filename>:
+      </para>
+
+      <programlisting>playlist_plugin {
+    name "m3u"
+    enabled "true"
+}
+      </programlisting>
+
+      <para>
+        The following table lists the
+        <varname>playlist_plugin</varname> options valid for all
+        plugins:
+      </para>
+
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>
+                Name
+              </entry>
+              <entry>
+                Description
+              </entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>
+                <varname>name</varname>
+              </entry>
+              <entry>
+                The name of the plugin.
+              </entry>
+            </row>
+            <row>
+              <entry>
+                <varname>enabled</varname>
+                <parameter>yes|no</parameter>
+              </entry>
+              <entry>
+                Allows you to disable a input plugin without
+                recompiling.  By default, all plugins are enabled.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </section>
   </chapter>
 
   <chapter>
-- 
cgit v1.2.3