summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorMarius Vlad <marius.vlad@collabora.com>2021-11-12 16:24:21 +0200
committerMarius Vlad <marius.vlad@collabora.com>2022-04-20 19:45:28 +0300
commit0a8e3cbc4ad82ca1c4a92591ea5dcc8a47b47f35 (patch)
treeb996dc91456881d08e73891475788512c196cd7a /man
parentaf18a0c4c9bab4178c04dffb8edd2cc5cba6b47a (diff)
downloadweston-0a8e3cbc4ad82ca1c4a92591ea5dcc8a47b47f35.tar.gz
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>
Diffstat (limited to 'man')
-rw-r--r--man/weston.ini.man9
1 files changed, 8 insertions, 1 deletions
diff --git a/man/weston.ini.man b/man/weston.ini.man
index 98396027..35c70e6f 100644
--- a/man/weston.ini.man
+++ b/man/weston.ini.man
@@ -620,13 +620,20 @@ sets the path to the xserver to run (string).
.SH "SCREEN-SHARE SECTION"
.TP 7
.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).
.TP 7
.BI "start-on-startup=" "false"
If set to true, start screen sharing of all outputs available on Weston startup.
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"
.TP 7
.BI "path=" "/usr/bin/echo"