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

doc: rephrase descriptions 

Correct lots of grammar and spelling errors.  Unify some phrases.
This commit is contained in:
Monika Brinkert 2008-11-20 22:16:54 +01:00
parent 08c7160eee
commit 63a885026a
1 changed files with 62 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
doc/protocol.xml
View File

@ -21,12 +21,12 @@
</cmdsynopsis> </cmdsynopsis>
<para> <para>
All data between the client and server is encoded in All data between the client and the server is encoded in
UTF-8. (Note, that in UTF-8 all standard ansi characters, UTF-8. (Note: In UTF-8 all standard ansi characters, 0-127 are
0-127, are the same as a standard ansi encoding. Also, no the same as a standard ansi encoding. Also, no ansi character
ansi character appears in any multi-byte characters. So, you appears in any multi-byte characters. So, you can use
can use standard C functions like <function>strlen</function>, standard C functions like <function>strlen</function>, and
and <function>strcpy</function> just fine with UTF-8 encoded <function>strcpy</function> just fine with UTF-8 encoded
strings. For example: <returnvalue>OK</returnvalue> encoded in strings. For example: <returnvalue>OK</returnvalue> encoded in
UTF-8 is simply <returnvalue>OK</returnvalue>. For more UTF-8 is simply <returnvalue>OK</returnvalue>. For more
information on UTF=8: information on UTF=8:
@ -48,7 +48,7 @@
<title>Command lists</title> <title>Command lists</title>
<para> <para>
To facilitate faster adding of files, etc, you can pass a list To facilitate faster adding of files etc. you can pass a list
of commands all at once using a command list. The command of commands all at once using a command list. The command
list beings with <command>command_list_begin</command> or list beings with <command>command_list_begin</command> or
<command>command_list_ok_begin</command> and ends with <command>command_list_ok_begin</command> and ends with
@ -74,12 +74,13 @@
<note> <note>
<para> <para>
For manipulating playlists and playing, there are two sets of commands. One For manipulating playlists and playing, there are two sets of
set uses the song id of a song in the playlist, while another set uses the commands. One set uses the song id of a song in the playlist,
playlist position of the song. The commands using song id's should be used while another set uses the playlist position of the song. The
instead of the commands that manipulate and control playback based on playlist commands using song ids should be used instead of the commands
position. Using song id's is a safer method when multiple clients are that manipulate and control playback based on playlist
interacting with MPD. position. Using song ids is a safer method when multiple
clients are interacting with MPD.
</para> </para>
</note> </note>
@ -95,7 +96,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Clear the current error message in status (this is also Clears the current error message in status (this is also
accomplished by any command that starts playback). accomplished by any command that starts playback).
</para> </para>
</listitem> </listitem>
@ -108,7 +109,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Displays the song info of current song (same song that Displays the song info of the current song (same song that
is identified in status). is identified in status).
</para> </para>
</listitem> </listitem>
@ -174,12 +175,12 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
While a client waits for <command>idle</command> While a client is waiting for <command>idle</command>
results, the server disables timeouts, allowing a client results, the server disables timeouts, allowing a client
to wait for events as long as mpd runs. The to wait for events as long as mpd runs. The
<command>idle</command> command can be canceled by <command>idle</command> command can be canceled by
sending the command <command>noidle</command> (no other sending the command <command>noidle</command> (no other
commands are allowed). MPD will then leave commands are allowed). MPD will then leave
<command>idle</command> mode and print results <command>idle</command> mode and print results
immediately; might be empty at this time. immediately; might be empty at this time.
</para> </para>
@ -193,7 +194,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
reports current status of player, and volume level. Reports the current status of the player and the volume level.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -231,21 +232,23 @@
<listitem> <listitem>
<para> <para>
<varname>song</varname>: <varname>song</varname>:
<returnvalue> current song stopped on or playing, <returnvalue> playlist song number of the current
playlist song number</returnvalue> song stopped on or playing
</returnvalue>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<varname>songid</varname>: <varname>songid</varname>:
<returnvalue>current song stopped on or playing, <returnvalue>playlist songid of the current song
playlist songid</returnvalue> stopped on or playing
</returnvalue>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<varname>time</varname>: <varname>time</varname>:
<returnvalue>elapsed:total (of current <returnvalue>total time elapsed (of current
playing/paused song)</returnvalue> playing/paused song)</returnvalue>
</para> </para>
</listitem> </listitem>
@ -292,7 +295,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Display statistics. Displays statistics.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -313,7 +316,7 @@
<listitem> <listitem>
<para> <para>
<varname>db_playtime</varname>: sum of all song <varname>db_playtime</varname>: sum of all song
times in db times in the db
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -359,8 +362,8 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Set random state to <varname>STATE</varname>, should Sets random state to <varname>STATE</varname>,
be 0 or 1. <varname>STATE</varname> should be 0 or 1.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -373,7 +376,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Set repeat state to <varname>STATE</varname>, Sets repeat state to <varname>STATE</varname>,
<varname>STATE</varname> should be 0 or 1. <varname>STATE</varname> should be 0 or 1.
</para> </para>
</listitem> </listitem>
@ -387,7 +390,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Set volume to <varname>VOL</varname>, the range of Sets volume to <varname>VOL</varname>, the range of
volume is 0-100. volume is 0-100.
</para> </para>
</listitem> </listitem>
@ -401,7 +404,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Change volume by amount <varname>CHANGE</varname>. Changes volume by amount <varname>CHANGE</varname>.
</para> </para>
<note> <note>
<para> <para>
@ -427,7 +430,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Begin playing playlist at song number Begins playing the playlist at song number
<varname>SONGPOS</varname>. <varname>SONGPOS</varname>.
</para> </para>
</listitem> </listitem>
@ -441,7 +444,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Begin playing playlist at song Begins playing the playlist at song
<varname>SONGID</varname>. <varname>SONGID</varname>.
</para> </para>
</listitem> </listitem>
@ -454,7 +457,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Plays next song in playlist. Plays next song in the playlist.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -466,7 +469,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Plays previous song in playlist. Plays previous song in the playlist.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -479,11 +482,11 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Toggle pause/resume playing. <varname>PAUSE</varname> is 0 or 1. Toggles pause/resumes playing, <varname>PAUSE</varname> is 0 or 1.
</para> </para>
<note> <note>
<para> <para>
Use of pause command w/o the _pause_ argument is The use of pause command w/o the PAUSE argument is
deprecated. deprecated.
</para> </para>
</note> </note>
@ -528,7 +531,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Stop playing. Stops playing.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -548,9 +551,9 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Add the file <varname>URI</varname> to the playlist Adds the file <varname>URI</varname> to the playlist
(directories add recursively). (directories add recursively). <varname>URI</varname>
<varname>URI</varname> can also be a single file. can also be a single file.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -571,7 +574,7 @@
URL. <varname>POSITION</varname> is optional, a URL. <varname>POSITION</varname> is optional, a
negative number means it is relative to the currently negative number means it is relative to the currently
playing song in the playlist (if there is one). playing song in the playlist (if there is one).
example: For example:
</para> </para>
<screen> <screen>
addid "foo.mp3" addid "foo.mp3"
@ -614,7 +617,8 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Delete song <varname>SONGID</varname> from playlist Deletes the song <varname>SONGID</varname> from the
playlist
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -628,7 +632,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Move song at <varname>FROM</varname> to Moves the song at <varname>FROM</varname> to
<varname>TO</varname> in the playlist. <varname>TO</varname> in the playlist.
</para> </para>
</listitem> </listitem>
@ -643,7 +647,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Move song with <varname>FROM</varname> to Moves the song with <varname>FROM</varname> to
<varname>TO</varname> (both song ids) in the <varname>TO</varname> (both song ids) in the
playlist. If <varname>TO</varname> is negative, it playlist. If <varname>TO</varname> is negative, it
is relative to the current song in the playlist (if is relative to the current song in the playlist (if
@ -677,7 +681,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Displays list of songs in the playlist. Displays a list of songs in the playlist.
<varname>SONGID</varname> is optional and specifies a <varname>SONGID</varname> is optional and specifies a
single song to display info for. single song to display info for.
</para> </para>
@ -692,7 +696,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Displays list of songs in the playlist. Displays a list of songs in the playlist.
<varname>SONGPOS</varname> is optional and specifies <varname>SONGPOS</varname> is optional and specifies
a single song to display info for. a single song to display info for.
</para> </para>
@ -758,7 +762,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Swap positions of <varname>SONG1</varname> and Swaps the positions of <varname>SONG1</varname> and
<varname>SONG2</varname>. <varname>SONG2</varname>.
</para> </para>
</listitem> </listitem>
@ -773,8 +777,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Swap positions of of songs of Swaps the positions of <varname>SONG1</varname> and
<varname>SONG1</varname> and
<varname>SONG2</varname> (both song ids). <varname>SONG2</varname> (both song ids).
</para> </para>
</listitem> </listitem>
@ -811,7 +814,7 @@ OK
Prints a list of the playlist directory. Prints a list of the playlist directory.
</para> </para>
<para> <para>
After each playlist name, the server sends its last After each playlist name the server sends its last
modification time as attribute "Last-Modified" in ISO modification time as attribute "Last-Modified" in ISO
8601 format. To avoid problems due to clock differences 8601 format. To avoid problems due to clock differences
between clients and the server, clients should not between clients and the server, clients should not
@ -864,7 +867,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
finds songs in the db that are exactly Finds songs in the db that are exactly
<varname>WHAT</varname>. <varname>TYPE</varname> should <varname>WHAT</varname>. <varname>TYPE</varname> should
be <parameter>album</parameter>, be <parameter>album</parameter>,
<parameter>artist</parameter>, or <parameter>artist</parameter>, or
@ -883,12 +886,12 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
List all tags of the specified type. Lists all tags of the specified type.
<varname>TYPE</varname> should be "album" or "artist". <varname>TYPE</varname> should be album or artist.
</para> </para>
<para> <para>
<varname>ARTIST</varname> is an optional parameter <varname>ARTIST</varname> is an optional parameter when
when type is album, this specifies to list albums by a type is album, this specifies to list albums by an
artist. artist.
</para> </para>
</listitem> </listitem>
@ -931,7 +934,8 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
List contents of directory <varname>URI</varname>. Lists the contents of the directory
<varname>URI</varname>.
</para> </para>
<para> <para>
When listing the root directory, this currently returns When listing the root directory, this currently returns
@ -950,7 +954,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Searches for any song that contain Searches for any song that contains
<varname>WHAT</varname>. <varname>TYPE</varname> can be <varname>WHAT</varname>. <varname>TYPE</varname> can be
<parameter>title</parameter>, <parameter>title</parameter>,
<parameter>artist</parameter>, <parameter>artist</parameter>,
@ -1017,7 +1021,7 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Kill MPD. Kills MPD.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>