diff options
| author | Philipp Zabel <philipp.zabel@gmail.com> | 2021-07-31 19:53:01 +0200 |
|---|---|---|
| committer | Daniel Stone <daniels@collabora.com> | 2023-04-18 10:48:50 +0000 |
| commit | fe69b9f52e4b1e8849625e54a3994996d447ffff (patch) | |
| tree | 4161a11c52475ada407c2aa894f58f9e4a444f6a | |
| parent | ebc3a22b09e4440d1714f87e351a8f7326875afe (diff) | |
| download | weston-fe69b9f52e4b1e8849625e54a3994996d447ffff.tar.gz | |
doc, man: document PipeWire backend
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>
| -rw-r--r-- | doc/sphinx/toc/running-weston.rst | 1 | ||||
| -rw-r--r-- | man/weston.ini.man | 1 | ||||
| -rw-r--r-- | man/weston.man | 5 |
3 files changed, 7 insertions, 0 deletions
diff --git a/doc/sphinx/toc/running-weston.rst b/doc/sphinx/toc/running-weston.rst index 9822b2fe..f1e1d59a 100644 --- a/doc/sphinx/toc/running-weston.rst +++ b/doc/sphinx/toc/running-weston.rst @@ -28,6 +28,7 @@ Available back-ends: * **x11** -- run as a x11 application, nested in a X11 display server instance * **rdp** -- run as an RDP server without local input or output * **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 stitching them together is performed by a *renderer*. By doing so, it is diff --git a/man/weston.ini.man b/man/weston.ini.man index 48320857..e0ab5edb 100644 --- a/man/weston.ini.man +++ b/man/weston.ini.man @@ -135,6 +135,7 @@ overrides defaults backend. Available backends are: .BR drm .BR headless .BR rdp +.BR pipewire .BR vnc .BR wayland .BR x11 diff --git a/man/weston.man b/man/weston.man index 3de1c8a9..65257bc9 100644 --- a/man/weston.man +++ b/man/weston.man @@ -52,6 +52,11 @@ to the desktop is done by using the RFB protocol. Currently only one connecting client is supported. See .BR weston-vnc (7), 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 |