mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-17 07:00:03 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
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.
This commit is contained in:
Pauli Virtanen 2023-12-09 18:34:56 +02:00
parent 715315cbcd
commit fd58eec7f8
14 changed files with 2237 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/dox/programs/pipewire-pulse.1.md
View file

@ -28,6 +28,20 @@ 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)>;