doc: sync with master branch

Pick relevant doc updates.

doc: fix DoxygenLayout.xml for doxygen 1.10
doc: add reference docs + index for config and env variables
doc: add some more coverage
doc: move config man pages under config/
doc: add sections to index, clarify discussion of properties
doc: disable dot graphs in API docs again
doc: some updates
doc: fix up example dependencies in meson
This commit is contained in:
Pauli Virtanen 2024-02-17 18:56:31 +02:00
parent 876c3f43ab
commit 030768ab8e
20 changed files with 2600 additions and 185 deletions

View file

@ -28,6 +28,24 @@ 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.
@PAR@ pulse-env PULSE_LATENCY_MSEC
Extra buffering latency in milliseconds. This controls buffering
logic in `libpulse` and may be set for PulseAudio client applications
to adjust their buffering. (Setting it on the `pipewire-pulse` server
has no effect.)
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;