From 63a885026a27f0004f8101bd9345737a90072038 Mon Sep 17 00:00:00 2001 From: Monika Brinkert Date: Thu, 20 Nov 2008 22:16:54 +0100 Subject: [PATCH] doc: rephrase descriptions Correct lots of grammar and spelling errors. Unify some phrases. --- doc/protocol.xml | 120 ++++++++++++++++++++++++----------------------- 1 file changed, 62 insertions(+), 58 deletions(-) diff --git a/doc/protocol.xml b/doc/protocol.xml index 3479cfcc7..48f489991 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -21,12 +21,12 @@ - All data between the client and server is encoded in - 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 + All data between the client and the server is encoded in + UTF-8. (Note: 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 encoded in UTF-8 is simply OK. For more information on UTF=8: @@ -48,7 +48,7 @@ Command lists - 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 list beings with command_list_begin or command_list_ok_begin and ends with @@ -74,12 +74,13 @@ - For manipulating playlists and playing, there are two sets of commands. One - set uses the song id of a song in the playlist, while another set uses the - playlist position of the song. The commands using song id's should be used - instead of the commands that manipulate and control playback based on playlist - position. Using song id's is a safer method when multiple clients are - interacting with MPD. + For manipulating playlists and playing, there are two sets of + commands. One set uses the song id of a song in the playlist, + while another set uses the playlist position of the song. The + commands using song ids should be used instead of the commands + that manipulate and control playback based on playlist + position. Using song ids is a safer method when multiple + clients are interacting with MPD. @@ -95,7 +96,7 @@ - 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). @@ -108,7 +109,7 @@ - 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). @@ -174,12 +175,12 @@ - While a client waits for idle + While a client is waiting for idle results, the server disables timeouts, allowing a client to wait for events as long as mpd runs. The idle command can be canceled by sending the command noidle (no other - commands are allowed). MPD will then leave + commands are allowed). MPD will then leave idle mode and print results immediately; might be empty at this time. @@ -193,7 +194,7 @@ - reports current status of player, and volume level. + Reports the current status of the player and the volume level. @@ -231,21 +232,23 @@ song: - current song stopped on or playing, - playlist song number + playlist song number of the current + song stopped on or playing + songid: - current song stopped on or playing, - playlist songid + playlist songid of the current song + stopped on or playing + time: - elapsed:total (of current + total time elapsed (of current playing/paused song) @@ -292,7 +295,7 @@ - Display statistics. + Displays statistics. @@ -313,7 +316,7 @@ db_playtime: sum of all song - times in db + times in the db @@ -359,8 +362,8 @@ - Set random state to STATE, should - be 0 or 1. + Sets random state to STATE, + STATE should be 0 or 1. @@ -373,7 +376,7 @@ - Set repeat state to STATE, + Sets repeat state to STATE, STATE should be 0 or 1. @@ -387,7 +390,7 @@ - Set volume to VOL, the range of + Sets volume to VOL, the range of volume is 0-100. @@ -401,7 +404,7 @@ - Change volume by amount CHANGE. + Changes volume by amount CHANGE. @@ -427,7 +430,7 @@ - Begin playing playlist at song number + Begins playing the playlist at song number SONGPOS. @@ -441,7 +444,7 @@ - Begin playing playlist at song + Begins playing the playlist at song SONGID. @@ -454,7 +457,7 @@ - Plays next song in playlist. + Plays next song in the playlist. @@ -466,7 +469,7 @@ - Plays previous song in playlist. + Plays previous song in the playlist. @@ -479,11 +482,11 @@ - Toggle pause/resume playing. PAUSE is 0 or 1. + Toggles pause/resumes playing, PAUSE is 0 or 1. - Use of pause command w/o the _pause_ argument is + The use of pause command w/o the PAUSE argument is deprecated. @@ -528,7 +531,7 @@ - Stop playing. + Stops playing. @@ -548,9 +551,9 @@ - Add the file URI to the playlist - (directories add recursively). - URI can also be a single file. + Adds the file URI to the playlist + (directories add recursively). URI + can also be a single file. @@ -571,7 +574,7 @@ URL. POSITION is optional, a negative number means it is relative to the currently playing song in the playlist (if there is one). - example: + For example: addid "foo.mp3" @@ -614,7 +617,8 @@ OK - Delete song SONGID from playlist + Deletes the song SONGID from the + playlist @@ -628,7 +632,7 @@ OK - Move song at FROM to + Moves the song at FROM to TO in the playlist. @@ -643,7 +647,7 @@ OK - Move song with FROM to + Moves the song with FROM to TO (both song ids) in the playlist. If TO is negative, it is relative to the current song in the playlist (if @@ -677,7 +681,7 @@ OK - Displays list of songs in the playlist. + Displays a list of songs in the playlist. SONGID is optional and specifies a single song to display info for. @@ -692,7 +696,7 @@ OK - Displays list of songs in the playlist. + Displays a list of songs in the playlist. SONGPOS is optional and specifies a single song to display info for. @@ -758,7 +762,7 @@ OK - Swap positions of SONG1 and + Swaps the positions of SONG1 and SONG2. @@ -773,8 +777,7 @@ OK - Swap positions of of songs of - SONG1 and + Swaps the positions of SONG1 and SONG2 (both song ids). @@ -811,7 +814,7 @@ OK Prints a list of the playlist directory. - 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 8601 format. To avoid problems due to clock differences between clients and the server, clients should not @@ -864,7 +867,7 @@ OK - finds songs in the db that are exactly + Finds songs in the db that are exactly WHAT. TYPE should be album, artist, or @@ -883,12 +886,12 @@ OK - List all tags of the specified type. - TYPE should be "album" or "artist". + Lists all tags of the specified type. + TYPE should be album or artist. - ARTIST is an optional parameter - when type is album, this specifies to list albums by a + ARTIST is an optional parameter when + type is album, this specifies to list albums by an artist. @@ -931,7 +934,8 @@ OK - List contents of directory URI. + Lists the contents of the directory + URI. When listing the root directory, this currently returns @@ -950,7 +954,7 @@ OK - Searches for any song that contain + Searches for any song that contains WHAT. TYPE can be title, artist, @@ -1017,7 +1021,7 @@ OK - Kill MPD. + Kills MPD.