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.
1.2 KiB
\page page_man_pipewire-pulse_1 pipewire-pulse
The PipeWire PulseAudio replacement
SYNOPSIS
pipewire-pulse [options]
DESCRIPTION
pipewire-pulse starts a PulseAudio-compatible daemon that integrates with the PipeWire media server, by running a pipewire process through a systemd service. This daemon is a drop-in replacement for the PulseAudio daemon.
OPTIONS
\par -h | --help Show help.
\par -v | --verbose Increase the verbosity by one level. This option may be specified multiple times.
\par --version Show version information.
\par -c | --config=FILE Load the given config file (Default: pipewire-pulse.conf).
ENVIRONMENT VARIABLES
The generic \ref pipewire-env "pipewire(1) environment variables" are supported.
In addition:
@PAR@ pulse-env PULSE_RUNTIME_PATH
@PAR@ pulse-env XDG_RUNTIME_DIR
Directory where to create the native protocol pulseaudio socket.
AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>; PipeWire is available from <$(PACKAGE_URL)>
SEE ALSO
\ref page_man_pipewire-pulse_conf_5 "pipewire-pulse.conf(5)", \ref page_man_pipewire_1 "pipewire(1)", \ref page_man_pipewire-pulse-modules_7 "pipewire-pulse-modules(7)"