mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-09-19 16:01:45 +00:00
e41187d643
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.
68 lines
1.2 KiB
ReStructuredText
68 lines
1.2 KiB
ReStructuredText
.. This file is part of PipeWire.
|
|
|
|
pw-dot
|
|
######
|
|
|
|
---------------------------
|
|
The PipeWire dot graph dump
|
|
---------------------------
|
|
|
|
:Manual section: 1
|
|
:Manual group: General Commands Manual
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
| **pw-dot** [*options*]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
Create a .dot file of the PipeWire graph.
|
|
|
|
The .dot file can then be visualized with a tool like **dotty**
|
|
or rendered to a PNG file with ``dot -Tpng pw.dot -o pw.png``.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
-r | --remote=NAME
|
|
The name the remote instance to connect to. If left unspecified,
|
|
a connection is made to the default PipeWire instance.
|
|
|
|
-h | --help
|
|
Show help.
|
|
|
|
--version
|
|
Show version information.
|
|
|
|
-a | --all
|
|
Show all object types.
|
|
|
|
-s | --smart
|
|
Show linked objects only.
|
|
|
|
-d | --detail
|
|
Show all object properties.
|
|
|
|
-o FILE | --output=FILE
|
|
Output file name (Default pw.dot). Use - for stdout.
|
|
|
|
-L | --lr
|
|
Lay the graph from left to right, instead of dot's default top to bottom.
|
|
|
|
-9 | --90
|
|
Lay the graph using 90-degree angles in edges.
|
|
|
|
AUTHORS
|
|
=======
|
|
|
|
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
``pipewire(1)``,
|
|
``pw-cli(1)``,
|
|
``pw-mon(1)``,
|