From ab03e3230ed16349bfa999d69fa354eb2d63e7a7 Mon Sep 17 00:00:00 2001
From: Wim Taymans <wtaymans@redhat.com>
Date: Sun, 3 May 2020 21:08:01 +0200
Subject: [PATCH] man: add pw-dot man page

Fix some arguments to parameters
---
 man/meson.build          |  1 +
 man/pipewire.1.xml.in    |  2 +-
 man/pw-cat.1.xml.in      |  2 +-
 man/pw-dot.1.xml.in      | 75 ++++++++++++++++++++++++++++++++++++++++
 man/pw-mididump.1.xml.in |  2 +-
 man/pw-mon.1.xml.in      |  2 +-
 man/pw-profiler.1.xml.in |  4 +--
 7 files changed, 82 insertions(+), 6 deletions(-)
 create mode 100644 man/pw-dot.1.xml.in

diff --git a/man/meson.build b/man/meson.build
index 7a2215735..b8565a8e9 100644
--- a/man/meson.build
+++ b/man/meson.build
@@ -12,6 +12,7 @@ manpages = [
   [ 'pipewire.conf', '5' ],
   [ 'pw-cat', '1' ],
   [ 'pw-cli', '1' ],
+  [ 'pw-dot', '1' ],
   [ 'pw-profiler', '1' ],
   [ 'pw-mididump', '1' ],
   [ 'pw-mon', '1' ]
diff --git a/man/pipewire.1.xml.in b/man/pipewire.1.xml.in
index 7cd835338..262c48e04 100644
--- a/man/pipewire.1.xml.in
+++ b/man/pipewire.1.xml.in
@@ -35,7 +35,7 @@ This file is part of PipeWire.
     </option>
 
     <option>
-      <p><opt>-n | --name</opt></p>
+      <p><opt>-n | --name</opt><arg>=NAME</arg></p>
 
       <optdesc><p>Set the daemon name (Default pipewire-0).</p></optdesc>
     </option>
diff --git a/man/pw-cat.1.xml.in b/man/pw-cat.1.xml.in
index 6662ff19f..56c6b4d7e 100644
--- a/man/pw-cat.1.xml.in
+++ b/man/pw-cat.1.xml.in
@@ -42,7 +42,7 @@ This file is part of PipeWire.
     </option>
 
     <option>
-       <p><opt>-R | --remote</opt></p>
+      <p><opt>-R | --remote</opt><arg>=NAME</arg></p>
        <optdesc><p>The name the remote instance to connect to. If left unspecified,
        a connection is made to the default PipeWire instance.</p></optdesc>
      </option>
diff --git a/man/pw-dot.1.xml.in b/man/pw-dot.1.xml.in
new file mode 100644
index 000000000..2d193ff59
--- /dev/null
+++ b/man/pw-dot.1.xml.in
@@ -0,0 +1,75 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!--
+This file is part of PipeWire.
+-->
+
+<manpage name="pw-dot" section="1" desc="The PipeWire dot graph dump">
+
+  <synopsis>
+    <cmd>pw-dot [<arg>options</arg>]</cmd>
+  </synopsis>
+
+  <description>
+    <p>Create a .dot file of the PipeWire graph.</p>
+
+    <p>The .dot file can then be visualized with a tool like <cmd>dotty</cmd>
+    or rendered to a png file with <cmd>dot -Tpng pw.dot -o pw.png</cmd>.</p>
+  </description>
+
+  <options>
+
+    <option>
+       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
+       <optdesc><p>The name the remote instance to connect to. If left unspecified,
+       a connection is made to the default PipeWire instance.</p></optdesc>
+     </option>
+
+     <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-a | --all</opt></p>
+      <optdesc><p>Show all object types.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-s | --smart</opt></p>
+      <optdesc><p>Show linked objects only.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-d | --detail</opt></p>
+      <optdesc><p>Show all object properties.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-o FILE | --output</opt><arg>=FILE</arg></p>
+      <optdesc><p>Output file name (Default pw.dot).</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PipeWire Developers &lt;@PACKAGE_BUGREPORT@&gt;; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pipewire" section="1"/>,
+      <manref name="pw-cli" section="1"/>,
+      <manref name="pw-mon" section="1"/>,
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pw-mididump.1.xml.in b/man/pw-mididump.1.xml.in
index 3f74a3c0a..486d53cc3 100644
--- a/man/pw-mididump.1.xml.in
+++ b/man/pw-mididump.1.xml.in
@@ -25,7 +25,7 @@ This file is part of PipeWire.
   <options>
 
     <option>
-       <p><opt>-r | --remote</opt></p>
+       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
        <optdesc><p>The name the remote instance to monitor. If left unspecified,
        a connection is made to the default PipeWire instance.</p></optdesc>
      </option>
diff --git a/man/pw-mon.1.xml.in b/man/pw-mon.1.xml.in
index c752c0757..cd724238c 100644
--- a/man/pw-mon.1.xml.in
+++ b/man/pw-mon.1.xml.in
@@ -19,7 +19,7 @@ This file is part of PipeWire.
   <options>
 
     <option>
-       <p><opt>-r | --remote</opt></p>
+       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
        <optdesc><p>The name the remote instance to monitor. If left unspecified,
        a connection is made to the default PipeWire instance.</p></optdesc>
      </option>
diff --git a/man/pw-profiler.1.xml.in b/man/pw-profiler.1.xml.in
index c5291c151..2c6912899 100644
--- a/man/pw-profiler.1.xml.in
+++ b/man/pw-profiler.1.xml.in
@@ -31,7 +31,7 @@ This file is part of PipeWire.
   <options>
 
     <option>
-       <p><opt>-r | --remote</opt></p>
+       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
        <optdesc><p>The name the remote instance to monitor. If left unspecified,
        a connection is made to the default PipeWire instance.</p></optdesc>
      </option>
@@ -49,7 +49,7 @@ This file is part of PipeWire.
     </option>
 
      <option>
-      <p><opt>-o | --output</opt></p>
+      <p><opt>-o | --output</opt><arg>=FILE</arg></p>
 
       <optdesc><p>Profiler output name (default "profiler.log").</p></optdesc>
     </option>