summaryrefslogtreecommitdiffstats
path: root/man/pw-dot.1.rst.in
blob: 459953982e2167f4ee4cfc5bdaded435344d004f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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)``,