From 6d71fc637cfbab68be5a5eea6d29c95c5f9c0b0f Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Mon, 20 Nov 2023 00:44:23 +0200 Subject: [PATCH] man: add pipewire-pulse.conf.5 It mainly points to libpipewire-module-protocol-pulse(7) where the documentation actually is. --- man/meson.build | 1 + man/pipewire-pulse.1.rst.in | 1 + man/pipewire-pulse.conf.5.rst.in | 66 ++++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 man/pipewire-pulse.conf.5.rst.in diff --git a/man/meson.build b/man/meson.build index dd94be158..5ea191e66 100644 --- a/man/meson.build +++ b/man/meson.build @@ -28,6 +28,7 @@ manpages = [ 'pipewire.1.rst.in', 'pipewire-pulse.1.rst.in', 'pipewire.conf.5.rst.in', + 'pipewire-pulse.conf.5.rst.in', 'pw-cat.1.rst.in', 'pw-cli.1.rst.in', 'pw-config.1.rst.in', diff --git a/man/pipewire-pulse.1.rst.in b/man/pipewire-pulse.1.rst.in index 2e00e2bc1..43768b06a 100644 --- a/man/pipewire-pulse.1.rst.in +++ b/man/pipewire-pulse.1.rst.in @@ -45,5 +45,6 @@ PipeWire is available from @PACKAGE_URL@ SEE ALSO ======== +``pipewire-pulse.conf(5)``, ``pipewire(1)``, ``pipewire-pulse-modules(7)`` diff --git a/man/pipewire-pulse.conf.5.rst.in b/man/pipewire-pulse.conf.5.rst.in new file mode 100644 index 000000000..73f571268 --- /dev/null +++ b/man/pipewire-pulse.conf.5.rst.in @@ -0,0 +1,66 @@ +pipewire-pulse.conf +################### + +------------------------------------------------- +The PipeWire Pulseaudio server configuration file +------------------------------------------------- + +:Manual section: 5 +:Manual group: File Formats Manual + +.. _synopsis: + +SYNOPSIS +======== + +*$XDG_CONFIG_HOME/pipewire/pipewire-pulse.conf* + +*@PIPEWIRE_CONFIG_DIR@/pipewire-pulse.conf* + +*@PIPEWIRE_CONFDATADIR@/pipewire-pulse.conf* + +*@PIPEWIRE_CONFDATADIR@/pipewire-pulse.conf.d/* + +*@PIPEWIRE_CONFIG_DIR@/pipewire-pulse.conf.d/* + +*$XDG_CONFIG_HOME/pipewire/pipewire-pulse.conf.d/* + +DESCRIPTION +=========== + +Configuration for PipeWire's PulseAudio-compatible daemon. + +The configuration file format is the same as for ``pipewire.conf(5)``. +There are additional sections for configuring ``pipewire-pulse(1)`` +settings. + + +CONFIGURATION FILE SECTIONS +=========================== + +pulse.properties + Dictionary. These properties configure the PipeWire Pulseaudio server properties. + +pulse.cmd + Array of dictionaries. A set of commands to be executed on startup. + +pulse.rules + Array of dictionaries. A set of match rules and actions to apply to clients. + +See ``libpipewire-module-protocol-pulse(7)`` for the detailed description. + +In addition, the general PipeWire daemon configuration sections apply, +see ``pipewire.conf(5)``. + +AUTHORS +======= + +The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@ + +SEE ALSO +======== + +``libpipewire-module-protocol-pulse(7)``, +``pipewire.conf(5)``, +``pipewire-pulse(1)``, +``pipewire-pulse-modules(7)``,