From 08c7160eee7d42802fce11fb2dc36ce825e75408 Mon Sep 17 00:00:00 2001 From: Monika Brinkert Date: Thu, 20 Nov 2008 22:14:47 +0100 Subject: doc: improved XML decorations Wrapped keywords in DocBook tags where appropriate. --- doc/protocol.xml | 226 ++++++++++++++++++++++++++----------------------------- 1 file changed, 108 insertions(+), 118 deletions(-) (limited to 'doc') diff --git a/doc/protocol.xml b/doc/protocol.xml index 0e5c53717..3479cfcc7 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -25,9 +25,11 @@ UTF-8. (Note, that in UTF-8 all standard ansi characters, 0-127, are the same as a standard ansi encoding. Also, no ansi character appears in any multi-byte characters. So, you - can use standard C functions like strlen, and strcpy just fine - with UTF-8 encoded strings. For example: "OK\n" encoded in - UTF-8 is simply "OK\n". For more information on UTF=8: + can use standard C functions like strlen, + and strcpy just fine with UTF-8 encoded + strings. For example: OK encoded in + UTF-8 is simply OK. For more + information on UTF=8: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8) @@ -36,7 +38,8 @@ Responses - A command returns "OK\n" on completion or "ACK some error\n" on failure. + A command returns OK on completion + or ACK some error on failure. These denote the end of command execution. @@ -53,11 +56,14 @@ - It does not execute any commands until the list has ended. The return - value is whatever the return for a list of commands is. On success - for all commands, OK is returned. If a command fails, no more commands - are executed and the appropriate ACK error is returned. If - "command_list_ok_begin is used", "list_OK\n" is returned for each + It does not execute any commands until the list has ended. + The return value is whatever the return for a list of commands + is. On success for all commands, + OK is returned. If a command + fails, no more commands are executed and the appropriate + ACK error is returned. If + command_list_begin is used, + list_OK is returned for each successful command executed in the command list. @@ -115,10 +121,11 @@ - Waits until there is a noteworthy change in one or more of - MPD's subsystems. As soon as there is one, it lists all - changed systems in a line in the format "changed: SUBSYSTEM", - where SUBSYSTEM is one of the following: + Waits until there is a noteworthy change in one or more + of MPD's subsystems. As soon as there is one, it lists + all changed systems in a line in the format + changed: SUBSYSTEM, where + SUBSYSTEM is one of the following: @@ -161,7 +168,8 @@ options: options like - "repeat", "random", "crossfade" + , , + @@ -187,111 +195,93 @@ reports current status of player, and volume level. - - - volume - - 0-100 - - - - repeat - - 0 or 1 - - - - playlist - - - 31-bit unsigned integer, the playlist version - number - - - - - playlistlength - - - integer, the length of the playlist - - - - - state - - - "play", "stop", or "pause" - - - - - song - - - current song stopped on or playing, playlist song - number - - - - - songid - - - current song stopped on or playing, playlist - songid - - - - - time - - - elapsed:total (of current playing/paused song) - - - - - bitrate - - - instantaneous bitrate in kbps - - - - - xfade - - - crossfade in seconds - - - - - audio - - - sampleRate:bits:channels - - - - - updatings_db - - - job id - - - - - error - - - if there is an error, returns message here - + + + + volume: + 0-100 + + + + + repeat: + 0 or 1 + + + + + playlist: + 31-bit unsigned integer, the playlist + version number + + + + + playlistlength: + integer, the length of the + playlist + + + + + state: + play, stop, or pause + + + + + song: + current song stopped on or playing, + playlist song number + + + + + songid: + current song stopped on or playing, + playlist songid + + + + + time: + elapsed:total (of current + playing/paused song) + + + + + bitrate: + instantaneous bitrate in + kbps + + + + + xfade: + crossfade in seconds + + + + + audio: + sampleRate:bits:channels + + + + + updatings_db: + job id + + + + + error: + if there is an error, returns message + here + - - + -- cgit v1.2.3