pipewire/doc/dox/programs/index.md at fd58eec7f838dbdba53920a15c51900270df1f0b

mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00

Pauli Virtanen fd58eec7f8 doc: add reference docs + index for config and env variables

Add reference documentation for configuration settings & node/device
properties.  We should have boring & exhaustive reference lists of all
the options, and an index where they can be looked up as needed.

The content is mostly stolen from the Wiki.

Add pipewire-client.conf.5, pipewire-jack.conf.5, and pipewire-device.7
that try to explain all available configuration settings for native/ALSA/JACK
clients, and parameters & properties devices.

Expand pipewire.conf.5 and pipewire-pulse.conf.5 with lists of supported
properties. Also explain environment variables.

Doxygen doesn't have an indexing mechanism suitable for configuration
settings, so add a simple one using an input filter and use it here.

Tweak styling a bit.

2024-02-18 15:08:35 +02:00

1 KiB

Raw Blame History

\page page_programs Programs

Manual pages:

\subpage page_man_pipewire_1
\subpage page_man_pipewire_conf_5
\subpage page_man_pipewire-client_conf_5
\subpage page_man_pipewire-pulse_1
\subpage page_man_pipewire-pulse_conf_5
\subpage page_man_pipewire-pulse-modules_7
\subpage page_man_pipewire-jack_conf_5
\subpage page_man_pipewire-devices_7
\subpage page_man_pw-cat_1
\subpage page_man_pw-cli_1
\subpage page_man_pw-config_1
\subpage page_man_pw-dot_1
\subpage page_man_pw-dump_1
\subpage page_man_pw-jack_1
\subpage page_man_pw-link_1
\subpage page_man_pw-loopback_1
\subpage page_man_pw-metadata_1
\subpage page_man_pw-mididump_1
\subpage page_man_pw-mon_1
\subpage page_man_pw-profiler_1
\subpage page_man_pw-reserve_1
\subpage page_man_pw-top_1
\subpage page_man_pw-v4l2_1
\subpage page_man_spa-acp-tool_1
\subpage page_man_spa-inspect_1
\subpage page_man_spa-json-dump_1
\subpage page_man_spa-monitor_1
\subpage page_man_spa-resample_1
\subpage page_man_libpipewire-modules_7

1 KiB Raw Blame History

1 KiB

Raw Blame History