[pulseaudio-discuss] [PATCH] man: unify pactl and pacmd suspend command documentation

[Tanu Kaskinen]

The suspend-sink and suspend-source documentation for pacmd was quite
terse, so I copied the more complete documentation from pactl. I
couldn't resist doing some other minor edits along the way too.

Bug-link: https://bugs.freedesktop.org/show_bug.cgi?id=105907
---
 man/pactl.1.xml.in            | 32 ++++++++++++++++----------------
 man/pulse-cli-syntax.5.xml.in | 15 ++++++++++++---
 2 files changed, 28 insertions(+), 19 deletions(-)

diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in
index 39569b6bb..ee8fd51ea 100644
--- a/man/pactl.1.xml.in
+++ b/man/pactl.1.xml.in
@@ -129,27 +129,27 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
     </option>
 
     <option>
-      <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
+      <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>true|false</arg></p>
       <optdesc><p>Suspend or resume the specified sink (which may be
-      specified either by its symbolic name, or by its numeric index),
-      depending whether 1 (suspend) or 0 (resume) is passed as last
-      argument. Suspending a sink will pause all playback. Depending
-      on the module implementing the sink this might have the effect
-      that the underlying device is closed, making it available for
-      other applications to use. The exact behaviour depends on the
-      module.</p></optdesc>
+        specified either by its name or index), depending whether true
+        (suspend) or false (resume) is passed as last argument. Suspending
+        a sink will pause all playback. Depending on the module implementing
+        the sink this might have the effect that the underlying device is
+        closed, making it available for other applications to use. The exact
+        behaviour depends on the module.
+      </p></optdesc>
     </option>
 
     <option>
-      <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
+      <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>true|false</arg></p>
       <optdesc><p>Suspend or resume the specified source (which may be
-      specified either by its symbolic name, or by its numeric index),
-      depending whether 1 (suspend) or 0 (resume) is passed as last
-      argument. Suspending a source will pause all
-      capturing. Depending on the module implementing the source this
-      might have the effect that the underlying device is closed,
-      making it available for other applications to use. The exact
-      behaviour depends on the module.</p></optdesc>
+        specified either by its name or index), depending whether true
+        (suspend) or false (resume) is passed as last argument. Suspending
+        a source will pause all capturing. Depending on the module implementing
+        the source this might have the effect that the underlying device is
+        closed, making it available for other applications to use. The exact
+        behaviour depends on the module.
+      </p></optdesc>
     </option>
 
     <option>
diff --git a/man/pulse-cli-syntax.5.xml.in b/man/pulse-cli-syntax.5.xml.in
index 0a0fabaf0..42cd73a63 100644
--- a/man/pulse-cli-syntax.5.xml.in
+++ b/man/pulse-cli-syntax.5.xml.in
@@ -163,9 +163,18 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
     </option>
 
     <option>
-      <p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p>
-      <optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
-      (resp. source).</p></optdesc>
+      <p><opt>suspend-sink|suspend-source</opt> <arg>name|index</arg>
+        <arg>true|false</arg>
+      </p>
+      <optdesc><p>Suspend or resume the specified sink or source (which may be
+        specified either by its name or index), depending whether true
+        (suspend) or false (resume) is passed as last argument. Suspending
+        a sink will pause all playback and suspending a source will pause all
+        capturing. Depending on the module implementing the sink or source this
+        might have the effect that the underlying device is closed, making it
+        available for other applications to use. The exact behaviour depends on
+        the module.
+      </p></optdesc>
     </option>
 
     <option>
-- 
2.16.2