man: add pw-dump.1

man/meson.build

@@ -14,6 +14,7 @@ manpages = [
   'pw-cli.1.rst.in',
   'pw-config.1.rst.in',
   'pw-dot.1.rst.in',
+  'pw-dump.1.rst.in',
   'pw-link.1.rst.in',
   'pw-metadata.1.rst.in',
   'pw-mididump.1.rst.in',

man/pw-dump.1.rst.in

@@ -0,0 +1,54 @@
+pw-dump
+#######
+
+-------------------------
+The PipeWire state dumper
+-------------------------
+
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+| **pw-dump** [*options*]
+
+DESCRIPTION
+===========
+
+The *pw-dump* program produces a representation of the current
+PipeWire state as JSON, including the information on nodes, devices,
+modules, ports, and other objects.
+
+OPTIONS
+=======
+
+-h | --help
+  Show help.
+
+-r | --remote=NAME
+  The name of the *remote* instance to dump. If left unspecified,
+  a connection is made to the default PipeWire instance.
+
+-m | --monitor
+  Monitor PipeWire state changes, and output JSON arrays describing changes.
+
+-N | --no-colors
+  Disable color output.
+
+-C | --color=WHEN
+  Whether to enable color support. WHEN is ``never``, ``always``, or ``auto``.
+
+
+AUTHORS
+=======
+
+The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
+
+SEE ALSO
+========
+
+``pipewire(1)``,
+``pw-cli(1)``,
+``pw-top(1)``,
+