mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-15 07:00:05 -05:00
doc: make all manpages with Doxygen
Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
This commit is contained in:
parent
de954655bc
commit
0fbcc87314
49 changed files with 1717 additions and 2012 deletions
43
doc/dox/programs/pw-dump.1.md
Normal file
43
doc/dox/programs/pw-dump.1.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
\page page_man_pw-dump_1 pw-dump
|
||||
|
||||
The PipeWire state dumper
|
||||
|
||||
# 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
|
||||
|
||||
\par -h | \--help
|
||||
Show help.
|
||||
|
||||
\par -r | \--remote=NAME
|
||||
The name of the *remote* instance to dump. If left unspecified, a
|
||||
connection is made to the default PipeWire instance.
|
||||
|
||||
\par -m | \--monitor
|
||||
Monitor PipeWire state changes, and output JSON arrays describing
|
||||
changes.
|
||||
|
||||
\par -N | \--no-colors
|
||||
Disable color output.
|
||||
|
||||
\par -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
|
||||
|
||||
\ref page_man_pipewire_1 "pipewire(1)",
|
||||
\ref page_man_pw-cli_1 "pw-cli(1)",
|
||||
\ref page_man_pw-top_1 "pw-top(1)",
|
||||
Loading…
Add table
Add a link
Reference in a new issue