pw-dot - Man Page

The PipeWire dot graph dump

Examples (TL;DR)

Generate a graph to pw.dot file: pw-dot
Read objects from pw-dump JSON file: pw-dot -j|--json path/to/file.json
Specify an [o]utput file, showing all object types: pw-dot --output path/to/file.dot -a|--all
Print .dot graph to stdout, showing all object properties: pw-dot --output - -d|--detail
Generate a graph from a [r]emote instance, showing only linked objects: pw-dot --remote remote_name -s|--smart
Lay the graph from left to right, instead of dot's default top to bottom: pw-dot -L|--lr
Lay the graph using 90-degree angles in edges: pw-dot -9|--90
Display help: pw-dot --help

pw-dot [options]

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.

-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.

1.2.6 PipeWire