mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/man/pipewire.1.rst.in

55 lines
902 B
ReStructuredText
Raw Normal View History

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 10:16:48 +03:00
pipewire
########
-------------------------
The PipeWire media server
-------------------------
:Manual section: 1
:Manual group: General Commands Manual
SYNOPSIS
========
| **pipewire** [*options*]
DESCRIPTION
===========
PipeWire is a service that facilitates sharing of multimedia content
between devices and applications.
The **pipewire** daemon reads a config file that is further documented in
``pipewire.conf(5)`` manual page.
OPTIONS
=======
-h | --help
Show help.
daemon: allow for a -v, -vv, -vvv argument to increase verbosity Sometimes that's faster than having to play with PIPEWIRE_DEBUG. Same for pipewire-media-session.
2021-09-24 08:51:28 +10:00
-v | --verbose
Increase the verbosity by one level. This option may be specified multiple
times.
man: fix an indentation issue in pipewire.1
2021-09-24 12:57:56 +10:00
--version
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 10:16:48 +03:00
Show version information.
-c | --config=FILE
Load the given config file (Default: pipewire.conf).
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>;
PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
man: add some more see also manpages
2022-09-26 10:07:32 +02:00
``pw-top(1)``,
``pw-dump(1)``,
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 10:16:48 +03:00
``pw-mon(1)``,
``pw-cat(1)``,
``pw-cli(1)``,
Reference in a new issue Copy permalink