man: add pw-dot man page

Fix some arguments to parameters
This commit is contained in:
Wim Taymans 2020-05-03 21:08:01 +02:00
parent 3dc0602650
commit ab03e3230e
7 changed files with 82 additions and 6 deletions

View file

@ -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' ]

View file

@ -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>

View file

@ -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>

75
man/pw-dot.1.xml.in Normal file
View file

@ -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>

View file

@ -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>

View file

@ -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>

View file

@ -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>