system/weston
system/weston
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/weston synced 2024-07-21 10:44:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc, man: document PipeWire backend

Browse source 
Add documentation for the PipeWire backend.

Co-authored-by: Michael Tretter <m.tretter@pengutronix.de>
Signed-off-by: Philipp Zabel <philipp.zabel@gmail.com>
Signed-off-by: Michael Tretter <m.tretter@pengutronix.de>
This commit is contained in:
Philipp Zabel 2021-07-31 19:53:01 +02:00 committed by Daniel Stone
parent ebc3a22b09
commit fe69b9f52e
3 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/sphinx/toc/running-weston.rst
View file

@ -28,6 +28,7 @@ Available back-ends:
* **x11** -- run as a x11 application, nested in a X11 display server instance * **x11** -- run as a x11 application, nested in a X11 display server instance
* **rdp** -- run as an RDP server without local input or output * **rdp** -- run as an RDP server without local input or output
* **headless** -- run without input or output, useful for test suite * **headless** -- run without input or output, useful for test suite
* **pipewire** -- run without input, output into a PipeWire node
The job of gathering all the surfaces (windows) being displayed on an output and The job of gathering all the surfaces (windows) being displayed on an output and
stitching them together is performed by a *renderer*. By doing so, it is stitching them together is performed by a *renderer*. By doing so, it is

1
man/weston.ini.man
View file

@ -135,6 +135,7 @@ overrides defaults backend. Available backends are:
.BR drm .BR drm
.BR headless .BR headless
.BR rdp .BR rdp
.BR pipewire
.BR vnc .BR vnc
.BR wayland .BR wayland
.BR x11 .BR x11

5
man/weston.man
View file

@ -52,6 +52,11 @@ to the desktop is done by using the RFB protocol. Currently only one
connecting client is supported. See connecting client is supported. See
.BR weston-vnc (7), .BR weston-vnc (7),
if installed. if installed.
.TP
.I pipewire
The PipeWire backend runs in memory without the need of graphical hardware and
creates a PipeWire node for each output. It can be used to capture Weston
outputs for processing with another application.
. .
.\" *************************************************************** .\" ***************************************************************
.SH SHELLS .SH SHELLS