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/pw-mon.1.rst.in

49 lines
801 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
.. This file is part of PipeWire.
pw-mon
######
--------------------
The PipeWire monitor
--------------------
:Manual section: 1
:Manual group: General Commands Manual
SYNOPSIS
========
| **pw-mon** [*options*]
DESCRIPTION
===========
Monitor objects on the PipeWire instance.
OPTIONS
=======
-r | --remote=NAME
The name the *remote* instance to monitor. If left unspecified,
a connection is made to the default PipeWire instance.
-h | --help
Show help.
--version
Show version information.
pw-mon: add support for colored output Same CLI as pw-dump, i.e. -N, --no-colors, --color=always etc are supported. This uses a for-loop macro hack to automatically print prefixes and suffixes, the with_prefix() macro resolves into the correct printf statements to insert either just the marker "*" or the ansi sequences for color/reset. Use of the macro is simply: ``` with_prefix(true, stderr) { fprintf(stderr, "this will be prefixed\n"); } ```
2021-10-27 16:20:26 +10:00
-N | --color=WHEN
Whether to use color, one of 'never', 'always', or 'auto'. The
default is 'auto'. **-N** is equivalent to **--color=never**.
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
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
``pipewire(1)``,
Reference in a new issue Copy permalink