Skip to content

M
mpd
You need to sign in or sign up before continuing.
Commit 08c7160e authored by Monika Brinkert's avatar Monika Brinkert
Browse files
Options

doc: improved XML decorations

Wrapped keywords in DocBook tags where appropriate.
parent dbcf7372
Hide whitespace changes
Inline Side-by-side
Showing with 108 additions and 118 deletions
doc/protocol.xml
View file @ 08c7160e
...@@ -25,9 +25,11 @@ ...@@ -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 @@ ...@@ -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 @@ ...@@ -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 @@ ...@@ -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 @@ ...@@ -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 @@ ...@@ -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>
</listitem> </para>
</varlistentry> </listitem>
<varlistentry> <listitem>
<term>repeat</term> <para>
<listitem> <varname>repeat</varname>:
<para>0 or 1</para> <returnvalue>0 or 1</returnvalue>
</listitem> </para>
</varlistentry> </listitem>
<varlistentry> <listitem>
<term>playlist</term> <para>
<listitem> <varname>playlist</varname>:
<para> <returnvalue>31-bit unsigned integer, the playlist
31-bit unsigned integer, the playlist version version number</returnvalue>
number </para>
</para> </listitem>
</listitem> <listitem>
</varlistentry> <para>
<varlistentry> <varname>playlistlength</varname>:
<term>playlistlength</term> <returnvalue>integer, the length of the
<listitem> playlist</returnvalue>
<para> </para>
integer, the length of the playlist </listitem>
</para> <listitem>
</listitem> <para>
</varlistentry> <varname>state</varname>:
<varlistentry> <returnvalue>play, stop, or pause</returnvalue>
<term>state</term> </para>
<listitem> </listitem>
<para> <listitem>
"play", "stop", or "pause" <para>
</para> <varname>song</varname>:
</listitem> <returnvalue> current song stopped on or playing,
</varlistentry> playlist song number</returnvalue>
<varlistentry> </para>
<term>song</term> </listitem>
<listitem> <listitem>
<para> <para>
current song stopped on or playing, playlist song <varname>songid</varname>:
number <returnvalue>current song stopped on or playing,
</para> playlist songid</returnvalue>
</listitem> </para>
</varlistentry> </listitem>
<varlistentry> <listitem>
<term>songid</term> <para>
<listitem> <varname>time</varname>:
<para> <returnvalue>elapsed:total (of current
current song stopped on or playing, playlist playing/paused song)</returnvalue>
songid </para>
</para> </listitem>
</listitem> <listitem>
</varlistentry> <para>
<varlistentry> <varname>bitrate</varname>:
<term>time</term> <returnvalue>instantaneous bitrate in
<listitem> kbps</returnvalue>
<para> </para>
elapsed:total (of current playing/paused song) </listitem>
</para> <listitem>
</listitem> <para>
</varlistentry> <varname>xfade</varname>:
<varlistentry> <returnvalue>crossfade in seconds</returnvalue>
<term>bitrate</term> </para>
<listitem> </listitem>
<para> <listitem>
instantaneous bitrate in kbps <para>
</para> <varname>audio</varname>:
</listitem> <returnvalue>sampleRate:bits:channels</returnvalue>
</varlistentry> </para>
<varlistentry> </listitem>
<term>xfade</term> <listitem>
<listitem> <para>
<para> <varname>updatings_db</varname>:
crossfade in seconds <returnvalue>job id</returnvalue>
</para> </para>
</listitem> </listitem>
</varlistentry> <listitem>
<varlistentry> <para>
<term>audio</term> <varname>error</varname>:
<listitem> <returnvalue>if there is an error, returns message
<para> here</returnvalue>
sampleRate:bits:channels </para>
</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> </listitem>
</varlistentry> </itemizedlist>
</variablelist>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="command_stats"> <varlistentry id="command_stats">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment