man: Add man pages for pw-jack, pw-pulse

Signed-off-by: Simon McVittie <smcv@debian.org>
This commit is contained in:
Simon McVittie 2020-06-08 14:24:49 +01:00 committed by Simon McVittie
parent d566c8858c
commit b91a718018
3 changed files with 148 additions and 0 deletions

70
man/pw-jack.1.xml.in Normal file
View file

@ -0,0 +1,70 @@
<?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-jack" section="1" desc="Use PipeWire instead of JACK">
<synopsis>
<cmd>pw-jack [<arg>options</arg>] <arg>COMMAND</arg> [<arg>FILE</arg>]</cmd>
</synopsis>
<description>
<p><file>pw-jack</file> modifies the LD_LIBRARY_PATH environment
variable so that applications will load PipeWire's reimplementation
of the JACK client libraries instead of JACK's own
libraries. This results in JACK clients being redirected to
PipeWire.</p>
<p>If PipeWire's reimplementation of the JACK client libraries
has been installed as a system-wide replacement for JACK's
own libraries, then the whole system already behaves in that way,
in which case <file>pw-jack</file> has no practical effect.</p>
</description>
<options>
<option>
<p><opt>-h</opt></p>
<optdesc><p>Show help.</p></optdesc>
</option>
<option>
<p><opt>-r</opt> <arg>NAME</arg></p>
<optdesc><p>The name of the remote instance to connect to. If left
unspecified, a connection is made to the default PipeWire
instance.</p></optdesc>
</option>
<option>
<p><opt>-v</opt></p>
<optdesc><p>Verbose operation.</p></optdesc>
</option>
</options>
<section name="Example">
<p><cmd>pw-jack sndfile-jackplay /usr/share/sounds/freedesktop/stereo/bell.oga</cmd></p>
</section>
<section name="Notes">
<p>Using PipeWire for audio is currently considered to be
experimental.</p>
</section>
<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="jackd" section="1"/>,
<manref name="pw-pulse" section="1"/>
</p>
</section>
</manpage>