summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorMarius Vlad <marius.vlad@collabora.com>2022-09-20 17:34:44 +0300
committerPekka Paalanen <pq@iki.fi>2022-09-23 11:01:57 +0000
commit995d080cb9608d0715c1773a9da011f7a5740da3 (patch)
tree6727adf30324fe332f3ac124afe9ca3153389ebd /man
parent1b4def3c480c6b4eadf0e8991c8ca827eb9de5c4 (diff)
downloadweston-995d080cb9608d0715c1773a9da011f7a5740da3.tar.gz
compositor/main: Extract split/retrieve args passed shell client
The supplied path for executing the shell client could contain potential arguments and not only the binary itself. Specifying the platform either by using an argument (-platform wayland) or using an environmental variable (QT_QPA_PLATFORM) with clients written in Qt is for instance an example on why this might be useful to have in. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Diffstat (limited to 'man')
-rw-r--r--man/weston.ini.man12
1 files changed, 10 insertions, 2 deletions
diff --git a/man/weston.ini.man b/man/weston.ini.man
index 179e0882..24f2138b 100644
--- a/man/weston.ini.man
+++ b/man/weston.ini.man
@@ -333,8 +333,12 @@ different shell plugins.
.PP
The entries that can appear in this section are:
.TP 7
-.BI "client=" file
-sets the path for the shell client to run. If not specified
+.BI "client=" "@weston_libexecdir@/@weston_shell_client@"
+specifies the path for the shell client to run.
+It is possible to pass arguments and environment variables to the program,
+for example, 'ENVFOO=bar ENVBAR=baz /path/to/program --arg anotherarg',
+with entries that are space-separated but with no support for quoting.
+If no client was specified then
.I @weston_shell_client@
is launched (string).
.TP 7
@@ -574,6 +578,10 @@ section with the key
.TP 7
.BI "path=" "@weston_libexecdir@/weston-keyboard"
sets the path of the on screen keyboard input method (string).
+It is possible to pass arguments and environment variables to the program,
+for example, 'ENVFOO=bar ENVBAR=baz /path/to/program --arg anotherarg',
+with entries that are space-separated but with no support for quoting.
+
.TP 7
.BI "overlay-keyboard=" false
sets weston-keyboard as overlay panel.