doc/protocol.rst: more markup
This commit is contained in:
parent
e4b9b67e24
commit
e20d215abf
|
@ -8,7 +8,7 @@ General protocol syntax
|
||||||
Protocol overview
|
Protocol overview
|
||||||
=================
|
=================
|
||||||
|
|
||||||
The ``MPD`` command protocol exchanges
|
The :program:`MPD` command protocol exchanges
|
||||||
line-based text records between client and server over TCP.
|
line-based text records between client and server over TCP.
|
||||||
Once the client is connected to the server, they conduct a
|
Once the client is connected to the server, they conduct a
|
||||||
conversation until the client closes the connection. The
|
conversation until the client closes the connection. The
|
||||||
|
@ -231,8 +231,7 @@ arguments for you.
|
||||||
Tags
|
Tags
|
||||||
====
|
====
|
||||||
|
|
||||||
The following tags are supported by
|
The following tags are supported by :program:`MPD`:
|
||||||
``MPD``:
|
|
||||||
|
|
||||||
* **artist**: the artist name. Its meaning is not well-defined; see "*composer*" and "*performer*" for more specific tags.
|
* **artist**: the artist name. Its meaning is not well-defined; see "*composer*" and "*performer*" for more specific tags.
|
||||||
* **artistsort**: same as artist, but for sorting. This usually omits prefixes such as "The".
|
* **artistsort**: same as artist, but for sorting. This usually omits prefixes such as "The".
|
||||||
|
@ -258,7 +257,7 @@ The following tags are supported by
|
||||||
* **musicbrainz_workid**: the work id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
|
* **musicbrainz_workid**: the work id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
|
||||||
|
|
||||||
There can be multiple values for some of these tags. For
|
There can be multiple values for some of these tags. For
|
||||||
example, ``MPD`` may return multiple
|
example, :program:`MPD` may return multiple
|
||||||
lines with a ``performer`` tag. A tag value is
|
lines with a ``performer`` tag. A tag value is
|
||||||
a UTF-8 string.
|
a UTF-8 string.
|
||||||
|
|
||||||
|
@ -301,16 +300,17 @@ Recipes
|
||||||
Queuing
|
Queuing
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Often, users run ``MPD`` with :ref:`random <command_random>` enabled,
|
Often, users run :program:`MPD` with :ref:`random <command_random>`
|
||||||
but want to be able to insert songs "before" the rest of the playlist.
|
enabled, but want to be able to insert songs "before" the rest of the
|
||||||
That is commonly called "queuing".
|
playlist. That is commonly called "queuing".
|
||||||
|
|
||||||
``MPD`` implements this by allowing the client to specify a "priority"
|
:program:`MPD` implements this by allowing the client to specify a
|
||||||
for each song in the playlist (commands :ref:`priod <command_prio>`
|
"priority" for each song in the playlist (commands :ref:`priod
|
||||||
and :ref:`priodid <command_prioid>`). A higher priority means that
|
<command_prio>` and :ref:`priodid <command_prioid>`). A higher
|
||||||
the song is going to be played before the other songs.
|
priority means that the song is going to be played before the other
|
||||||
|
songs.
|
||||||
|
|
||||||
In "random" mode, ``MPD`` maintains an
|
In "random" mode, :program:`MPD` maintains an
|
||||||
internal randomized sequence of songs. In this sequence,
|
internal randomized sequence of songs. In this sequence,
|
||||||
songs with a higher priority come first, and all songs with
|
songs with a higher priority come first, and all songs with
|
||||||
the same priority are shuffled (by default, all songs are
|
the same priority are shuffled (by default, all songs are
|
||||||
|
@ -335,9 +335,9 @@ Command reference
|
||||||
commands using song ids should be used instead of the commands
|
commands using song ids should be used instead of the commands
|
||||||
that manipulate and control playback based on playlist
|
that manipulate and control playback based on playlist
|
||||||
position. Using song ids is a safer method when multiple
|
position. Using song ids is a safer method when multiple
|
||||||
clients are interacting with ``MPD``.
|
clients are interacting with :program:`MPD`.
|
||||||
|
|
||||||
Querying ``MPD``'s status
|
Querying :program:`MPD`'s status
|
||||||
================================
|
================================
|
||||||
|
|
||||||
:command:`clearerror`
|
:command:`clearerror`
|
||||||
|
@ -352,7 +352,7 @@ Querying ``MPD``'s status
|
||||||
|
|
||||||
:command:`idle [SUBSYSTEMS...]` [#since_0_14]_
|
:command:`idle [SUBSYSTEMS...]` [#since_0_14]_
|
||||||
Waits until there is a noteworthy change in one or more
|
Waits until there is a noteworthy change in one or more
|
||||||
of ``MPD``'s subsystems. As soon
|
of :program:`MPD`'s subsystems. As soon
|
||||||
as there is one, it lists all changed systems in a line
|
as there is one, it lists all changed systems in a line
|
||||||
in the format ``changed:
|
in the format ``changed:
|
||||||
SUBSYSTEM``, where SUBSYSTEM is one of the
|
SUBSYSTEM``, where SUBSYSTEM is one of the
|
||||||
|
@ -382,11 +382,11 @@ Querying ``MPD``'s status
|
||||||
to wait for events as long as mpd runs. The
|
to wait for events as long as mpd runs. The
|
||||||
`idle` command can be canceled by
|
`idle` command can be canceled by
|
||||||
sending the command `noidle` (no other
|
sending the command `noidle` (no other
|
||||||
commands are allowed). ``MPD``
|
commands are allowed). :program:`MPD`
|
||||||
will then leave `idle` mode and print
|
will then leave `idle` mode and print
|
||||||
results immediately; might be empty at this time.
|
results immediately; might be empty at this time.
|
||||||
If the optional ``SUBSYSTEMS`` argument
|
If the optional ``SUBSYSTEMS`` argument
|
||||||
is used, ``MPD`` will only send
|
is used, :program:`MPD` will only send
|
||||||
notifications when something changed in one of the
|
notifications when something changed in one of the
|
||||||
specified subsytems.
|
specified subsytems.
|
||||||
|
|
||||||
|
@ -641,7 +641,7 @@ The current playlist
|
||||||
but address the songs with their id.
|
but address the songs with their id.
|
||||||
|
|
||||||
:command:`rangeid {ID} {START:END}` [#since_0_19]_
|
:command:`rangeid {ID} {START:END}` [#since_0_19]_
|
||||||
Since ``MPD``
|
Since :program:`MPD`
|
||||||
0.19 Specifies the portion of the
|
0.19 Specifies the portion of the
|
||||||
song that shall be played. ``START`` and
|
song that shall be played. ``START`` and
|
||||||
``END`` are offsets in seconds
|
``END`` are offsets in seconds
|
||||||
|
@ -821,7 +821,7 @@ The music database
|
||||||
:command:`list {TYPE} {FILTER} [group {GROUPTYPE}]`
|
:command:`list {TYPE} {FILTER} [group {GROUPTYPE}]`
|
||||||
Lists unique tags values of the specified type.
|
Lists unique tags values of the specified type.
|
||||||
``TYPE`` can be any tag supported by
|
``TYPE`` can be any tag supported by
|
||||||
``MPD`` or
|
:program:`MPD` or
|
||||||
*file*.
|
*file*.
|
||||||
|
|
||||||
Additional arguments may specify a :ref:`filter <filter_syntax>`.
|
Additional arguments may specify a :ref:`filter <filter_syntax>`.
|
||||||
|
@ -840,10 +840,10 @@ The music database
|
||||||
``URI``.
|
``URI``.
|
||||||
|
|
||||||
Do not use this command. Do not manage a client-side
|
Do not use this command. Do not manage a client-side
|
||||||
copy of ``MPD``'s database. That
|
copy of :program:`MPD`'s database. That
|
||||||
is fragile and adds huge overhead. It will break with
|
is fragile and adds huge overhead. It will break with
|
||||||
large databases. Instead, query
|
large databases. Instead, query
|
||||||
``MPD`` whenever you need
|
:program:`MPD` whenever you need
|
||||||
something.
|
something.
|
||||||
|
|
||||||
.. _command_listallinfo:
|
.. _command_listallinfo:
|
||||||
|
@ -854,16 +854,16 @@ The music database
|
||||||
as :ref:`lsinfo <command_lsinfo>`
|
as :ref:`lsinfo <command_lsinfo>`
|
||||||
|
|
||||||
Do not use this command. Do not manage a client-side
|
Do not use this command. Do not manage a client-side
|
||||||
copy of ``MPD``'s database. That
|
copy of :program:`MPD`'s database. That
|
||||||
is fragile and adds huge overhead. It will break with
|
is fragile and adds huge overhead. It will break with
|
||||||
large databases. Instead, query
|
large databases. Instead, query
|
||||||
``MPD`` whenever you need
|
:program:`MPD` whenever you need
|
||||||
something.
|
something.
|
||||||
|
|
||||||
:command:`listfiles {URI}`
|
:command:`listfiles {URI}`
|
||||||
Lists the contents of the directory
|
Lists the contents of the directory
|
||||||
``URI``, including files are not
|
``URI``, including files are not
|
||||||
recognized by ``MPD``.
|
recognized by :program:`MPD`.
|
||||||
``URI`` can be a path relative to the
|
``URI`` can be a path relative to the
|
||||||
music directory or an URI understood by one of the
|
music directory or an URI understood by one of the
|
||||||
storage plugins. The response contains at least one
|
storage plugins. The response contains at least one
|
||||||
|
@ -970,7 +970,7 @@ Multiple storages can be "mounted" together, similar to the
|
||||||
`mount` command on many operating
|
`mount` command on many operating
|
||||||
systems, but without cooperation from the kernel. No
|
systems, but without cooperation from the kernel. No
|
||||||
superuser privileges are necessary, beause this mapping exists
|
superuser privileges are necessary, beause this mapping exists
|
||||||
only inside the ``MPD`` process
|
only inside the :program:`MPD` process
|
||||||
|
|
||||||
.. _command_mount:
|
.. _command_mount:
|
||||||
|
|
||||||
|
@ -1013,15 +1013,15 @@ Stickers
|
||||||
|
|
||||||
"Stickers" [#since_0_15]_ are pieces of
|
"Stickers" [#since_0_15]_ are pieces of
|
||||||
information attached to existing
|
information attached to existing
|
||||||
``MPD`` objects (e.g. song files,
|
:program:`MPD` objects (e.g. song files,
|
||||||
directories, albums). Clients can create arbitrary name/value
|
directories, albums). Clients can create arbitrary name/value
|
||||||
pairs. ``MPD`` itself does not assume
|
pairs. :program:`MPD` itself does not assume
|
||||||
any special meaning in them.
|
any special meaning in them.
|
||||||
|
|
||||||
The goal is to allow clients to share additional (possibly
|
The goal is to allow clients to share additional (possibly
|
||||||
dynamic) information about songs, which is neither stored on
|
dynamic) information about songs, which is neither stored on
|
||||||
the client (not available to other clients), nor stored in the
|
the client (not available to other clients), nor stored in the
|
||||||
song files (``MPD`` has no write
|
song files (:program:`MPD` has no write
|
||||||
access).
|
access).
|
||||||
|
|
||||||
Client developers should create a standard for common sticker
|
Client developers should create a standard for common sticker
|
||||||
|
@ -1063,14 +1063,14 @@ Connection settings
|
||||||
===================
|
===================
|
||||||
|
|
||||||
:command:`close`
|
:command:`close`
|
||||||
Closes the connection to ``MPD``.
|
Closes the connection to :program:`MPD`.
|
||||||
``MPD`` will try to send the
|
:program:`MPD` will try to send the
|
||||||
remaining output buffer before it actually closes the
|
remaining output buffer before it actually closes the
|
||||||
connection, but that cannot be guaranteed. This command
|
connection, but that cannot be guaranteed. This command
|
||||||
will not generate a response.
|
will not generate a response.
|
||||||
|
|
||||||
:command:`kill`
|
:command:`kill`
|
||||||
Kills ``MPD``.
|
Kills :program:`MPD`.
|
||||||
|
|
||||||
:command:`password {PASSWORD}`
|
:command:`password {PASSWORD}`
|
||||||
This is used for authentication with the server.
|
This is used for authentication with the server.
|
||||||
|
@ -1104,7 +1104,7 @@ Connection settings
|
||||||
|
|
||||||
:command:`tagtypes clear`
|
:command:`tagtypes clear`
|
||||||
Clear the list of tag types this client is interested
|
Clear the list of tag types this client is interested
|
||||||
in. This means that ``MPD`` will
|
in. This means that :program:`MPD` will
|
||||||
not send any tags to this client.
|
not send any tags to this client.
|
||||||
|
|
||||||
:command:`tagtypes all`
|
:command:`tagtypes all`
|
||||||
|
|
Loading…
Reference in New Issue