mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/dox/programs/pipewire-pulse.1.md

59 lines
1.4 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_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).
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
# ENVIRONMENT VARIABLES
The generic \ref pipewire-env "pipewire(1) environment variables"
are supported.
In addition:
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
@PAR@ pulse-env PULSE_RUNTIME_PATH
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
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
@PAR@ pulse-env XDG_RUNTIME_DIR
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
Directory where to create the native protocol pulseaudio socket.
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
@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.)
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
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
# 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)"
Reference in a new issue Copy permalink