From 2ee4065c11f2885cb354b067559a66558adb5140 Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Sat, 18 Nov 2023 17:51:49 +0200 Subject: [PATCH] man: add pw-dump.1 --- man/meson.build | 1 + man/pw-dump.1.rst.in | 54 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 man/pw-dump.1.rst.in diff --git a/man/meson.build b/man/meson.build index e64b976b0..071802ab1 100644 --- a/man/meson.build +++ b/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', diff --git a/man/pw-dump.1.rst.in b/man/pw-dump.1.rst.in new file mode 100644 index 000000000..5b11ee30b --- /dev/null +++ b/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)``, +