diff options
| author | Philipp Zabel <philipp.zabel@gmail.com> | 2021-07-31 20:00:02 +0200 |
|---|---|---|
| committer | Derek Foreman <derek.foreman@collabora.com> | 2023-09-28 14:02:04 +0000 |
| commit | 0b00090fdc64e314f2c87f9aeac14d1dbccfdb26 (patch) | |
| tree | 2337260d5f413bd7e4201899384a7a4b777bb022 | |
| parent | 6d3fa71d7bac760614b72c3b6e9b37463ad315bf (diff) | |
doc, man: document multi-backend support
Add a paragraph describing multi-backend support to running-weston.rst
and update the --backend parameter documentation in weston.man.
Signed-off-by: Philipp Zabel <philipp.zabel@gmail.com>
| -rw-r--r-- | doc/sphinx/toc/running-weston.rst | 11 | ||||
| -rw-r--r-- | man/weston.man | 11 |
2 files changed, 17 insertions, 5 deletions
diff --git a/doc/sphinx/toc/running-weston.rst b/doc/sphinx/toc/running-weston.rst index 71170257..7b637d92 100644 --- a/doc/sphinx/toc/running-weston.rst +++ b/doc/sphinx/toc/running-weston.rst @@ -42,6 +42,17 @@ by your GPU when suitable drivers are installed. The other uses the rendered. You can select between these with the ``--renderer=gl`` and ``--renderer=pixman`` arguments when starting Weston. +Multi-back-end support +---------------------- + +Some back-ends can be selected via a comma-separated list to run in parallel, +for example ``-B drm,vnc``. The first back-end in the list is the *primary* +back-end. It creates the renderer and creates its outputs first. The following +back-ends are *secondary* backends. They reuse the renderer and create their +outputs afterwards. Currently, all back-ends support being loaded as the primary +back-end. The PipeWire and VNC backends support being loaded as secondary +backends. + Additional set-up steps ----------------------- diff --git a/man/weston.man b/man/weston.man index 20c511a6..7984e767 100644 --- a/man/weston.man +++ b/man/weston.man @@ -110,17 +110,18 @@ and . .SS Weston core options: .TP -\fB\-\^B\fR\fIbackend\fR, \fB\-\-backend\fR=\fIbackend\fR -Load -.I backend -instead of the default backend, see +\fB\-\^B\fR\fIbackend1,backend2\fR, \fB\-\-backend\fR=\fIbackend1,backend2\fR +Load the comma-separated list of backends instead of the default backend, see .IR BACKENDS . -The backend module is searched for in +The backend modules are searched for in .IR "@weston_modules_dir@" . The default backend is .I @weston_native_backend@ unless the environment suggests otherwise, see .IR DISPLAY " and " WAYLAND_DISPLAY . +The first backend is the primary backend, and it provides the renderer. Not all +backends support being loaded as secondary backends, which reuse the primary +backend's renderer. .TP \fB\-\^c\fR\fIconfig.ini\fR, \fB\-\-config\fR=\fIconfig.ini\fR Load |