From 17dc638c18d7897ec851313df1103ded008366b0 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Fri, 25 Oct 2013 19:35:40 +0200
Subject: command: new command "readcomments" lists arbitrary file tags

---
 doc/protocol.xml | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'doc')

diff --git a/doc/protocol.xml b/doc/protocol.xml
index d40d6586d..234db46db 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -1582,6 +1582,32 @@ OK
             </para>
           </listitem>
         </varlistentry>
+        <varlistentry id="command_readcomments">
+          <term>
+            <cmdsynopsis>
+              <command>readcomments</command>
+              <arg><replaceable>URI</replaceable></arg>
+            </cmdsynopsis>
+          </term>
+          <listitem>
+            <para>
+              Read "comments" (i.e. key-value pairs) from the file
+              specified by "URI".  This "URI" can be a path relative
+              to the music directory or a URL in the form
+              "file:///foo/bar.ogg".
+            </para>
+            <para>
+              The response consists of lines in the form "KEY: VALUE".
+              Comments with suspicious characters (e.g. newlines) are
+              ignored silently.
+            </para>
+            <para>
+              The meaning of these depends on the codec, and not all
+              decoder plugins support it.  For example, on Ogg files,
+              this lists the Vorbis comments.
+            </para>
+          </listitem>
+        </varlistentry>
         <varlistentry id="command_search">
           <term>
             <cmdsynopsis>
-- 
cgit v1.2.3