oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: improved XML decorations

Browse Source 
Wrapped keywords in DocBook tags where appropriate.
This commit is contained in:
Monika Brinkert 2008-11-20 22:14:47 +01:00
parent dbcf73721e
commit 08c7160eee
1 changed files with 108 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

226
doc/protocol.xml
View File

@ -25,9 +25,11 @@
UTF-8. (Note, that in UTF-8 all standard ansi characters, UTF-8. (Note, that in UTF-8 all standard ansi characters,
0-127, are the same as a standard ansi encoding. Also, no 0-127, are the same as a standard ansi encoding. Also, no
ansi character appears in any multi-byte characters. So, you ansi character appears in any multi-byte characters. So, you
can use standard C functions like strlen, and strcpy just fine can use standard C functions like <function>strlen</function>,
with UTF-8 encoded strings. For example: "OK\n" encoded in and <function>strcpy</function> just fine with UTF-8 encoded
UTF-8 is simply "OK\n". For more information on UTF=8: strings. For example: <returnvalue>OK</returnvalue> encoded in
UTF-8 is simply <returnvalue>OK</returnvalue>. For more
information on UTF=8:
http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8) http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8)
</para> </para>
</section> </section>
@ -36,7 +38,8 @@
<title>Responses</title> <title>Responses</title>
<para> <para>
A command returns "OK\n" on completion or "ACK some error\n" on failure. A command returns <returnvalue>OK</returnvalue> on completion
or <returnvalue>ACK some error</returnvalue> on failure.
These denote the end of command execution. These denote the end of command execution.
</para> </para>
</section> </section>
@ -53,11 +56,14 @@
</para> </para>
<para> <para>
It does not execute any commands until the list has ended. The return It does not execute any commands until the list has ended.
value is whatever the return for a list of commands is. On success The return value is whatever the return for a list of commands
for all commands, OK is returned. If a command fails, no more commands is. On success for all commands,
are executed and the appropriate ACK error is returned. If <returnvalue>OK</returnvalue> is returned. If a command
"command_list_ok_begin is used", "list_OK\n" is returned for each fails, no more commands are executed and the appropriate
<returnvalue>ACK</returnvalue> error is returned. If
<command>command_list_begin</command> is used,
<returnvalue>list_OK</returnvalue> is returned for each
successful command executed in the command list. successful command executed in the command list.
</para> </para>
</section> </section>
@ -115,10 +121,11 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Waits until there is a noteworthy change in one or more of Waits until there is a noteworthy change in one or more
MPD's subsystems. As soon as there is one, it lists all of MPD's subsystems. As soon as there is one, it lists
changed systems in a line in the format "changed: SUBSYSTEM", all changed systems in a line in the format
where SUBSYSTEM is one of the following: <returnvalue>changed: SUBSYSTEM</returnvalue>, where
SUBSYSTEM is one of the following:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -161,7 +168,8 @@
<listitem> <listitem>
<para> <para>
<returnvalue>options</returnvalue>: options like <returnvalue>options</returnvalue>: options like
"repeat", "random", "crossfade" <option>repeat</option>, <option>random</option>,
<option>crossfade</option>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -187,111 +195,93 @@
<para> <para>
reports current status of player, and volume level. reports current status of player, and volume level.
</para> </para>
<variablelist> <itemizedlist>
<varlistentry> <listitem>
<term>volume</term> <para>
<listitem> <varname>volume</varname>:
<para>0-100</para> <returnvalue>0-100</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>repeat</varname>:
<returnvalue>0 or 1</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>playlist</varname>:
<returnvalue>31-bit unsigned integer, the playlist
version number</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>playlistlength</varname>:
<returnvalue>integer, the length of the
playlist</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>state</varname>:
<returnvalue>play, stop, or pause</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>song</varname>:
<returnvalue> current song stopped on or playing,
playlist song number</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>songid</varname>:
<returnvalue>current song stopped on or playing,
playlist songid</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>time</varname>:
<returnvalue>elapsed:total (of current
playing/paused song)</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>bitrate</varname>:
<returnvalue>instantaneous bitrate in
kbps</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>xfade</varname>:
<returnvalue>crossfade in seconds</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>audio</varname>:
<returnvalue>sampleRate:bits:channels</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>updatings_db</varname>:
<returnvalue>job id</returnvalue>
</para>
</listitem>
<listitem>
<para>
<varname>error</varname>:
<returnvalue>if there is an error, returns message
here</returnvalue>
</para>
</listitem> </listitem>
</varlistentry> </itemizedlist>
<varlistentry>
<term>repeat</term>
<listitem>
<para>0 or 1</para>
</listitem>
</varlistentry>
<varlistentry>
<term>playlist</term>
<listitem>
<para>
31-bit unsigned integer, the playlist version
number
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>playlistlength</term>
<listitem>
<para>
integer, the length of the playlist
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>state</term>
<listitem>
<para>
"play", "stop", or "pause"
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>song</term>
<listitem>
<para>
current song stopped on or playing, playlist song
number
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>songid</term>
<listitem>
<para>
current song stopped on or playing, playlist
songid
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>time</term>
<listitem>
<para>
elapsed:total (of current playing/paused song)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>bitrate</term>
<listitem>
<para>
instantaneous bitrate in kbps
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>xfade</term>
<listitem>
<para>
crossfade in seconds
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>audio</term>
<listitem>
<para>
sampleRate:bits:channels
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>updatings_db</term>
<listitem>
<para>
job id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>error</term>
<listitem>
<para>
if there is an error, returns message here
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="command_stats"> <varlistentry id="command_stats">