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

doc/protocol.xml: add command hyperlinks

This commit is contained in:
Max Kellermann 2018-07-06 21:25:00 +02:00
parent a22aed7acf
commit d47f37f23a
1 changed files with 40 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
doc/protocol.xml
View File

@ -324,8 +324,9 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<returnvalue>database</returnvalue>: the song database <returnvalue>database</returnvalue>: the song
has been modified after <command>update</command>. database has been modified after <link
linkend="command_update"><command>update</command></link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -408,7 +409,9 @@
not in "idle" mode; no events gets lost while the client not in "idle" mode; no events gets lost while the client
is doing something else with the connection. If an is doing something else with the connection. If an
event had already occurred since the last call, the new event had already occurred since the last call, the new
<command>idle</command> command will return immediately. <link
linkend="command_idle"><command>idle</command></link>
command will return immediately.
</para> </para>
<para> <para>
@ -835,8 +838,9 @@
</para> </para>
<note> <note>
<para> <para>
<command>volume</command> is deprecated, use <command>volume</command> is deprecated, use <link
<command>setvol</command> instead. linkend="command_setvol"><command>setvol</command></link>
instead.
</para> </para>
</note> </note>
</listitem> </listitem>
@ -1121,7 +1125,8 @@ OK
</para> </para>
<note> <note>
<para> <para>
Do not use this, instead use <command>playlistinfo</command>. Do not use this, instead use <link
linkend="command_playlistinfo"><command>playlistinfo</command></link>.
</para> </para>
</note> </note>
</listitem> </listitem>
@ -1743,8 +1748,9 @@ OK
<listitem> <listitem>
<para> <para>
Finds songs in the db that are exactly Finds songs in the db that are exactly
<varname>WHAT</varname> and adds them to current playlist. <varname>WHAT</varname> and adds them to current
Parameters have the same meaning as for <command>find</command>. playlist. Parameters have the same meaning as for <link
linkend="command_find"><command>find</command></link>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1816,9 +1822,11 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Same as <command>listall</command>, except it also Same as <link
returns metadata info in the same format as linkend="command_listall"><command>listall</command></link>,
<command>lsinfo</command>. except it also returns metadata info in the same format
as <link
linkend="command_lsinfo"><command>lsinfo</command></link>
</para> </para>
<para> <para>
Do not use this command. Do not manage a client-side Do not use this command. Do not manage a client-side
@ -1927,9 +1935,10 @@ OK
<listitem> <listitem>
<para> <para>
Searches for any song that contains Searches for any song that contains
<varname>WHAT</varname>. Parameters have the same meaning <varname>WHAT</varname>. Parameters have the same
as for <command>find</command>, except that search is not meaning as for <link
case sensitive. linkend="command_find"><command>find</command></link>,
except that search is not case sensitive.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1948,7 +1957,8 @@ OK
in tag <varname>TYPE</varname> and adds them to current playlist. in tag <varname>TYPE</varname> and adds them to current playlist.
</para> </para>
<para> <para>
Parameters have the same meaning as for <command>find</command>, Parameters have the same meaning as for <link
linkend="command_find"><command>find</command></link>,
except that search is not case sensitive. except that search is not case sensitive.
</para> </para>
</listitem> </listitem>
@ -1973,7 +1983,8 @@ OK
If a playlist by that name doesn't exist it is created. If a playlist by that name doesn't exist it is created.
</para> </para>
<para> <para>
Parameters have the same meaning as for <command>find</command>, Parameters have the same meaning as for <link
linkend="command_find"><command>find</command></link>,
except that search is not case sensitive. except that search is not case sensitive.
</para> </para>
</listitem> </listitem>
@ -1999,7 +2010,9 @@ OK
Prints "updating_db: JOBID" where Prints "updating_db: JOBID" where
<varname>JOBID</varname> is a positive number <varname>JOBID</varname> is a positive number
identifying the update job. You can read the current identifying the update job. You can read the current
job id in the <command>status</command> response. job id in the <link
linkend="command_status"><command>status</command></link>
response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -2012,8 +2025,9 @@ OK
</term> </term>
<listitem> <listitem>
<para> <para>
Same as <command>update</command>, but also rescans Same as <link
unmodified files. linkend="command_update"><command>update</command></link>,
but also rescans unmodified files.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -2579,7 +2593,9 @@ OK
<para> <para>
Set a runtime attribute. These are specific to the Set a runtime attribute. These are specific to the
output plugin, and supported values are usually printed output plugin, and supported values are usually printed
in the <command>outputs</command> response. in the <link
linkend="command_outputs"><command>outputs</command></link>
response.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -2703,9 +2719,10 @@ suffix: mpc</programlisting>
<para> <para>
Each time a client subscribes or unsubscribes, the global idle Each time a client subscribes or unsubscribes, the global idle
event <varname>subscription</varname> is generated. In event <varname>subscription</varname> is generated. In
conjunction with the <command>channels</command> command, this conjunction with the <link
may be used to auto-detect clients providing additional linkend="command_channels"><command>channels</command></link>
services. command, this may be used to auto-detect clients providing
additional services.
</para> </para>
<para> <para>