screen-share: Document that --no-config option should be passed

With commit 'screen-share: Add option to start screen sharing on weston
star' an section option has been added to start screen-sharing by
default on all outputs. This has the side-effect of attempting to start
screen-share on the same (RDP) output performing the screen-share. That
happens due to re-loading the screen-share module once more.

This patch recommends users to use --no-config option or alternatively,
use a different configuration file to avoid that.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
dev
Marius Vlad 3 years ago
parent af18a0c4c9
commit 0a8e3cbc4a
  1. 9
      man/weston.ini.man

@ -620,13 +620,20 @@ sets the path to the xserver to run (string).
.SH "SCREEN-SHARE SECTION" .SH "SCREEN-SHARE SECTION"
.TP 7 .TP 7
.BI "command=" "@weston_bindir@/weston --backend=rdp-backend.so \ .BI "command=" "@weston_bindir@/weston --backend=rdp-backend.so \
--shell=fullscreen-shell.so --no-clients-resize" --shell=fullscreen-shell.so --no-clients-resize --no-config"
sets the command to start a fullscreen-shell server for screen sharing (string). sets the command to start a fullscreen-shell server for screen sharing (string).
.TP 7 .TP 7
.BI "start-on-startup=" "false" .BI "start-on-startup=" "false"
If set to true, start screen sharing of all outputs available on Weston startup. If set to true, start screen sharing of all outputs available on Weston startup.
Set to false by default. Set to false by default.
.\"--------------------------------------------------------------------- .\"---------------------------------------------------------------------
Set to false by default. When using this option make sure you enable --no-config
to avoid re-loading the screen-share module and implictly trigger screen-sharing
for the RDP output already performing the screen share. Alternatively, you could
also supply a different configuration file, by using --config /path/to/config/file,
and make sure that the configuration file doesn't load the screen-share module.
.RE
.RE
.SH "AUTOLAUNCH SECTION" .SH "AUTOLAUNCH SECTION"
.TP 7 .TP 7
.BI "path=" "/usr/bin/echo" .BI "path=" "/usr/bin/echo"

Loading…
Cancel
Save