diff options
| author | Jeffrey Middleton <jeffrey.r.middleton@nasa.gov> | 2009-03-26 09:47:51 -0500 |
|---|---|---|
| committer | Jeffrey Middleton <jefromi@gmail.com> | 2009-03-26 14:57:17 -0500 |
| commit | 7684c446c6f9b699ae4ea30b59cde81ec31efa53 (patch) | |
| tree | 77ab8d16e8c06fc2d9c92f07fcf7b3c8e7d3b4e9 /doc | |
| parent | 272a7d081bb4b6b32ea19df51963538d04a90b8a (diff) | |
doc: updated ranged playlist commands
Clearly specified the format (song1:song2) for range argumentst, and
added the range capability of the playlistinfo command.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/protocol.xml | 16 |
1 files changed, 10 insertions, 6 deletions
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> |