pipewire/man/pw-jack.1.rst.in
Niklāvs Koļesņikovs e41187d643 man: move from xmltoman to rst2man
xmltoman looks dead and uses XML as well as pulls in a long list of
Perl dependencies. This replaces it with rst2man that has almost no
dependencies beyond Python, which is already required for the Meson
build system.

Naturally rst2man uses reStructuredText and the pages were rewritten
via regex and manual editing to be as close to original XML format
as possible. A few fixes and updates were done too. Most notably a
note was added to indicate that production deployments should not be
starting the session manager via pipewire.conf file.

There's three slight formatting issues/differences:
1. rst2man produces simpler footer.
2. "-f | --foo=value" confuses the parser and it fails to correctly
   add argument specific syntax highlighting to assignment value.
3. XML version had inconsistent use of <arg> and <opt> which has
   been partially addressed. But different manual pages still have
   their differences to what and how is highlighted.
2021-09-03 11:41:45 +00:00

68 lines
1.3 KiB
ReStructuredText

.. This file is part of PipeWire.
pw-jack
#######
----------------------------
Use PipeWire instead of JACK
----------------------------
:Manual section: 1
:Manual group: General Commands Manual
SYNOPSIS
========
| **pw-jack** [*options*] *COMMAND* [*FILE*]
DESCRIPTION
===========
**pw-jack** 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.
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 **pw-jack** has no practical effect.
OPTIONS
=======
-h
Show help.
-r NAME
The name of the remote instance to connect to. If left
unspecified, a connection is made to the default PipeWire
instance.
-v
Verbose operation.
EXAMPLES
========
| **pw-jack** sndfile-jackplay /usr/share/sounds/freedesktop/stereo/bell.oga
NOTES
=====
Using PipeWire for audio is currently considered to be
experimental.
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>;
PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
``pipewire(1)``,
``jackd(1)``,