mirrors/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc, man: document multi-backend support

Browse Source 
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>
This commit is contained in:
Philipp Zabel 2021-07-31 20:00:02 +02:00 committed by Derek Foreman
parent 6d3fa71d7b
commit 0b00090fdc
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/sphinx/toc/running-weston.rst
View File

@ -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
-----------------------

11
man/weston.man
View File

@ -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