summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2020-05-03 20:50:38 +0200
committerWim Taymans <wtaymans@redhat.com>2020-05-03 20:50:38 +0200
commit3dc060265018dd7b7eb9440edc41c624fabe2246 (patch)
treeb8912c555b8f72927c08d9bd91adf5181094d63b /man
parent8fe5b586869fd7e5f95205e3da9d114a7d7ad71b (diff)
man: add mididump man page
Diffstat (limited to 'man')
-rw-r--r--man/meson.build1
-rw-r--r--man/pw-mididump.1.xml.in58
2 files changed, 59 insertions, 0 deletions
diff --git a/man/meson.build b/man/meson.build
index ad502712..7a221573 100644
--- a/man/meson.build
+++ b/man/meson.build
@@ -13,6 +13,7 @@ manpages = [
[ 'pw-cat', '1' ],
[ 'pw-cli', '1' ],
[ 'pw-profiler', '1' ],
+ [ 'pw-mididump', '1' ],
[ 'pw-mon', '1' ]
]
diff --git a/man/pw-mididump.1.xml.in b/man/pw-mididump.1.xml.in
new file mode 100644
index 00000000..3f74a3c0
--- /dev/null
+++ b/man/pw-mididump.1.xml.in
@@ -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>