man: add mididump man page

This commit is contained in:
Wim Taymans 2020-05-03 20:50:38 +02:00
parent 8fe5b58686
commit 3dc0602650
2 changed files with 59 additions and 0 deletions

View file

@ -13,6 +13,7 @@ manpages = [
[ 'pw-cat', '1' ],
[ 'pw-cli', '1' ],
[ 'pw-profiler', '1' ],
[ 'pw-mididump', '1' ],
[ 'pw-mon', '1' ]
]

58
man/pw-mididump.1.xml.in Normal file
View file

@ -0,0 +1,58 @@
<?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-mididump" section="1" desc="The PipeWire midi dump">
<synopsis>
<cmd>pw-mididump [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
</synopsis>
<description>
<p>Dump midi messages to stdout.</p>
<p>When a midi file is given, the events inside the file are printed.</p>
<p>When no file is given, <cmd>pw-mididump</cmd> creates a PipeWire
midi input stream and will print all midi events received on the port to
stdout.</p>
</description>
<options>
<option>
<p><opt>-r | --remote</opt></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>
<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>
</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-cat" section="1"/>,
</p>
</section>
</manpage>