command: added documentation for idle subscriptions

a27a0636 · Marc Pavot · Max Kellermann · fa7a2f0c · a27a0636
Commit a27a0636 authored Nov 23, 2008 by Marc Pavot Committed by Max Kellermann Nov 23, 2008
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

protocol.xml doc/protocol.xml +6 -0

No files found.
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -118,6 +118,7 @@
          <term>
            <cmdsynopsis>
              <command>idle</command>
+              <arg choice="opt" rep="repeat"><replaceable>SUBSYSTEMS</replaceable></arg>
            </cmdsynopsis>
          </term>
          <listitem>
@@ -184,6 +185,11 @@
              <command>idle</command> mode and print results
              immediately; might be empty at this time.
            </para>
+            <para>
+              If the optional <varname>SUBSYSTEMS</varname> argument is used,
+              MPD will only send notifications when something changed in
+              one of the specified subsytems.
+            </para>
          </listitem>
        </varlistentry>
        <varlistentry id="command_status">