mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-01 22:58:50 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/dox/programs/index.md

34 lines
1 KiB
Markdown
Raw Normal View History

doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
\page page_programs Programs
Manual pages:
- \subpage page_man_pipewire_1
- \subpage page_man_pipewire_conf_5
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.
2023-12-09 18:34:56 +02:00
- \subpage page_man_pipewire-client_conf_5
doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
- \subpage page_man_pipewire-pulse_1
- \subpage page_man_pipewire-pulse_conf_5
- \subpage page_man_pipewire-pulse-modules_7
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.
2023-12-09 18:34:56 +02:00
- \subpage page_man_pipewire-jack_conf_5
- \subpage page_man_pipewire-devices_7
doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
- \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
doc: add pw-reserve.1
2023-12-08 18:48:43 +02:00
- \subpage page_man_pw-reserve_1
doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
- \subpage page_man_pw-top_1
doc: add pw-v4l2.1 and spa-*.1 Add manpages for the remaining utilities without one.
2023-12-09 15:48:47 +02:00
- \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
doc: make all manpages with Doxygen Use (fixed-up) Doxygen manpage output for all program & module manpages. This also allows formatting the manual pages properly in the HTML docs. The Markdown pages work properly only with Doxygen >= 1.9.7, older versions put them to wrong place in the HTML docs.
2023-11-21 21:31:16 +02:00
- \subpage page_man_libpipewire-modules_7
Reference in a new issue Copy permalink