mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04: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

22
doc/custom.css
View file

@ -25,16 +25,36 @@
.textblock h1 {
font-size: 150%;
border-bottom: 1px solid var(--page-foreground-color);
margin-top: 1.5em;
}
.textblock h2 {
font-size: 100%;
font-size: 120%;
margin-top: 1.5em;
}
.textblock h3, .textblock h4, .textblock h5, .textblock h6 {
font-size: 100%;
font-style: italic;
font-size: medium;
margin-top: 1.5em;
}
.textblock dl.section dd {
margin-left: 2rem;
}
ul.multicol li {
word-break: break-word;
padding-left: 3em;
text-indent: -3em;
}
ul.multicol li a.el {
font-weight: normal;
}
div.contents div.toc li {
word-break: break-word;
padding-left: 2em;
text-indent: -2em;
}