mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
man: Add man pages for pw-jack, pw-pulse
Signed-off-by: Simon McVittie <smcv@debian.org>
This commit is contained in:
Simon McVittie
Simon McVittie
parent
d566c8858c
commit
b91a718018
3 changed files with 148 additions and 0 deletions
|
|
@ -19,6 +19,14 @@ manpages = [
|
||||||
[ 'pw-mon', '1' ]
|
[ 'pw-mon', '1' ]
|
||||||
]
|
]
|
||||||
|
|
||||||
|
if get_option('pipewire-jack')
|
||||||
|
manpages += [[ 'pw-jack', '1' ]]
|
||||||
|
endif
|
||||||
|
|
||||||
|
if get_option('pipewire-pulseaudio')
|
||||||
|
manpages += [[ 'pw-pulse', '1' ]]
|
||||||
|
endif
|
||||||
|
|
||||||
foreach m : manpages
|
foreach m : manpages
|
||||||
file = m.get(0) + '.' + m.get(1)
|
file = m.get(0) + '.' + m.get(1)
|
||||||
infile = file + '.xml.in'
|
infile = file + '.xml.in'
|
||||||
|
|
|
||||||
70
man/pw-jack.1.xml.in
Normal file
70
man/pw-jack.1.xml.in
Normal 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 <@PACKAGE_BUGREPORT@>;
|
||||||
|
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>
|
||||||
70
man/pw-pulse.1.xml.in
Normal file
70
man/pw-pulse.1.xml.in
Normal 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-pulse" section="1" desc="Use PipeWire instead of PulseAudio">
|
||||||
|
|
||||||
|
<synopsis>
|
||||||
|
<cmd>pw-pulse [<arg>options</arg>] <arg>COMMAND</arg> [<arg>FILE</arg>]</cmd>
|
||||||
|
</synopsis>
|
||||||
|
|
||||||
|
<description>
|
||||||
|
<p><file>pw-pulse</file> modifies the LD_LIBRARY_PATH environment
|
||||||
|
variable so that applications will load PipeWire's reimplementation
|
||||||
|
of the PulseAudio client libraries instead of PulseAudio's own
|
||||||
|
libraries. This results in PulseAudio clients being redirected to
|
||||||
|
PipeWire.</p>
|
||||||
|
|
||||||
|
<p>If PipeWire's reimplementation of the PulseAudio client libraries
|
||||||
|
has been installed as a system-wide replacement for PulseAudio's
|
||||||
|
own libraries, then the whole system already behaves in that way,
|
||||||
|
in which case <file>pw-pulse</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-pulse gst123 /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 <@PACKAGE_BUGREPORT@>;
|
||||||
|
PipeWire is available from <url href="@PACKAGE_URL@"/></p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section name="See also">
|
||||||
|
<p>
|
||||||
|
<manref name="pipewire" section="1"/>,
|
||||||
|
<manref name="pulseaudio" section="1"/>,
|
||||||
|
<manref name="pw-jack" section="1"/>
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</manpage>
|
||||||
Loading…
Add table
Add a link
Reference in a new issue