From 7684c446c6f9b699ae4ea30b59cde81ec31efa53 Mon Sep 17 00:00:00 2001
From: Jeffrey Middleton <jeffrey.r.middleton@nasa.gov>
Date: Thu, 26 Mar 2009 09:47:51 -0500
Subject: doc: updated ranged playlist commands

Clearly specified the format (song1:song2) for range argumentst, and
added the range capability of the playlistinfo command.
---
 doc/protocol.xml | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

(limited to 'doc/protocol.xml')

diff --git a/doc/protocol.xml b/doc/protocol.xml
index 238f896b2..409f9ca0e 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -714,14 +714,18 @@ OK
           <term>
             <cmdsynopsis>
               <command>playlistinfo</command>
-              <arg><replaceable>SONGPOS</replaceable></arg>
+              <group>
+                  <arg><replaceable>SONGPOS</replaceable></arg>
+                  <arg><replaceable>START:END</replaceable></arg>
+              </group>
             </cmdsynopsis>
           </term>
           <listitem>
             <para>
-              Displays a list of songs in the playlist.
-              <varname>SONGPOS</varname> is optional and specifies
-              a single song to display info for.
+              Displays a list of all songs in the playlist, or if the optional
+              argument is given, displays information only for the song
+              <varname>SONGPOS</varname> or the range of songs
+              <varname>START:END</varname>
             </para>
           </listitem>
         </varlistentry>
@@ -782,13 +786,13 @@ OK
           <term>
             <cmdsynopsis>
               <command>shuffle</command>
-              <arg><replaceable>SONGRANGE</replaceable></arg>
+              <arg><replaceable>START:END</replaceable></arg>
             </cmdsynopsis>
           </term>
           <listitem>
             <para>
               Shuffles the current playlist.
-              <varname>SONGRANGE</varname> is optional and specifies
+              <varname>START:END</varname> is optional and specifies
               a range of songs.
             </para>
           </listitem>
-- 
cgit v1.2.3