Skip to content

Commit 4a56d3d

Browse files
committed
pipewire: improve documentation
* recommend running pipewire and pipewire-pulse manually in a terminal emulator first and then, when everything works, autostart it
1 parent a5c4136 commit 4a56d3d

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

src/config/media/pipewire.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
To use PipeWire, install the `pipewire` package.
44

55
[pipewire(1)](https://man.voidlinux.org/pipewire.1) should be started as a user.
6-
Use the autostarting mechanism of your desktop environment or
7-
[startx](../graphical-session/xorg.md#startx). The `pipewire` package provides
8-
`pipewire` and `pipewire-pulse` system services, but they are not recommended
9-
for a typical setup.
6+
Run the pipewire command in a terminal emulator in your session.
107

11-
## PulseAudio replacement
8+
```
9+
$ pipewire
10+
```
1211

13-
PipeWire can start a PulseAudio server. While it's possible to modify
14-
[pipewire.conf(5)](https://man.voidlinux.org/pipewire.conf.5) for auto-starting
15-
the PulseAudio server, it's recommended to start it from the same place where
16-
you start PipeWire by executing `pipewire-pulse`. This keeps the PipeWire
17-
configuration file unmodified for smoother future upgrades.
12+
When pipewire works as expected, use the autostarting mechanism of your desktop
13+
environment or [startx](../graphical-session/xorg.md#startx). The `pipewire`
14+
package provides `pipewire` and `pipewire-pulse` system services, but they are
15+
not recommended for a typical setup.
16+
17+
## PulseAudio replacement
1818

1919
Before starting `pipewire-pulse`, make sure that the PulseAudio service is
2020
[disabled](../services/index.md#disabling-services) and that no other PulseAudio
2121
server instance is running.
2222

23+
Start the PulseAudio server by running `pipewire-pulse` in a terminal emulator.
24+
2325
To check if the replacement is working correctly, use
2426
[pactl(1)](https://man.voidlinux.org/pactl.1) (provided by the
2527
`pulseaudio-utils` package):
@@ -32,6 +34,12 @@ Server Name: PulseAudio (on PipeWire 0.3.18)
3234
[...]
3335
```
3436

37+
Once you confirmed that `pipewire-pulse` works as expected, it's recommended to
38+
autostart it from the same place where you start PipeWire. It is possible to
39+
modify [pipewire.conf(5)](https://man.voidlinux.org/pipewire.conf.5) for
40+
auto-starting the PulseAudio server, but it's not recommended keep the PipeWire
41+
configuration file unmodified for smoother future upgrades.
42+
3543
## Bluetooth audio
3644

3745
For bluetooth audio to work, install the `libspa-bluetooth` package.

0 commit comments

Comments
 (0)