From 63272541eb723e1933be37fd8ab3e0ade0d4504b Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Fri, 10 Oct 2014 23:22:37 +0200 Subject: doc/protocol: add more markup --- doc/protocol.xml | 129 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 71 insertions(+), 58 deletions(-) diff --git a/doc/protocol.xml b/doc/protocol.xml index 2ebb891cd..5e2043d48 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -11,11 +11,11 @@ Protocol overview - The MPD command protocol exchanges line-based text records - between client and server over TCP. Once the client is - connected to the server, they conduct a conversation until the - client closes the connection. The conversation flow is always - initiated by the client. + The MPD command protocol exchanges + line-based text records between client and server over TCP. + Once the client is connected to the server, they conduct a + conversation until the client closes the connection. The + conversation flow is always initiated by the client. @@ -210,14 +210,14 @@ Queuing - Often, users run MPD with "MPD with "random" enabled, but want to be able to insert songs "before" the rest of the playlist. That is commonly called "queuing". - MPD implements this by allowing the client to specify a + MPD implements this by allowing the client to specify a "priority" for each song in the playlist (commands prio and - In "random" mode, MPD maintains an internal randomized - sequence of songs. In this sequence, songs with a higher - priority come first, and all songs with the same priority are - shuffled (by default, all songs are shuffled, because all have - the same priority "0"). When you increase the priority of a - song, it is moved to the front of the sequence according to - its new priority, but always after the current one. A song - that has been played already (it's "before" the current song - in that sequence) will only be scheduled for repeated playback - if its priority has become bigger than the priority of the - current song. Decreasing the priority of a song will moved it - farther to the end of the sequence. Changing the priority of - the current song has no effect on the sequence. + In "random" mode, MPD maintains an + internal randomized sequence of songs. In this sequence, + songs with a higher priority come first, and all songs with + the same priority are shuffled (by default, all songs are + shuffled, because all have the same priority "0"). When you + increase the priority of a song, it is moved to the front of + the sequence according to its new priority, but always after + the current one. A song that has been played already (it's + "before" the current song in that sequence) will only be + scheduled for repeated playback if its priority has become + bigger than the priority of the current song. Decreasing the + priority of a song will moved it farther to the end of the + sequence. Changing the priority of the current song has no + effect on the sequence. @@ -255,12 +256,12 @@ 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. + clients are interacting with MPD.
- Querying MPD's status + Querying <application>MPD</application>'s status @@ -298,12 +299,14 @@ - Introduced with MPD 0.14 + Introduced with + MPD 0.14 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: + 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: @@ -385,14 +388,15 @@ 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 - idle mode and print results - immediately; might be empty at this time. + commands are allowed). MPD + will then leave idle mode and print + results immediately; might be empty at this time. - If the optional SUBSYSTEMS argument is used, - MPD will only send notifications when something changed in - one of the specified subsytems. + If the optional SUBSYSTEMS argument + is used, MPD will only send + notifications when something changed in one of the + specified subsytems. @@ -429,7 +433,7 @@ single: - Introduced with MPD 0.15 + Introduced with MPD 0.15 0 or 1 @@ -504,7 +508,7 @@ elapsed: - Introduced with MPD 0.16 + Introduced with MPD 0.16 Total time elapsed within the current song, but with higher resolution. @@ -745,7 +749,7 @@ album, auto - added in MPD 0.16 + added in MPD 0.16 . @@ -1037,7 +1041,7 @@ OK at START:END to TO in the playlist. - Ranges are supported since MPD 0.15 + Ranges are supported since MPD 0.15 @@ -1230,7 +1234,7 @@ OK - Since MPD + Since MPD 0.19 Specifies the portion of the song that shall be played. START and END are offsets in seconds @@ -1560,7 +1564,7 @@ OK Finds songs in the db that are exactly WHAT. TYPE can - be any tag supported by MPD, or one of the special + be any tag supported by MPD, or one of the special parameters: @@ -1634,7 +1638,8 @@ OK Lists unique tags values of the specified type. - TYPE can be any tag supported by MPD or + TYPE can be any tag supported by + MPD or file. @@ -1667,9 +1672,11 @@ OK Do not use this command. Do not manage a client-side - copy of MPD's database. That is fragile and adds huge - overhead. It will break with large databases. Instead, - query MPD whenever you need something. + copy of MPD's database. That + is fragile and adds huge overhead. It will break with + large databases. Instead, query + MPD whenever you need + something. @@ -1688,9 +1695,11 @@ OK Do not use this command. Do not manage a client-side - copy of MPD's database. That is fragile and adds huge - overhead. It will break with large databases. Instead, - query MPD whenever you need something. + copy of MPD's database. That + is fragile and adds huge overhead. It will break with + large databases. Instead, query + MPD whenever you need + something. @@ -1705,12 +1714,13 @@ OK Lists the contents of the directory URI, including files are not - recognized by MPD. URI can be a path - relative to the music directory or an URI understood by - one of the storage plugins. The response contains at - least one line for each directory entry with the prefix - "file: " or "directory: ", and may be followed by file - attributes such as "Last-Modified" and "size". + recognized by MPD. + URI can be a path relative to the + music directory or an URI understood by one of the + storage plugins. The response contains at least one + line for each directory entry with the prefix "file: " + or "directory: ", and may be followed by file attributes + such as "Last-Modified" and "size". For example, "smb://SERVER" returns a list of all shares @@ -1887,17 +1897,19 @@ OK "Stickers" are pieces of - information attached to existing MPD objects (e.g. song files, + information attached to existing + MPD objects (e.g. song files, directories, albums). Clients can create arbitrary name/value - pairs. MPD itself does not assume any special meaning in - them. + pairs. MPD itself does not assume + any special meaning in them. The goal is to allow clients to share additional (possibly dynamic) information about songs, which is neither stored on the client (not available to other clients), nor stored in the - song files (MPD has no write access). + song files (MPD has no write + access). @@ -2014,7 +2026,8 @@ OK - Closes the connection to MPD. MPD will try to send the + Closes the connection to MPD. + MPD will try to send the remaining output buffer before it actually closes the connection, but that cannot be guaranteed. This command will not generate a response. @@ -2029,7 +2042,7 @@ OK - Kills MPD. + Kills MPD. -- cgit v1.2.3